Класс Postgres

connectsource public

connect( )

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

Возвращает

boolean
true при успехе

enabledsource public

enabled( )

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

Возвращает

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

setEncodingsource public

setEncoding( string $encoding )

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

Параметры

строка $encoding

Кодировка для использования.

setSchemasource public

setSchema( string $schema )

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

Параметры

строка $schema

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

supportsDynamicConstraintssource public

supportsDynamicConstraints( )

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

Возвращает

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

__constructsource public

__construct( array $config [] )

Конструктор

Параметры

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

Настройка для драйвера.

Исключения

InvalidArgumentException
InvalidArgumentException

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__destructsource public

__destruct( )

Деструктор

autoQuotingsource public

autoQuoting( boolean $enable null )

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

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

Параметры

булево $enable необязательно null

включить автоцитирование

Возвращает

boolean
bool

beginTransactionsource abstract public

beginTransaction( )

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

Возвращает

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

commitTransactionsource abstract public

commitTransaction( )

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

Возвращает

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

compileQuerysource public

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

Преобразует переданный запрос в диалект этого драйвера и возвращает экземпляр преобразованного запроса и полную скомпилированную строку SQL

Параметры

Cake\Database\Query $query

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

Cake\Database\ValueBinder $generator

Используемый связующий элемент значений.

Возвращает

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

connectionsource abstract public

connection( null|PDO $connection null )

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

Параметры

null|PDO $connection необязательно null

Объект соединения

disableForeignKeySQLsource abstract public

disableForeignKeySQL( )

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

Возвращает

string
строка

disconnectsource abstract public

disconnect( )

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

enableForeignKeySQLsource abstract public

enableForeignKeySQL( )

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

Возвращает

string
строка

isConnectedsource public

isConnected( )

Проверяет, подключен ли драйвер.

Возвращает

boolean
bool

lastInsertIdsource public

