Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarantool-php/symfony-lock
symfony lock adapter for tarantool database
https://github.com/tarantool-php/symfony-lock
adapter driver lock php symfony tarantool
Last synced: 15 days ago
JSON representation
symfony lock adapter for tarantool database
- Host: GitHub
- URL: https://github.com/tarantool-php/symfony-lock
- Owner: tarantool-php
- Created: 2020-06-23T19:24:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T18:38:35.000Z (about 1 year ago)
- Last Synced: 2024-12-16T05:15:46.147Z (about 2 months ago)
- Topics: adapter, driver, lock, php, symfony, tarantool
- Language: PHP
- Homepage:
- Size: 32.2 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tarantool symfony-lock
[](https://packagist.org/packages/tarantool/symfony-lock)
[](https://github.com/tarantool-php/symfony-lock/releases)
[](https://packagist.org/packages/tarantool/symfony-lock)
[](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/?branch=master)
[](https://scrutinizer-ci.com/g/tarantool-php/symfony-lock/?branch=master)
[](https://t.me/tarantool_php)
# About
The `TarantoolStore` implements symfony `PersistingStoreInterface` using Tarantool Database.
# Installation
The recommended way to install the library is through [Composer](http://getcomposer.org):
```
$ composer require tarantool/symfony-lock
```
# Prepare Tarantool
To start working on locking you need to create schema, the package contains schema manager that can be used for that. For additional documentation on client configuration see [tarantool/client repository](https://github.com/tarantool-php/client#creating-a-client).
```php
use Tarantool\Client\Client;
use Tarantool\SymfonyLock\SchemaManager;
$client = Client::fromDefaults();
$schema = new SchemaManager($client);
// create spaces and indexes
$schema->setup();
// later if you want to cleanup lock space, use
$schema->tearDown();
// in addition you can configure TarantoolStore to create schema on demand
// pay attention, this option is false by default
$store = new TarantoolStore($client, [
'createSchema' => true,
]);
```
# Using Store
For additional examples on lock factory usage follow [symfony/lock docs](https://symfony.com/doc/current/components/lock.html)
```php
use Symfony\Component\Lock\LockFactory;
use Tarantool\Client\Client;
use Tarantool\SymfonyLock\TarantoolStore;
$client = Client::fromDefaults();
$store = new TarantoolStore($client);
$factory = new LockFactory($store);
$lock = $factory->createLock('pdf-invoice-generation');
if ($lock->acquire()) {
// The resource "pdf-invioce-generation" is locked.
// You can compute and generate invoice safely here.
$lock->release();
}
```
# Expiration helper
When key is expired it will be removed on acquiring new lock with same name. If your key names are not unique, you can use php cleaner to cleanup your database. The best way to cleanup data is start a fiber inside tarantool. For more details see [expirationd module documentation](https://github.com/tarantool/expirationd)
```php
use Tarantool\Client\Client;
use Tarantool\SymfonyLock\Cleaner;
$client = Client::fromDefaults();
$cleaner = new Cleaner($client);
// cleanup keys that are expired
$cleaner->process();
// by default cleaner will process upto 100 items
// you can override it via optional configuration
$cleaner = new Cleaner($client, [
'limit' => 10,
]);
```
# Customization
Out of the box all classes are using space named `lock`. If you want - you can override it via options configuration. All available options and default values are listed below:
```php
use Tarantool\Client\Client;
use Tarantool\SymfonyLock\Cleaner;
use Tarantool\SymfonyLock\SchemaManager;
use Tarantool\SymfonyLock\TarantoolStore;
$client = Client::fromDefaults();
$cleaner = new Cleaner($client, [
'space' => 'lock',
'limit' => '100',
]);
$schema = new SchemaManager($client, [
'engine' => 'memtx',
'space' => 'lock',
]);
$store = new TarantoolStore($client, [
'space' => 'lock',
'initialTtl' => 300,
'createSchema' => false,
]);
```