Spec-Zone.ru › CakePHP 3.1

Класс Mysql

Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.

Cake\Database\Driver
Расширенный Cake\Database\Driver\Mysql использует Cake\Database\Dialect\MysqlDialectTrait, Cake\Database\Driver\PDODriverTrait
Пространство имён: Cake\Database\Driver
Расположение: Database/Driver/Mysql.php

Подробное описание методов

connectsource public

connect( )

Устанавливает соединение с сервером базы данных

Возвращает

boolean
true при успехе

enabledsource public

enabled( )

Возвращает, может ли php использовать этот драйвер для подключения к базе данных

Возвращает

boolean
true, если этот драйвер можно использовать

preparesource public

prepare( string|Cake\Database\Query $query )

Подготавливает оператор SQL для выполнения

Параметры

строка|Cake\Database\Query $query
Запрос для подготовки.

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

supportsDynamicConstraintssource public

supportsDynamicConstraints( )

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.

Возвращает

boolean
true, если драйвер поддерживает динамические ограничения

Наследуемые методы из Cake\Database\Driver

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

массив $config опционально []
Настройка для драйвера.

Исключения

InvalidArgumentException
InvalidArgumentException

__debugInfosource public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array
массив

__destructsource public

__destruct( )

Деструктор

autoQuotingsource public

autoQuoting( boolean $enable null )

Возвращает, следует ли этому драйверу автоматически заключать идентификаторы в запросах

Если вызвана с булевым аргументом, она переключает настройку автоматического заключения в переданное значение

Параметры

boolean $enable опционально null
включить ли автоматическое заключение

Возвращает

boolean
bool

beginTransactionsource абстрактный public

beginTransaction( )

Начинает транзакцию

Возвращает

boolean
true при успехе, иначе false

commitTransactionsource абстрактный public

commitTransaction( )

Подтверждает транзакцию

Возвращает

boolean
true при успехе, иначе false

compileQuerysource public

compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )

Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL

Параметры

Cake\Database\Query $query
Запрос для компиляции.
Cake\Database\ValueBinder $generator
Используемый связующий объект значений.

Возвращает

array
содержащий 2 записи. Первый элемент — преобразованный запрос, а второй — скомпилированная строка SQL

connectionsource абстрактный public

connection( null|PDO $connection null )

Возвращает правильный ресурс или объект соединения, который используется во внутренней части. Если первый аргумент передан,

Параметры

null|PDO $connection опционально null
Объект соединения

disableForeignKeySQLsource абстрактный public

disableForeignKeySQL( )

Получить SQL для отключения внешних ключей

Возвращает

string
строка

disconnectsource абстрактный public

disconnect( )

Отключается от сервера базы данных

enableForeignKeySQLsource абстрактный public

enableForeignKeySQL( )

Получить SQL для включения внешних ключей

Возвращает

string
строка

isConnectedsource public

isConnected( )

Проверка подключения драйвера.

Возвращает

boolean
bool

lastInsertIdsource public

