amoydavid / yii2lockable-query
MySQL InnoDB lock support(select for update) for ActiveRecord
Installs: 2 176
Dependents: 0
Suggesters: 0
Security: 0
Stars: 9
Watchers: 3
Forks: 2
Open Issues: 0
Type:yii-extension
Requires
- php: ~7.0
- yiisoft/yii2: ~2.0
This package is auto-updated.
Last update: 2024-11-06 19:52:41 UTC
README
This package allows you to use pessimistic locking (select for update) when you work with ActiveRecord Query.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist amoydavid/yii2lockable-query "*"
or add
"amoydavid/yii2lockable-query": "*"
to the require section of your composer.json.
Usage
Set schema map for database connection
<?php
return [
'class' => 'yii\db\Connection',
'schemaMap' => [
'mysql' => '\amoydavid\Yii2LockableQuery\mysql\Schema', // set up mysql schema
'mssql' => '\amoydavid\Yii2LockableQuery\mssql\Schema', // set up mssql schema
],
'dsn' => 'mysql:host=localhost;dbname=yii',
'username' => 'root',
'password' => '',
'charset' => 'utf8',
// Schema cache options (for production environment)
//'enableSchemaCache' => true,
//'schemaCacheDuration' => 60,
//'schemaCache' => 'cache',
];
Extend your ActiveRecord class via \amoydavid\Yii2LockableQuery\ActiveRecord
/**
* Class Sample
* @package common\models
*
*/
class Sample extends \amoydavid\Yii2LockableQuery\ActiveRecord { ... }
Use model locks in transaction.
$dbTransaction = $model->getDb()->beginTransaction();
try {
$model = Sample::find()->where(['id'=>1])->forUpdate()->one();
$dbTransaction->commit();
} catch(\Exception $e) {
$dbTransaction->rollBack();
throw $e;
}
Licence
MIT