mysqlcommonconnection.php

См. документацию.

<?php
 
namespace Bitrix\Main\DB;
 
use Bitrix\Main\Application;
use Bitrix\Main\ArgumentException;
use Bitrix\Main\ORM\Fields\ScalarField;
 
abstract class MysqlCommonConnection extends Connection
{
    protected $engine = "";
    protected int $transactionLevel = 0;

    public function __construct(array $configuration)
    {
        parent::__construct($configuration);
        $this->engine = $configuration['engine'] ?? '';
    }

    public function isTableExists($tableName)
    {
        $tableName = preg_replace("/[^a-z0-9%_]+/i", "", $tableName);
        $tableName = trim($tableName);
 
        if ($tableName == '')
        {
            return false;
        }
 
        $result = $this->query("SHOW TABLES LIKE '" . $this->getSqlHelper()->forSql($tableName) . "'");
 
        return (bool)$result->fetch();
    }

    public function isIndexExists($tableName, array $columns)
    {
        return $this->getIndexName($tableName, $columns) !== null;
    }

    public function getIndexName($tableName, array $columns, $strict = false)
    {
        if (empty($columns))
        {
            return null;
        }
 
        $tableName = preg_replace("/[^a-z0-9_]+/i", "", $tableName);
        $tableName = trim($tableName);
 
        $rs = $this->query("SHOW INDEX FROM `" . $this->getSqlHelper()->forSql($tableName) . "`");
        if (!$rs)
        {
            return null;
        }
 
        $indexes = [];
        while ($ar = $rs->fetch())
        {
            $indexes[$ar["Key_name"]][$ar["Seq_in_index"] - 1] = $ar["Column_name"];
        }
 
        return static::findIndex($indexes, $columns, $strict);
    }

    public function getTableFields($tableName)
    {
        if (!isset($this->tableColumnsCache[$tableName]))
        {
            $this->connectInternal();
 
            $sqlTableName = ($tableName[0] === '(')
                ? $tableName . ' AS xyz' // subquery
                : $this->getSqlHelper()->quote($tableName); // regular table name
 
            $query = $this->queryInternal("SELECT * FROM {$sqlTableName} LIMIT 0");
 
            $result = $this->createResult($query);
 
            $this->tableColumnsCache[$tableName] = $result->getFields();
        }
        return $this->tableColumnsCache[$tableName];
    }

    public function createTable($tableName, $fields, $primary = [], $autoincrement = [])
    {
        $sql = 'CREATE TABLE IF NOT EXISTS ' . $this->getSqlHelper()->quote($tableName) . ' (';
        $sqlFields = [];
 
        foreach ($fields as $columnName => $field)
        {
            if (!($field instanceof ScalarField))
            {
                throw new ArgumentException(sprintf(
                    'Field `%s` should be an Entity\ScalarField instance', $columnName
                ));
            }
 
            $realColumnName = $field->getColumnName();
 
            $sqlFields[] = $this->getSqlHelper()->quote($realColumnName)
                . ' ' . $this->getSqlHelper()->getColumnTypeByField($field)
                . ($field->isNullable() ? '' : ' NOT NULL') // null for oracle if is not primary
                . (in_array($columnName, $autoincrement, true) ? ' AUTO_INCREMENT' : '');
        }
 
        $sql .= join(', ', $sqlFields);
 
        if (!empty($primary))
        {
            foreach ($primary as &$primaryColumn)
            {
                $realColumnName = $fields[$primaryColumn]->getColumnName();
                $primaryColumn = $this->getSqlHelper()->quote($realColumnName);
            }
 
            $sql .= ', PRIMARY KEY(' . join(', ', $primary) . ')';
        }
 
        $sql .= ')';
 
        if ($this->engine)
        {
            $sql .= ' Engine=' . $this->engine;
        }
 
        $this->query($sql);
    }

    public function createIndex($tableName, $indexName, $columnNames, $columnLengths = null, $indexType = null)
    {
        if (!is_array($columnNames))
        {
            $columnNames = [$columnNames];
        }
 
        $sqlHelper = $this->getSqlHelper();
 
        foreach ($columnNames as &$columnName)
        {
            if (is_array($columnLengths) && isset($columnLengths[$columnName]) && $columnLengths[$columnName] > 0)
            {
                $maxLength = intval($columnLengths[$columnName]);
            }
            else
            {
                $maxLength = 0;
            }
 
            $columnName = $sqlHelper->quote($columnName);
            if ($maxLength > 0)
            {
                $columnName .= '(' . $maxLength . ')';
            }
        }
        unset($columnName);
 
        $indexTypeSql = '';
 
        if ($indexType !== null
            && in_array(strtoupper($indexType), [static::INDEX_UNIQUE, static::INDEX_FULLTEXT, static::INDEX_SPATIAL], true)
        )
        {
            $indexTypeSql = strtoupper($indexType);
        }
 
        $sql = 'CREATE ' . $indexTypeSql . ' INDEX ' . $sqlHelper->quote($indexName) . ' ON ' . $sqlHelper->quote($tableName)
            . ' (' . join(', ', $columnNames) . ')';
 
        try
        {
            $result = $this->query($sql);
        }
        catch (SqlQueryException $e)
        {
            // Duplicate key name
            if ($this->getErrorCode() != 1061)
            {
                throw $e;
            }
            return false;
        }
 
        return $result;
    }

