Database Class Reference

Inheritance diagram for Database:

Public Member Functions
	__construct (ResourceConnection $resource, DeploymentConfig $deploymentConfig, string $prefix=null)
	lock (string $name, int $timeout=-1)
	unlock (string $name)
	isLocked (string $name)

Detailed Description

LockManager using the DB locks

Definition at line 20 of file Database.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resource,
		DeploymentConfig	$deploymentConfig,
		string	$prefix = null
	)

Parameters

ResourceConnection	$resource
DeploymentConfig	$deploymentConfig
string | null	$prefix

Definition at line 47 of file Database.php.

      {
        $this->resource = $resource;
        $this->deploymentConfig = $deploymentConfig;
        $this->prefix = $prefix;
    }

Member Function Documentation

isLocked()

isLocked

(

string

$name

)

Tests of lock is set for name

Parameters

string

$name

lock name

Returns

bool

Exceptions

InputException

Implements LockManagerInterface.

Definition at line 126 of file Database.php.

                                          : bool
    {
        $name = $this->addPrefix($name);

        return (bool)$this->resource->getConnection()->query(
            "SELECT IS_USED_LOCK(?);",
            [(string)$name]
        )->fetchColumn();
    }

lock()

lock	(	string	$name,
		int	$timeout = -1
	)

Sets a lock for name

Parameters

string	$name	lock name
int	$timeout	How long to wait lock acquisition in seconds, negative value means infinite timeout

Returns

bool

Exceptions

InputException
AlreadyExistsException

Before MySQL 5.7.5, only a single simultaneous lock per connection can be acquired. This limitation can be removed once MySQL minimum requirement has been raised, currently we support MySQL 5.6 way only.

Implements LockManagerInterface.

Definition at line 66 of file Database.php.

                                                         : bool
    {
        $name = $this->addPrefix($name);

        if ($this->currentLock) {
            throw new AlreadyExistsException(
                new Phrase(
                    'Current connection is already holding lock for $1, only single lock allowed',
                    [$this->currentLock]
                )
            );
        }

        $result = (bool)$this->resource->getConnection()->query(
            "SELECT GET_LOCK(?, ?);",
            [(string)$name, (int)$timeout]
        )->fetchColumn();

        if ($result === true) {
            $this->currentLock = $name;
        }

        return $result;
    }

unlock()

unlock

(

string

$name

)

Releases a lock for name

Parameters

string

$name

lock name

Returns

bool

Exceptions

InputException

Implements LockManagerInterface.

Definition at line 103 of file Database.php.

                                        : bool
    {
        $name = $this->addPrefix($name);

        $result = (bool)$this->resource->getConnection()->query(
            "SELECT RELEASE_LOCK(?);",
            [(string)$name]
        )->fetchColumn();

        if ($result === true) {
            $this->currentLock = false;
        }

        return $result;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Lock/Backend/Database.php