Spec-Zone.ru › CakePHP 3.2

Класс Mysql

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

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

Краткое описание свойств

  • $_baseConfig protected
    array
    Основные настройки конфигурации для драйвера MySQL

Унаследованные свойства

  • _autoQuoting, _config _endQuote, _schemaDialect, _startQuote _connection

Краткое описание методов

  • connect() public
    Устанавливает подключение к серверу базы данных
  • enabled() public
    Возвращает, может ли php использовать этот драйвер для подключения к базе данных
  • prepare() public
    Подготавливает sql-запрос для выполнения
  • supportsDynamicConstraints() public

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

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

connect()source public

connect( )

Устанавливает подключение к серверу базы данных

Возвращает

boolean
true при успехе

enabled()source public

enabled( )

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

Возвращает

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

prepare()source public

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

Подготавливает sql-запрос для выполнения

Параметры

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

Возвращает

Cake\Database\StatementInterface

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__destruct()source public

__destruct( )

Деструктор

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

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

Параметры

boolean|null $enable необязательно null
включить автоматическое заключение

Возвращает

boolean

beginTransaction()source abstract public

beginTransaction( )

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

Возвращает

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

commitTransaction()source abstract public

commitTransaction( )

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

Возвращает

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

compileQuery()source public

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

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

Параметры

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

Возвращает

массив

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


connection()source abstract public

connection( null|PDO $connection null )

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

Параметры

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

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

строка

disconnect()source abstract public

disconnect( )

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

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

строка

isConnected()source public

isConnected( )

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

Возвращает

boolean

lastInsertId()source public

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

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

Параметры

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

Возвращает

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

newCompiler()source public

newCompiler( )

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

Возвращает

Cake\Database\QueryCompiler
END_OF_DOCUMENT_MARKER

queryTranslator()source abstract public

queryTranslator( string $type )

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

Параметры

строка $type

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

Возвращает

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

quote()source abstract public

quote( mixed $value , string $type )

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

Параметры

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

Возвращает

строка

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

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

Параметры

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

Возвращает

строка

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

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

Параметры

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

Возвращает

строка

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

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

Параметры

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

Возвращает

строка

rollbackTransaction()source abstract public

rollbackTransaction( )

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

Возвращает

булево значение
истина при успехе, ложь в противном случае

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

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

Возвращает

строка

schemaDialect()source abstract public

schemaDialect( )

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

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

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

Возвращает

Cake\Database\Schema\BaseSchema

schemaValue()source public

schemaValue( mixed $value )

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

Параметры

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

Возвращает

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

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

булево значение

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

булево значение
истина, если точки сохранения поддерживаются, ложь в противном случае

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

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

schemaDialect()source public

schemaDialect( )

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

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

Возвращает

Cake\Database\Schema\MysqlSchema

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

_connect()source protected

_connect( string $dsn , array $config )

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

Параметры

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

Возвращает

булево значение
истина при успехе

beginTransaction()source public

beginTransaction( )

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

Возвращает

булево значение
истина при успехе, ложь в противном случае

commitTransaction()source public

commitTransaction( )

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

Возвращает

булево значение
истина при успехе, ложь в противном случае

connection()source public

connection( null|PDO $connection null )

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

Параметры

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

Возвращает

PDO
внутренний объект соединения

disconnect()source public

disconnect( )

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

isConnected()source public

isConnected( )

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

Возвращает

булево значение

lastInsertId()source public

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

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

Параметры

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

Возвращает

строка или целое число
END_OF_DOCUMENT_MARKER

quote()source public

quote( mixed $value , string $type )

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

Параметры

mixed $value
Значение для обработки.
string $type
Тип для определения вида обработки.

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

string

rollbackTransaction()source public

rollbackTransaction( )

Откатить транзакцию

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

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

supportsQuoting()source public

supportsQuoting( )

Проверяет, поддерживает ли драйвер обработку кавычек, так как PDO_ODBC её не поддерживает.

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

boolean

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

$_baseConfigsource

protected array

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

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

© 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.2/class-Cake.Database.Driver.Mysql.html

Spec-Zone.ru

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