Skip to content
MySQL InnoDB pessimistic lock support(select for update) for Yii2 ActiveRecord
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
LICENSE.md
README.md
composer.json

README.md

Yii2 Lockable ActiveQuery

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
    ],
    '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

Links

You can’t perform that action at this time.