Класс Connection

__construct()source public

__construct( array $config )

Конструктор.

Параметры

массив $config

конфигурация для подключения к базе данных

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

Отключает драйвер, чтобы освободить соединение.

_newLogger()source protected

_newLogger( Cake\Database\StatementInterface $statement )

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

Параметры

Cake\Database\StatementInterface $statement

экземпляр для обработки

Возвращает

Cake\Database\Log\LoggingStatement

begin()source public

begin( )

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

cacheMetadata()source public

cacheMetadata( boolean|string $cache )

Включает или отключает кэширование метаданных для этого соединения

Изменение этого параметра не повлияет на существующие объекты коллекций схем.

Параметры

boolean|string $cache

Либо boolean false для отключения кеширования метаданных, или true для использования _cake_model_ или имя конфигурации кэша для использования.

commit()source public

commit( )

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

Возвращает

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

compileQuery()source public

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

Компилирует объект Query в строку SQL в соответствии с диалектом для драйвера этого соединения

Параметры

Cake\Database\Query $query

Запрос для компиляции

Cake\Database\ValueBinder $generator

Генератор плейсхолдеров для использования

Возвращает

string

config()source public

config( )

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

Возвращает

array

Реализация

Cake\Datasource\ConnectionInterface::config()

configName()source public

configName( )

Получает имя конфигурации для этого соединения.

Возвращает

string

Реализация

Cake\Datasource\ConnectionInterface::configName()

connect()source public

connect( )

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

Возвращает

boolean
true, если соединение уже установлено или попытка была успешной.

Выбрасывает

Cake\Database\Exception\MissingConnectionException
если учетные данные неверны.

createSavePoint()source public

createSavePoint( string $name )

Создаёт новую точку сохранения для вложенных транзакций.

Параметры

string $name

Имя точки сохранения.

delete()source public

delete( string $table , array $conditions = [] , array $types = [] )

Выполняет операцию DELETE для указанной таблицы.

Параметры

string $table

таблица, из которой удаляются строки

array $conditions optional []

условия для оператора DELETE

array $types optional []

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

Возвращает

Cake\Database\StatementInterface

disableConstraints()source public

disableConstraints( callable $callback )

Выполняет операцию с отключёнными ограничениями.

Пример:

