Класс Postgres

connect()source public

connect( )

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

Возвращает

boolean
true при успехе

enabled()source public

enabled( )

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

Возвращает

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

setEncoding()source public

setEncoding( string $encoding )

Устанавливает кодировку соединения

Параметры

string $encoding

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

setSchema()source public

setSchema( string $schema )

Устанавливает схему по умолчанию для подключения. Если какая-либо таблица в запросе не указана полностью, Postgres будет искать её в заданной схеме по умолчанию

Параметры

string $schema

Имена схем для установки search_path в.

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

array $config optional []

Конфигурация для драйвера.

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__destruct()source public

__destruct( )

Деструктор

_connect()source protected

_connect( string $dsn , array $config )

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

Параметры

string $dsn

Драйвер-специфичный PDO-DSN

array $config

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

Возвращает

boolean
true при успехе

autoQuoting()source public deprecated

autoQuoting( boolean|null $enable = null )

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

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

Устарело

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

Параметры

boolean|null $enable optional 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

Используемый обработчик значений.

Возвращает

array

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

Реализация

Cake\Database\DriverInterface::compileQuery()

connection()source public deprecated

connection( mixed $connection = null )

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

Устарело

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

Параметры

mixed $connection optional null

Экземпляр PDO-соединения.

Возвращает

mixed
Внутренний объект соединения.

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

prepare()source public

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

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

Параметры

string|Cake\Database\Query $query

Запрос, который нужно преобразовать в подготовленный запрос.

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

Cake\Database\StatementInterface

Реализация

Cake\Database\DriverInterface::prepare()

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
Истина при успехе, ложь в противном случае.

Реализация

Cake\Database\DriverInterface::rollbackTransaction()

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

string $name

Имя таблицы.

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

string

Реализация

Cake\Database\DriverInterface::savePointSQL()

schema()source public

schema( )

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

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

string

Реализация

Cake\Database\DriverInterface::schema()

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

_expressionTranslators()source protected

_expressionTranslators( )

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

Возвращает

array

_insertQueryTranslator()source protected

_insertQueryTranslator( Cake\Database\Query $query )

Изменяет исходный запрос вставки, добавляя эпилог «RETURNING *», чтобы можно было получить последний идентификатор вставки.

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query

_transformDistinct()source protected

_transformDistinct( Cake\Database\Query $query )

Оператор DISTINCT не требует преобразования.

Параметры

Cake\Database\Query $query

Запрос, который нужно преобразовать.

Возвращает

Cake\Database\Query

_transformFunctionExpression()source protected

_transformFunctionExpression( Cake\Database\Expression\FunctionExpression $expression )

Принимает FunctionExpression и изменяет его так, чтобы он соответствовал этому диалекту SQL.

Параметры

Cake\Database\Expression\FunctionExpression $expression

Выражение функции, которое нужно преобразовать в SQL для PostgreSQL.

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

schemaDialect()source public

schemaDialect( )

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

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

Возвращает

Cake\Database\Schema\PostgresSchema

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