lastInsertId( string $table null , string $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

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

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

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

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

Возвращает

string|integer
строка|целое число

newCompilersource public

newCompiler( )

Возвращает экземпляр QueryCompiler

Возвращает

Cake\Database\QueryCompiler
\Cake\Database\QueryCompiler

preparesource abstract public

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

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

Параметры

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

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

queryTranslatorsource abstract public

queryTranslator( string $type )

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

Параметры

string $type

тип запроса, подлежащего преобразованию (select, insert, update, delete)

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

callable
callable

quotesource abstract public

quote( mixed $value , string $type )

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

Параметры

mixed $value

Значение для форматирования.

string $type

Тип, используемый для определения вида форматирования

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

string
string

quoteIdentifiersource abstract public

quoteIdentifier( string $identifier )

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

Параметры

string $identifier

Выражение идентификатора для форматирования.

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

string
string

releaseSavePointSQLsource abstract public

releaseSavePointSQL( string $name )

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

Параметры

string $name

Имя таблицы

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

string
string

rollbackSavePointSQLsource abstract public

rollbackSavePointSQL( string $name )

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

Параметры

string $name

Имя таблицы

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

string
string

rollbackTransactionsource abstract public

rollbackTransaction( )

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

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

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

savePointSQLsource abstract public

savePointSQL( string $name )

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

Параметры

string $name

Имя таблицы

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

string
string

schemaDialectsource abstract public

schemaDialect( )

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

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

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

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

Cake\Database\Schema\BaseSchema
\Cake\Database\Schema\BaseSchema

schemaValuesource public

schemaValue( mixed $value )

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

Параметры

mixed $value

Значение для экранирования.

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

string
Строка для использования в определениях схемы.

supportsQuotingsource public

supportsQuoting( )

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

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

boolean
bool

supportsSavePointssource public

supportsSavePoints( )

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

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

boolean
true, если точки сохранения поддерживаются, false в противном случае

_connectsource protected

_connect( string $dsn , array $config )

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

Параметры

string $dsn

Спецификация DSN драйвера PDO

array $config

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

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

boolean
true в случае успеха

beginTransactionsource public

beginTransaction( )

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

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

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

commitTransactionsource public

commitTransaction( )

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

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

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

connectionsource public

connection( null|PDO $connection null )

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

Параметры

null|PDO $connection optional null

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

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

PDO
внутренний объект соединения

disconnectsource public

disconnect( )

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

isConnectedsource public

isConnected( )

Проверяет, подключен ли драйвер.

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

boolean
bool

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

Cake\Database\Driver::isConnected()

lastInsertIdsource public

lastInsertId( string|null $table null , string|null $column null )

Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных

Параметры

string|null $table optional null

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

string|null $column optional null

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

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

string|integer
string|int

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

Cake\Database\Driver::lastInsertId()

preparesource public

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

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

Параметры

string|Cake\Database\Query $query

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

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

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

quotesource public

quote( mixed $value , string $type )

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

Параметры

mixed $value

Значение для форматирования.

string $type

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

Возвращает

string
строка

rollbackTransactionsource public

rollbackTransaction( )

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

Возвращает

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

supportsQuotingsource public

supportsQuoting( )

Проверяет, поддерживает ли драйвер форматирование, так как PDO_ODBC его не поддерживает.

Возвращает

boolean
bool

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

Cake\Database\Driver::supportsQuoting()

_expressionTranslatorssource protected

_expressionTranslators( )

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

Возвращает

array
массив

_insertQueryTranslatorsource protected

_insertQueryTranslator( Cake\Database\Query $query )

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

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query
\Cake\Database\Query

_transformDistinctsource protected

_transformDistinct( Cake\Database\Query $query )

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

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query
\Cake\Database\Query

_transformFunctionExpressionsource protected

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

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

Параметры

Cake\Database\Driver\FunctionExpression $expression

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

disableForeignKeySQLsource public

disableForeignKeySQL( )

enableForeignKeySQLsource public

enableForeignKeySQL( )

schemaDialectsource public

schemaDialect( )

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

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

Возвращает

Cake\Database\Schema\PostgresSchema
\Cake\Database\Schema\PostgresSchema

_deleteQueryTranslatorsource protected

_deleteQueryTranslator( Cake\Database\Query $query )

Применить шаги преобразования к запросам удаления.

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

Мы намеренно не поддерживаем удаления с объединениями, так как они имеют еще худшую поддержку.

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query
Изменённый запрос

_selectQueryTranslatorsource protected

_selectQueryTranslator( Cake\Database\Query $query )

Применить шаги преобразования к запросам выбора.

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query
Изменённый запрос

_updateQueryTranslatorsource protected

_updateQueryTranslator( Cake\Database\Query $query )

Применить шаги преобразования к запросам обновления.

Параметры

Cake\Database\Query $query

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

Возвращает

Cake\Database\Query
Изменённый запрос

queryTranslatorsource public

queryTranslator( string $type )

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

Параметры

string $type

тип запроса для преобразования (выбор, вставка, обновление, удаление)

Возвращает

callable
вызываемая функция

quoteIdentifiersource public

quoteIdentifier( string $identifier )

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

Параметры

string $identifier

Идентификатор для форматирования.

Возвращает

string
строка

releaseSavePointSQLsource public

releaseSavePointSQL( string $name )

Возвращает фрагмент SQL для освобождения ранее созданной точки сохранения

Параметры

string $name

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

Возвращает

string
строка

rollbackSavePointSQLsource public

rollbackSavePointSQL( string $name )

Возвращает фрагмент SQL для откатывания ранее созданной точки сохранения

Параметры

string $name

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

Возвращает

string
строка

savePointSQLsource public

savePointSQL( string $name )

Возвращает фрагмент SQL для создания новой точки сохранения транзакции

Параметры

string $name

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

Возвращает

string
строка

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

false

'"'

'"'