Spec-Zone.ru › CakePHP 3.4

Класс 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
  • $_supportsNativeJson protected
    boolean
    Поддерживает ли сервер нативный JSON
  • $_version protected
    string
    Версия сервера

Наследованные магические свойства

  • _connection

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

  • _autoQuoting, _config _endQuote, _schemaDialect, _startQuote _connection

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

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

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

  • supportsNativeJson() public
    Возвращает true, если сервер поддерживает нативные JSON-колонки

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

connect()source public

connect( )

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

Возвращает

boolean
true при успехе

enabled()source public

enabled( )

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

Возвращает

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

prepare()source public

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

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

Параметры

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

Возвращает

Cake\Database\StatementInterface

schema()source public

schema( )

Возвращает имя схемы, используемой в настоящее время

Возвращает

string

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

Cake\Database\Driver::schema()

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

supportsNativeJson()source public

supportsNativeJson( )

Возвращает true, если сервер поддерживает нативные JSON-колонки

Возвращает

boolean

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

array $config optional []
Конфигурация для драйвера.

Исключение

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

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

Устарело

3.4.0 использовать enableAutoQuoting()/isAutoQuotingEnabled() вместо.

Параметры

boolean|null $enable optional 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
Используемый связующий объект значений.

Возвращает

array

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


connection()source abstract public

connection( null|PDO $connection null )

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

Параметры

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

Возвращает

PDO

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

string

disconnect()source abstract public

disconnect( )

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

END_OF_DOCUMENT_MARKER

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable true )

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

Параметры

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

Возвращает


$this

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

string

isAutoQuotingEnabled()source public

isAutoQuotingEnabled( )

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

Возвращает

boolean

isConnected()source public

isConnected( )

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

Возвращает

boolean

lastInsertId()source public

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

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

Параметры

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

Возвращает

string|integer

newCompiler()source public

newCompiler( )

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

Возвращает

Cake\Database\QueryCompiler

queryTranslator()source abstract public

queryTranslator( string $type )

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

Параметры

string $type

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

Возвращает

callable

quote()source abstract public

quote( mixed $value , string $type )

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

Параметры

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

Возвращает

string

quoteIdentifier()source abstract public

quoteIdentifier( string $identifier )

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

Параметры

string $identifier
Выражение идентификатора для указания.

Возвращает

string

releaseSavePointSQL()source abstract public

releaseSavePointSQL( string $name )

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

Параметры

string $name
Имя таблицы

Возвращает

string

rollbackSavePointSQL()source abstract public

rollbackSavePointSQL( string $name )

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

Параметры

string $name
Имя таблицы

Возвращает

string

rollbackTransaction()source abstract public

rollbackTransaction( )

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

Возвращает

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

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

string $name
Имя таблицы

Возвращает

string

schemaDialect()source abstract public

schemaDialect( )

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

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

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

Возвращает

Cake\Database\Schema\BaseSchema

schemaValue()source public

schemaValue( mixed $value )

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

Параметры

mixed $value
Значение для экранирования.

Возвращает

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

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

boolean

supportsSavePoints()source public

supportsSavePoints( )

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

Возвращает

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

Методы, используемые из 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 )

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

Параметры

string $dsn
Драйвер-специфический PDO-DSN
array $config
конфигурация, используемая для создания подключения

Возвращает

boolean
истина при успехе

beginTransaction()source public

beginTransaction( )

Начало транзакции

Возвращает

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

commitTransaction()source public

commitTransaction( )

Фиксирует транзакцию

Возвращает

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

connection()source public

connection( null|PDO $connection null )

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

Параметры

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

Возвращает

PDO
внутренний объект подключения

disconnect()source public

disconnect( )

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

isConnected()source public

isConnected( )

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

Возвращает

boolean

lastInsertId()source public

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

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

Параметры

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

Возвращает

string|integer

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' => [],
]

$_supportsNativeJsonsource

protected boolean

Поддерживает ли сервер работу с JSON нативными средствами

$_versionsource

protected string

Версия сервера

© 2005–2017 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.4/class-Cake.Database.Driver.Mysql.html

Spec-Zone.ru

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