Класс Mysql
Класс Mysql
- Cake\Database\Driver implements Cake\Database\DriverInterface
-
Cake\Database\Driver\Mysql использует Cake\Database\Dialect\MysqlDialectTrait
Краткое описание свойств
-
$_baseConfigprotectedОсновные параметры конфигурации для драйвера MySQLarray -
$_supportsNativeJsonprotectedПоддерживает ли сервер native JSONboolean -
$_versionprotectedВерсия сервераstring
Наследуемые свойства
-
_autoQuoting,_config,_connection_endQuote,_schemaDialect,_startQuote
Краткое описание методов
- connect() publicУстанавливает соединение с сервером базы данных
- enabled() publicВозвращает, может ли PHP использовать этот драйвер для подключения к базе данных
- prepare() publicПодготавливает SQL-запрос для выполнения
- schema() publicВозвращает имя схемы, используемой в данный момент.
- supportsDynamicConstraints() public
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
- supportsNativeJson() publicВозвращает true, если сервер поддерживает native JSON столбцы
Подробное описание методов
connect()source public
connect( )
Устанавливает соединение с сервером базы данных
Возвращает
booleantrue при успехе
enabled()source public
enabled( )
Возвращает, может ли PHP использовать этот драйвер для подключения к базе данных
Возвращает
booleantrue, если этот драйвер можно использовать
prepare()source public
prepare( string|Cake\Database\Query $query )
Подготавливает SQL-запрос для выполнения
Параметры
- строка|
Cake\Database\Query$query - Запрос для подготовки.
Возвращает
Cake\Database\StatementInterfaceПереопределяет
Cake\Database\Driver::prepare() schema()source public
schema( )
Возвращает имя схемы, используемой в данный момент.
Возвращает
строкаПереопределяет
Cake\Database\Driver::schema() supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения.
supportsNativeJson()source public
supportsNativeJson( )
Возвращает true, если сервер поддерживает native JSON столбцы
Возвращает
booleanНаследуемые методы от Cake\Database\Driver
__construct()source public
__construct( array $config = [] )
Конструктор
Параметры
- массив
$configнеобязательно [] - Конфигурация для драйвера.
Исключение
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массив_connect()source protected
_connect( string $dsn , array $config )
Устанавливает соединение с сервером базы данных
Параметры
- строка
$dsn - Драйвер-специфичный PDO-DSN
- массив
$config - Конфигурация, используемая для создания подключения
Возвращает
booleantrue при успехе
autoQuoting()source public deprecated
autoQuoting( boolean|null $enable = null )
Возвращает, должен ли этот драйвер автоматически указывать идентификаторы в запросах
Если вызван с булевым аргументом, он переключает настройку автоматического указания на переданное значение
Устарело
3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- boolean|null
$enableнеобязательно null - Включать ли автоматическое указание
Возвращает
booleanbeginTransaction()source public
beginTransaction( )
Начинает транзакцию.
Возвращает
booleanTrue при успехе, false в противном случае.
Реализация
Cake\Database\DriverInterface::beginTransaction() commitTransaction()source public
commitTransaction( )
Подтверждает транзакцию.
Возвращает
booleanTrue при успехе, false в противном случае.
Реализация
Cake\Database\DriverInterface::commitTransaction() compileQuery()source public
compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )
Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL.
Параметры
-
Cake\Database\Query$query - Запрос для компиляции.
- Cake\Database\ValueBinder
$generator - Используемый обработчик значений.
Возвращает
массивсодержащий 2 элемента. Первый элемент — преобразованный запрос, второй — скомпилированная строка SQL.
Реализация
Cake\Database\DriverInterface::compileQuery() connection()source public deprecated
connection( mixed $connection = null )
Возвращает правильный ресурс или объект подключения, используемый внутри. Если первый аргумент передан, он установит внутренний объект подключения или результат на переданное значение.
Устарело
3.6.0 Используйте getConnection()/setConnection() вместо этого.Параметры
- смешанный
$connectionнеобязательно null - Экземпляр подключения PDO.
Возвращает
смешанныйВнутренний объект подключения.
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получить SQL для отключения внешних ключей.
Возвращает
stringРеализация
Cake\Database\DriverInterface::disableForeignKeySQL() disconnect()source public
disconnect( )
Отключается от сервера базы данных.
Реализация
Cake\Database\DriverInterface::disconnect() enableAutoQuoting()source public
enableAutoQuoting( boolean $enable = true )
Устанавливает, нужно ли автоматически заключать идентификаторы в запросах.
Параметры
- boolean
$enableнеобязательный true - Включить автоматическое заключение в кавычки
Возвращает
$this
Реализация
Cake\Database\DriverInterface::enableAutoQuoting() enableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получить SQL для включения внешних ключей.
Возвращает
stringРеализация
Cake\Database\DriverInterface::enableForeignKeySQL() getConnection()source public
getConnection( )
Получить внутренний экземпляр подключения PDO.
Возвращает
PDOРеализация
Cake\Database\DriverInterface::getConnection() isAutoQuotingEnabled()source public
isAutoQuotingEnabled( )
Возвращает, следует ли автоматически заключать идентификаторы в запросах.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::isAutoQuotingEnabled() isConnected()source public
isConnected( )
Проверяет, подключен ли драйвер.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::isConnected() lastInsertId()source public
lastInsertId( string|null $table = null , string|null $column = null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных.
Параметры
- string|null
$tableнеобязательный null - имя таблицы или последовательности, чтобы получить последнее значение вставки.
- string|null
$columnнеобязательный null - имя столбца, представляющего первичный ключ.
Возвращает
string|integerРеализация
Cake\Database\DriverInterface::lastInsertId() newCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler.
Возвращает
Cake\Database\QueryCompilerРеализация
Cake\Database\DriverInterface::newCompiler() queryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для соответствия особенностям используемого диалекта SQL.
Параметры
- string
$type Тип запроса, который должен быть преобразован (select, insert, update, delete).
Возвращает
callableРеализация
Cake\Database\DriverInterface::queryTranslator() quote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение, которое нужно заключить в кавычки.
- string
$type - Тип, используемый для определения типа заключаемых в кавычки.
Возвращает
stringРеализация
Cake\Database\DriverInterface::quote() quoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Заключает базовый идентификатор базы данных (имя столбца, имя таблицы и т.д.) в кавычки, чтобы безопасно использовать его в запросах, не рискуя использовать зарезервированные слова.
Параметры
- string
$identifier - Выражение идентификатора, которое нужно заключить в кавычки.
Возвращает
stringРеализация
Cake\Database\DriverInterface::quoteIdentifier() releaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Получить SQL для отмены сохранения точки.
Параметры
- string
$name - Название таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::releaseSavePointSQL() rollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Получить SQL для отката сохранения точки.
Параметры
- string
$name - Название таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::rollbackSavePointSQL() rollbackTransaction()source public
rollbackTransaction( )
Откатывает транзакцию.
Возвращает
booleanУспешно — true, иначе — false.
Реализация
Cake\Database\DriverInterface::rollbackTransaction() savePointSQL()source abstract public
savePointSQL( string $name )
Получить SQL для создания точки сохранения.
Параметры
- string
$name - Название таблицы.
Возвращает
stringРеализация
Cake\Database\DriverInterface::savePointSQL() schemaDialect()source abstract public
schemaDialect( )
Получить диалект схемы.
Возвращает
Cake\Database\Schema\BaseSchemaРеализация
Cake\Database\DriverInterface::schemaDialect() schemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схем.
Параметры
- mixed
$value - Значение, которое нужно экранировать.
Возвращает
stringСтрока для использования в определениях схем.
Реализация
Cake\Database\DriverInterface::schemaValue() setConnection()source public
setConnection( PDO $connection )
Установить внутренний экземпляр подключения PDO.
Параметры
- PDO
$connection - Экземпляр PDO.
Возвращает
$this
Реализация
Cake\Database\DriverInterface::setConnection() supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер заключение в кавычки, так как PDO_ODBC его не поддерживает.
Возвращает
booleanРеализация
Cake\Database\DriverInterface::supportsQuoting() supportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли данный драйвер точки сохранения для вложенных транзакций.
Возвращает
booleanИстина, если точки сохранения поддерживаются, ложь в противном случае.
Реализация
Cake\Database\DriverInterface::supportsSavePoints() Методы, используемые из Cake\Database\Dialect\MysqlDialectTrait
disableForeignKeySQL()source public
disableForeignKeySQL( )
enableForeignKeySQL()source public
enableForeignKeySQL( )
schemaDialect()source public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Возвращает
Cake\Database\Schema\MysqlSchemaПодробное описание свойств
$_baseConfigsource
protected массив
Основные параметры конфигурации для драйвера MySQL
[
'persistent' => true,
'host' => 'localhost',
'username' => 'root',
'password' => '',
'database' => 'cake',
'port' => '3306',
'flags' => [],
'encoding' => 'utf8mb4',
'timezone' => null,
'init' => [],
]
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Driver.Mysql.html