    public function renameTable($currentName, $newName)
    {
        $this->query('RENAME TABLE ' . $this->getSqlHelper()->quote($currentName) . ' TO ' . $this->getSqlHelper()->quote($newName));
    }

    public function dropTable($tableName)
    {
        $this->query('DROP TABLE ' . $this->getSqlHelper()->quote($tableName));
    }
 
    /*********************************************************
     * Transactions
     *********************************************************/

    public function startTransaction()
    {
        if ($this->transactionLevel == 0)
        {
            $this->query("START TRANSACTION");
        }
        else
        {
            $this->query("SAVEPOINT TRANS{$this->transactionLevel}");
        }
 
        $this->transactionLevel++;
    }

    public function commitTransaction()
    {
        $this->transactionLevel--;
 
        if ($this->transactionLevel < 0)
        {
            throw new TransactionException('Transaction was not started.');
        }
 
        if ($this->transactionLevel == 0)
        {
            // commits all nested transactions
            $this->query("COMMIT");
        }
    }

    public function rollbackTransaction()
    {
        $this->transactionLevel--;
 
        if ($this->transactionLevel < 0)
        {
            throw new TransactionException('Transaction was not started.');
        }
 
        if ($this->transactionLevel == 0)
        {
            $this->query("ROLLBACK");
        }
        else
        {
            $this->query("ROLLBACK TO SAVEPOINT TRANS{$this->transactionLevel}");
 
            throw new TransactionException('Nested rollbacks are unsupported.');
        }
    }
 
    /*********************************************************
     * Global named lock
     *********************************************************/

    public function lock($name, $timeout = 0)
    {
        $timeout = (int)$timeout;
        $name = $this->getLockName($name);
 
        $pool = Application::getInstance()->getConnectionPool();
        $pool->useMasterOnly(true);
 
        $lock = $this->query("SELECT GET_LOCK('{$name}', {$timeout}) as L")->fetch();
 
        $pool->useMasterOnly(false);
 
        return ($lock["L"] == "1");
    }

    public function unlock($name)
    {
        $name = $this->getLockName($name);
 
        $pool = Application::getInstance()->getConnectionPool();
        $pool->useMasterOnly(true);
 
        $lock = $this->query("SELECT RELEASE_LOCK('{$name}') as L")->fetch();
 
        $pool->useMasterOnly(false);
 
        return ($lock["L"] == "1");
    }
 
    protected function getLockName($name)
    {
        $unique = \CMain::GetServerUniqID();
 
        //64 characters max for mysql 5.7+
        return md5($unique) . md5($name);
    }
 
    /*********************************************************
     * Type, version, cache, etc.
     *********************************************************/

    public function getType()
    {
        return "mysql";
    }

    public function setStorageEngine()
    {
        if ($this->engine)
        {
            // TODO: remove try-catch when mysql 5.7 will be minimal system requirement
            try
            {
                $this->query("SET default_storage_engine = '" . $this->engine . "'");
            }
            catch (SqlQueryException)
            {
                try
                {
                    $this->query("SET storage_engine = '" . $this->engine . "'");
                }
                catch (SqlQueryException)
                {
                }
            }
        }
    }

    abstract public function selectDatabase($database);

    public function getMaxAllowedPacket()
    {
        static $mtu;
 
        if (is_null($mtu))
        {
            $mtu = 0;
 
            $res = $this->query("SHOW VARIABLES LIKE 'max_allowed_packet'")->fetch();
            if ($res['Variable_name'] == 'max_allowed_packet')
            {
                $mtu = intval($res['Value']);
            }
        }
 
        return $mtu;
    }

    public function createQueryException($code = 0, $databaseMessage = '', $query = '')
    {
        if ($code == 1062)
        {
            return new DuplicateEntryException('Mysql query error', $databaseMessage, $query);
        }
        return new SqlQueryException('Mysql query error', $databaseMessage, $query);
    }
}