lastInsertId( string $table null , string $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

строка $table опционально null
имя таблицы или последовательности для получения последнего значения вставки
строка $column опционально null
имя столбца, представляющего первичный ключ

Возвращает

string|integer
строка|int

newCompilersource public

newCompiler( )

Возвращает экземпляр QueryCompiler

Возвращает

Cake\Database\QueryCompiler
\Cake\Database\QueryCompiler

queryTranslatorsource абстрактный public

queryTranslator( string $type )

Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для соответствия любым особенностям диалекта SQL, используемого в данный момент.

Параметры

строка $type
тип запроса, который должен быть преобразован (select, insert, update, delete)

Возвращает

callable
вызываемая функция

quotesource абстрактный public

quote( mixed $value , string $type )

Возвращает значение в безопасном представлении для использования в строке запроса

Параметры

смешанное $value
Значение для заключения в кавычки.
строка $type
Тип, используемый для определения вида заключения в кавычки

Возвращает

string
строка
END_OF_DOCUMENT_MARKER

quoteIdentifiersource abstract public

quoteIdentifier( string $identifier )

Приводит идентификатор базы данных (имя столбца, имя таблицы и т. д.) в безопасный для использования в запросах формат, предотвращая проблемы с использованием зарезервированных слов.

Параметры

строка $identifier
Выражение идентификатора, которое нужно привести к цитируемому виду.

Возвращаемые значения

string
строка

releaseSavePointSQLsource abstract public

releaseSavePointSQL( string $name )

Получить SQL-запрос для освобождения точки сохранения.

Параметры

строка $name
Имя таблицы

Возвращаемые значения

string
строка

rollbackSavePointSQLsource abstract public

rollbackSavePointSQL( string $name )

Получить SQL-запрос для отката точки сохранения.

Параметры

строка $name
Имя таблицы

Возвращаемые значения

string
строка

rollbackTransactionsource abstract public

rollbackTransaction( )

Откатывает транзакцию.

Возвращаемые значения

boolean
true при успехе, false в противном случае

savePointSQLsource abstract public

savePointSQL( string $name )

Получить SQL-запрос для создания точки сохранения.

Параметры

строка $name
Имя таблицы

Возвращаемые значения

string
строка

schemaDialectsource abstract public

schemaDialect( )

Получить диалект схемы.

Используется пакетом Cake\Database\Schema для отображения и генерации схемы.

Если все таблицы, использующие данный драйвер, указывают свои собственные схемы, то это может вернуть null.

Возвращаемые значения

Cake\Database\Schema\BaseSchema
\Cake\Database\Schema\BaseSchema

schemaValuesource public

schemaValue( mixed $value )

Экранирует значения для использования в определениях схем.

Параметры

смешанный $value
Значение, которое нужно экранировать.

Возвращаемые значения

string
Строка для использования в определениях схем.

supportsQuotingsource public

supportsQuoting( )

Проверяет, поддерживает ли драйвер цитирование.

Возвращаемые значения

boolean
bool

supportsSavePointssource public

supportsSavePoints( )

Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций.

Возвращаемые значения

boolean
true, если точки сохранения поддерживаются, false в противном случае

Методы, используемые из Cake\Database\Dialect\MysqlDialectTrait

disableForeignKeySQLsource public

disableForeignKeySQL( )

enableForeignKeySQLsource public

enableForeignKeySQL( )

schemaDialectsource public

schemaDialect( )

Получить диалект схемы.

Используется пакетом Cake\Database\Schema для отображения и генерации схемы.

Возвращаемые значения

Cake\Database\Schema\MysqlSchema
\Cake\Database\Schema\MysqlSchema

Методы, используемые из Cake\Database\SqlDialectTrait

_deleteQueryTranslatorsource protected

_deleteQueryTranslator( Cake\Database\Query $query )

Применить шаги трансляции к запросам удаления.

Удаляет псевдонимы из условий запросов удаления, так как большинство диалектов баз данных не поддерживают псевдонимы в запросах удаления. Это также удаляет псевдонимы из имен таблиц, так как они часто тоже не работают.

Мы намеренно не поддерживаем удаления с объединениями, так как они имеют ещё худшую поддержку.

Параметры

Cake\Database\Query $query
Запрос для трансляции

Возвращаемые значения

Cake\Database\Query
Изменённый запрос

_expressionTranslatorssource protected

_expressionTranslators( )

Возвращает ассоциативный массив методов, которые преобразуют объекты Expression в соответствии с конкретным диалектом SQL. Ключами являются имена классов, а значениями — метод в этом классе.

Возвращаемые значения

array
массив

_insertQueryTranslatorsource protected

_insertQueryTranslator( Cake\Database\Query $query )

Применить шаги трансляции к запросам вставки.

Параметры

Cake\Database\Query $query
Запрос для трансляции

Возвращаемые значения

Cake\Database\Query
Изменённый запрос

_selectQueryTranslatorsource protected

_selectQueryTranslator( Cake\Database\Query $query )

Применить шаги трансляции к запросам выборки.

Параметры

Cake\Database\Query $query
Запрос для трансляции

Возвращаемые значения

Cake\Database\Query
Изменённый запрос

_transformDistinctsource protected

_transformDistinct( Cake\Database\Query $query )

Возвращает переданный запрос после переписывания предложения DISTINCT таким образом, чтобы драйверы, которые не поддерживают часть «ON», могли предоставить фактический способ его выполнения.

Параметры

Cake\Database\Query $query
Запрос, который нужно преобразовать

Возвращаемые значения

Cake\Database\Query
\Cake\Database\Query

_updateQueryTranslatorsource protected

_updateQueryTranslator( Cake\Database\Query $query )

Применить шаги трансляции к запросам обновления.

Параметры

Cake\Database\Query $query
Запрос для трансляции

Возвращаемые значения

Cake\Database\Query
Изменённый запрос

queryTranslatorsource public

queryTranslator( string $type )

Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для адаптации к специфике используемого диалекта SQL.

Параметры

строка $type
тип запроса, который нужно преобразовать (select, insert, update, delete)

Возвращаемые значения

callable
вызываемая функция

quoteIdentifiersource public

quoteIdentifier( string $identifier )

Приводит идентификатор базы данных (имя столбца, имя таблицы и т. д.) в безопасный для использования в запросах формат, предотвращая проблемы с использованием зарезервированных слов.

Параметры

строка $identifier
Идентификатор, который нужно привести к цитируемому виду.

Возвращаемые значения

string
строка

releaseSavePointSQLsource public

releaseSavePointSQL( string $name )

Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения

Параметры

строка $name
имя точки сохранения

Возвращает

string
строка

rollbackSavePointSQLsource public

rollbackSavePointSQL( string $name )

Возвращает фрагмент SQL для отката ранее созданной точки сохранения

Параметры

строка $name
имя точки сохранения

Возвращает

string
строка

savePointSQLsource public

savePointSQL( string $name )

Возвращает фрагмент SQL для создания новой точки сохранения транзакции

Параметры

строка $name
имя точки сохранения

Возвращает

string
строка

Методы, используемые из Cake\Database\Driver\PDODriverTrait

_connectsource protected

_connect( string $dsn , array $config )

Устанавливает соединение с сервером базы данных

Параметры

строка $dsn
Спецификация DSN для PDO, специфичная для драйвера
массив $config
настройки, используемые для создания соединения

Возвращает

boolean
true при успехе

beginTransactionsource public

beginTransaction( )

Начинает транзакцию

Возвращает

boolean
true при успехе, иначе false

commitTransactionsource public

commitTransaction( )

Подтверждает транзакцию

Возвращает

boolean
true при успехе, иначе false

connectionsource public

connection( null|PDO $connection null )

Возвращает корректный ресурс или объект соединения, используемый внутри. Если передан первый аргумент, он установит внутренний объект соединения или результат в переданное значение

Параметры

null|PDO $connection необязательно null
Экземпляр соединения PDO.

Возвращает

PDO
объект соединения, используемый внутри

disconnectsource public

disconnect( )

Отключается от сервера базы данных

isConnectedsource public

isConnected( )

Проверяет, подключен ли драйвер.

Возвращает

boolean
bool

Переопределяет

Cake\Database\Driver::isConnected()

lastInsertIdsource public

lastInsertId( string|null $table null , string|null $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

строка|null $table необязательно null
имя таблицы или последовательности, чтобы получить последнее значение вставки
строка|null $column необязательно null
имя столбца, представляющего первичный ключ

Возвращает

string|integer
строка|целое число

Переопределяет

Cake\Database\Driver::lastInsertId()

quotesource public

quote( mixed $value , string $type )

Возвращает значение в безопасном представлении для использования в строке запроса

Параметры

смешанный $value
Значение для цитирования.
строка $type
Тип, используемый для определения типа цитирования

Возвращает

string
строка

rollbackTransactionsource public

rollbackTransaction( )

Откатывает транзакцию

Возвращает

boolean
true при успехе, иначе false

supportsQuotingsource public

supportsQuoting( )

Проверяет, поддерживает ли драйвер цитирование, так как PDO_ODBC его не поддерживает.

Возвращает

boolean
bool

Переопределяет

Cake\Database\Driver::supportsQuoting()

Сводка свойств

$_baseConfigsource

protected массив

Основные настройки конфигурации драйвера MySQL

[
    'persistent' => true,
    'host' => 'localhost',
    'username' => 'root',
    'password' => '',
    'database' => 'cake',
    'port' => '3306',
    'flags' => [],
    'encoding' => 'utf8',
    'timezone' => null,
    'init' => [],
]

Свойства, унаследованные от Cake\Database\Driver

$_autoQuotingsource

protected boolean

Указывает, выполняет ли драйвер автоматическое цитирование идентификаторов для всех запросов

false

$_configsource

protected массив

Данные конфигурации.

Свойства, используемые из Cake\Database\Dialect\MysqlDialectTrait

$_endQuotesource

protected строка

Строка, используемая для завершения цитирования идентификатора базы данных, чтобы сделать его безопасным

'`'

$_schemaDialectsource

protected Cake\Database\Schema\MysqlSchema

Класс диалекта схемы для этого драйвера

$_startQuotesource

protected строка

Строка, используемая для начала цитирования идентификатора базы данных, чтобы сделать его безопасным

'`'

Свойства, используемые из Cake\Database\Driver\PDODriverTrait

$_connectionsource

protected PDO

Экземпляр PDO.

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Driver.Mysql.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API