Spec-Zone.ru › CakePHP 3.3

Класс Mysql

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

Cake\Database\Driver
Расширяется 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
    Версия сервера

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

  • _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 необязательно []
Конфигурация для драйвера.

Выбрасывает

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__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
Использовать для привязки значений.

Возвращает

array

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


connection()source abstract public

connection( null|PDO $connection null )

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

Параметры

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

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

string

disconnect()source abstract public

disconnect( )

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

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

string
END_OF_DOCUMENT_MARKER ```

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 абстрактный public

queryTranslator( string $type )

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

Параметры

string $type

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

Возвращает

callable

quote()source абстрактный public

quote( mixed $value , string $type )

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

Параметры

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

Возвращает

string

quoteIdentifier()source абстрактный public

quoteIdentifier( string $identifier )

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

Параметры

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

Возвращает

string

releaseSavePointSQL()source абстрактный public

releaseSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

rollbackSavePointSQL()source абстрактный public

rollbackSavePointSQL( string $name )

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

Параметры

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

Возвращает

string

rollbackTransaction()source абстрактный public

rollbackTransaction( )

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

Возвращает

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

savePointSQL()source абстрактный public

savePointSQL( string $name )

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

Параметры

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

Возвращает

string

schemaDialect()source абстрактный 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
true при успехе

beginTransaction()source public

beginTransaction( )

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

Возвращает

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

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( )

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

END_OF_DOCUMENT_MARKER

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

Поддерживает ли сервер native 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.3/class-Cake.Database.Driver.Mysql.html

Spec-Zone.ru

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