Spec-Zone.ru › CakePHP 3.8

Класс Mysql

Класс Mysql

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

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

  • $_baseConfig protected
    array
    Базовые параметры конфигурации для драйвера MySQL
  • $_supportsNativeJson protected
    boolean
    Поддерживает ли сервер native JSON
  • $_version protected
    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( )

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

Возвращает

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

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

Cake\Database\Driver::prepare()

schema()source public

schema( )

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

Возвращает

string

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

Cake\Database\Driver::schema()

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

supportsNativeJson()source public

supportsNativeJson( )

Возвращает true, если сервер поддерживает native JSON столбцы

Возвращает

boolean

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

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

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

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

_connect()source protected

_connect( string $dsn , array $config )

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

Параметры

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

Возвращает

boolean
true при успехе

autoQuoting()source public deprecated

autoQuoting( boolean|null $enable = null )

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

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

Устарело

3.4.0 используйте enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.

Параметры

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

Возвращает

boolean

beginTransaction()source public

beginTransaction( )

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

Возвращает

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

Реализация

Cake\Database\DriverInterface::beginTransaction()

commitTransaction()source public

commitTransaction( )

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

Возвращает

boolean
True при успехе, 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
Используемый Binder значений.

Возвращает

array

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


Реализация

Cake\Database\DriverInterface::compileQuery()

connection()source public deprecated

connection( mixed $connection = null )

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

Устарело

3.6.0 Используйте getConnection()/setConnection() вместо этого.

Параметры

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

Возвращает

mixed
Внутренне используемый объект подключения.

disableAutoQuoting()source public

disableAutoQuoting( )

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

Возвращает


$this
END_OF_DOCUMENT_MARKER

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
True, если точки сохранения поддерживаются, false — в противном случае.

Реализация

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

$_supportsNativeJsonsource

protected булево

Поддерживает ли сервер native JSON

$_versionsource

protected строка

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

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

Spec-Zone.ru

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