README

Introduction

WARNING! This library is currently under development and may not be stable. Use in your services at your own risk.

PHP application-level database locking mechanisms to implement concurrency control patterns.

Supported drivers:

• Postgres — PostgreSQL Advisory Locks Documentation

Installation

Pull in the package through Composer.

composer require cybercog/php-db-locker

Usage

Postgres

Transaction-level advisory lock

$dbConnection = new PDO($dsn, $username, $password);

$postgresLocker = new \Cog\DbLocker\Locker\PostgresAdvisoryLocker();
$postgresLockId = \Cog\DbLocker\LockId\PostgresLockId::fromKeyValue('user', '4');

$dbConnection->beginTransaction();
$isLockAcquired = $postgresLocker->acquireLock(
    $dbConnection,
    $postgresLockId,
    \Cog\DbLocker\Locker\PostgresAdvisoryLockScopeEnum::Transaction,
    \Cog\DbLocker\Locker\PostgresAdvisoryLockTypeEnum::NonBlocking,
    \Cog\DbLocker\Locker\PostgresLockModeEnum::Exclusive,
);
if ($isLockAcquired) {
    // Execute logic if lock was successful
} else {
    // Execute logic if lock acquisition has been failed
}
$dbConnection->commit();

Session-level advisory lock

$dbConnection = new PDO($dsn, $username, $password);

$postgresLocker = new \Cog\DbLocker\Locker\PostgresAdvisoryLocker();
$postgresLockId = \Cog\DbLocker\LockId\PostgresLockId::fromKeyValue('user', '4');

$isLockAcquired = $postgresLocker->acquireLock(
    $dbConnection,
    $postgresLockId,
    \Cog\DbLocker\Locker\PostgresAdvisoryLockScopeEnum::Session,
    \Cog\DbLocker\Locker\PostgresAdvisoryLockTypeEnum::NonBlocking,
    \Cog\DbLocker\Locker\PostgresLockModeEnum::Exclusive,
);
if ($isLockAcquired) {
    // Execute logic if lock was successful
} else {
    // Execute logic if lock acquisition has been failed
}
$postgresLocker->releaseLock($dbConnection, $postgresLockId);

Changelog

Detailed changes for each release are documented in the CHANGELOG.md.

License

• PHP DB Locker package is open-sourced software licensed under the MIT license by Anton Komarev.

🌟 Stargazers over time

About CyberCog

CyberCog is a Social Unity of enthusiasts. Research the best solutions in product & software development is our passion.

• Follow us on Twitter