$connection->disableConstraints(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

Параметры

callable $callback

$operation Обработчик для выполнения внутри транзакции.

Возвращает

mixed
Значение, возвращаемое обработчиком.

Выбрасывает

Exception

Перебросит любое исключение, поднятое в $callback, после отката транзакции.

Реализация

Cake\Datasource\ConnectionInterface::disableConstraints()

disableForeignKeys()source public

disableForeignKeys( )

Выполняет драйвер-специфический SQL для отключения проверок внешних ключей.

disconnect()source public

disconnect( )

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

driver()source public deprecated

driver( Cake\Database\Driver|string|null $driver = null , array $config = [] )

Устанавливает экземпляр драйвера. Если передаётся строка, она будет обработана как имя класса и будет создан экземпляр.

Если параметры не переданы, возвращается текущий экземпляр драйвера.

Устарело

3.4.0 Используйте setDriver()/getDriver() вместо этого.

Параметры

Cake\Database\Driver|string|null $driver optional null

Экземпляр драйвера для использования.

array $config optional []

либо конфигурация для нового драйвера, либо null.

Возвращает

Cake\Database\Driver

Выбрасывает

Cake\Database\Exception\MissingDriverException
Если класс драйвера отсутствует.
Cake\Database\Exception\MissingExtensionException
Если отсутствует PHP-расширение драйвера.

enableForeignKeys()source public

enableForeignKeys( )

Выполняет драйвер-специфический SQL для включения проверок внешних ключей.

enableSavePoints()source public

enableSavePoints( boolean $enable )

Включает/отключает использование точек сохранения, включает только если драйвер это поддерживает.

Если вы пытаетесь включить эту функцию, убедитесь, что вы проверили возвращаемое значение этой функции, чтобы убедиться, что она была включена успешно.

Пример:

$connection->enableSavePoints(true) Возвращает true, если драйвер поддерживает точки сохранения, иначе false $connection->enableSavePoints(false) Отключает использование точек сохранения и возвращает false

Параметры

boolean $enable

Использовать или нет точки сохранения.

Возвращает

$this

execute()source public

execute( string $query , array $params = [] , array $types = [] )

Выполняет запрос, используя $params для интерполяции значений и $types как подсказку для каждого из этих параметров.

Параметры

string $query

SQL запрос, который будет выполнен и интерполирован с $params

array $params optional []

список или ассоциативный массив параметров, которые будут интерполированы в $query как значения

array $types optional []

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

Возвращает

Cake\Database\StatementInterface
выполненный запрос

getDisconnectRetry()source public

getDisconnectRetry( )

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

Возвращает

Cake\Core\Retry\CommandRetry
Объект повторных попыток

getDriver()source public

getDriver( )

Получает экземпляр драйвера.

Возвращает

Cake\Database\Driver

getLogger()source public

getLogger( )

Получает объект логгера.

Возвращает

Cake\Database\Log\QueryLogger
экземпляр логгера

getSchemaCollection()source public

getSchemaCollection( )

Получает объект Schema\Collection для этого подключения.

Возвращает

Cake\Database\Schema\Collection

inTransaction()source public

inTransaction( )

Проверяет, запущена ли транзакция.

Возвращает

boolean
True, если транзакция запущена, иначе false.

insert()source public

insert( string $table , array $data , array $types = [] )

Выполняет запрос INSERT для указанной таблицы.

Параметры

строка $table

таблица для вставки значений

массив $data

значения для вставки

массив $types необязательно []

список ассоциативных массивов, содержащих типы для преобразования

Возвращает

Cake\Database\StatementInterface

isConnected()source public

isConnected( )

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

Возвращает

boolean

isSavePointsEnabled()source public

isSavePointsEnabled( )

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

Возвращает

boolean
true, если включено, иначе false

log()source public

log( string $sql )

Записывает строку запроса с использованием настроенного объекта логгера.

Параметры

строка $sql

строка для записи

logQueries()source public

logQueries( boolean|null $enable = null )

Включает или отключает протоколирование запросов для этого подключения.

Параметры

boolean|null $enable необязательно null

включить или отключить протоколирование. Использовать null для чтения текущего значения.

Возвращает

boolean

Реализация

Cake\Datasource\ConnectionInterface::logQueries()

logger()source public deprecated

logger( object|null $instance = null )

Устанавливает экземпляр объекта логгера. При вызове без аргументов возвращает текущий установленный экземпляр логгера.

Устарело

3.5.0 Используйте getLogger() и setLogger() вместо этого.

Параметры

объект|null $instance необязательно null

экземпляр объекта логгера

Возвращает

объект
экземпляр логгера

Реализация

Cake\Datasource\ConnectionInterface::logger()

newQuery()source public

newQuery( )

Создаёт новый экземпляр Query для этого подключения.

Возвращает

Cake\Database\Query

prepare()source public

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

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

Параметры

строка|Cake\Database\Query $sql

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

Возвращает

Cake\Database\StatementInterface

query()source public

query( string $sql )

Выполняет SQL-запрос и возвращает объект Statement в качестве результата.

Параметры

строка $sql

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

Возвращает

Cake\Database\StatementInterface

quote()source public

quote( mixed $value , string|null $type = null )

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

Параметры

смешанный $value

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

строка|null $type необязательно null

Тип для определения типа приведения

Возвращает

строка
Приведённое значение

quoteIdentifier()source public

quoteIdentifier( string $identifier )

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

Параметры

строка $identifier

Идентификатор для приведения к виду, безопасному для использования в запросах.

Возвращает

строка

releaseSavePoint()source public

releaseSavePoint( string $name )

Освобождает сохраняемую точку по её имени.

Параметры

строка $name

Имя сохраняемой точки.

rollback()source public

rollback( boolean|null $toBeginning = null )

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

Параметры

boolean|null $toBeginning необязательно null

Нужно ли откатить транзакцию до её начала. По умолчанию false, если используются сохраняемые точки, или true, если нет.

Возвращает

boolean

rollbackSavepoint()source public

rollbackSavepoint( string $name )

Откатывает сохраняемую точку по её имени.

Параметры

строка $name

Имя сохраняемой точки.

run()source public

run( Cake\Database\Query $query )

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

Параметры

Cake\Database\Query $query

Запрос для выполнения

Возвращает

Cake\Database\StatementInterface
исполненный запрос

schemaCollection()source public deprecated

schemaCollection( Cake\Database\Schema\Collection $collection = null )

Получает или устанавливает объект Schema\Collection для этого подключения.

Устарело

3.4.0 Используйте setSchemaCollection()/getSchemaCollection()

Параметры

Cake\Database\Schema\Collection $collection необязательно null

объект коллекции схемы

Возвращает

Cake\Database\Schema\Collection

setDriver()source public

setDriver( Cake\Database\Driver|string $driver , array $config = [] )

Устанавливает экземпляр драйвера. Если передается строка, она будет интерпретироваться как имя класса и будет создан его экземпляр.

Параметры

Cake\Database\Driver|string $driver

Экземпляр драйвера для использования.

array $config optional []

Настройка нового драйвера.

Возвращает

$this

Выбрасывает

Cake\Database\Exception\MissingDriverException
Если отсутствует класс драйвера.
Cake\Database\Exception\MissingExtensionException
Если отсутствует PHP-расширение драйвера.

setLogger()source public

setLogger( Cake\Database\Log\QueryLogger $logger )

Устанавливает логгер

Параметры

Cake\Database\Log\QueryLogger $logger

Объект логгера

Возвращает

$this

setSchemaCollection()source public

setSchemaCollection( Cake\Database\Schema\Collection $collection )

Устанавливает объект Schema\Collection для этого подключения.

Параметры

Cake\Database\Schema\Collection $collection

Объект схемы коллекции

Возвращает

$this

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

supportsQuoting()source public

supportsQuoting( )

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

Возвращает

boolean

transactional()source public

transactional( callable $callback )

Выполняет функцию обратного вызова внутри транзакции. Если во время выполнения переданного обратного вызова возникнет исключение, транзакция будет откачена. Если результат функции обратного вызова равен false, транзакция также будет откачена. В противном случае транзакция подтверждается после выполнения обратного вызова.

Пример:

$connection->transactional(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

Параметры

callable $callback

$transaction Обратный вызов для выполнения внутри транзакции.

Возвращает

mixed
Возвращаемое значение обратного вызова.

Выбрасывает

Exception

Перебросит любое исключение, возникшее в $callback, после отката транзакции.

Реализация

Cake\Datasource\ConnectionInterface::transactional()

update()source public

update( string $table , array $data , array $conditions = [] , array $types = [] )

Выполняет оператор UPDATE для указанной таблицы.

Параметры

string $table

таблица, из которой обновляются строки

array $data

значения для обновления

array $conditions optional []

условия для оператора UPDATE

array $types optional []

список ассоциативных массивов, содержащих типы для преобразования

Возвращает

Cake\Database\StatementInterface

useSavePoints()source public deprecated

useSavePoints( boolean|null $enable = null )

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

Если вы пытаетесь включить эту функцию, убедитесь, что проверяете возвращаемое значение этой функции, чтобы убедиться, что она была успешно включена.

Пример:

$connection->useSavePoints(true) Возвращает true, если драйвер поддерживает точки сохранения, иначе false $connection->useSavePoints(false) Отключает использование точек сохранения и возвращает false $connection->useSavePoints() Возвращает текущий статус

Deprecated

3.4.0 Используйте enableSavePoints()/isSavePointsEnabled() вместо этого.

Параметры

boolean|null $enable optional null

Использовать ли точки сохранения.

Возвращает

boolean
true, если включено, иначе false

wasNestedTransactionRolledback()source protected

wasNestedTransactionRolledback( )

Возвращает, была ли уже откачена какая-либо вложенная транзакция.

Возвращает

boolean

cast()source public

cast( mixed $value , Cake\Database\Type|string $type )

Преобразует заданное значение в подходящее значение базы данных в зависимости от типа и возвращает соответствующий внутренний тип оператора

Параметры

mixed $value

Значение для преобразования

Cake\Database\Type|string $type

Имя типа или экземпляр типа для использования.

Возвращает

array
Список, содержащий преобразованное значение и внутренний тип

matchTypes()source public

matchTypes( array $columns , array $types )

Сопоставляет столбцы с соответствующими типами

И $columns, и $types должны быть либо числовыми, либо строковыми ключами одновременно.

Параметры

array $columns

список или ассоциативный массив столбцов и параметров, которые нужно связать с типами

array $types

список или ассоциативный массив типов

Возвращает

array

false

false

false