Класс Postgres

connect()source public

connect( )

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

Возвращает

boolean
true при успехе

enabled()source public

enabled( )

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

Возвращает

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

setEncoding()source public

setEncoding( string $encoding )

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

Параметры

строка $encoding

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

setSchema()source public

setSchema( string $schema )

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

Параметры

строка $schema

Имя схемы, которое нужно установить search_path.

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

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

Возвращает

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

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

Выбрасывает

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 необязательно 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

Объект подключения

Возвращает

PDO

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

Возвращает

строка

disconnect()source abstract public

disconnect( )

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

enableAutoQuoting()source public

enableAutoQuoting( boolean $enable true )

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

Параметры

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

Включить автоматическую цитирование

Возвращает

$this

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

Возвращает

строка

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

prepare()source abstract public

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

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

Параметры

string|Cake\Database\Query $query

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

Возвращает

Cake\Database\StatementInterface

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

savePointSQL()source abstract public

savePointSQL( string $name )

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

Параметры

string $name

Имя таблицы

Возвращает

string

schema()source public

schema( )

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

Возвращает

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 в противном случае

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

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

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

prepare()source public

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

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

Параметры

string|Cake\Database\Query $query

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

Возвращает

Cake\Database\StatementInterface

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

_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 для Postgres.

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