Spec-Zone.ru › CakePHP 3.3

Класс Postgres

Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL

Cake\Database\Driver
Расширяется Cake\Database\Driver\Postgres использует Cake\Database\Driver\PDODriverTrait , Cake\Database\Dialect\PostgresDialectTrait
Пространство имён: Cake\Database\Driver
Расположение: Database/Driver/Postgres.php

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

  • $_baseConfig protected
    array
    Базовые параметры конфигурации для драйвера Postgres

Наследованные свойства

  • _autoQuoting, _config _connection _endQuote, _schemaDialect, _startQuote

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

  • connect() public
    Устанавливает подключение к серверу базы данных
  • enabled() public
    Возвращает, может ли PHP использовать этот драйвер для подключения к базе данных
  • setEncoding() public
    Устанавливает кодировку подключения
  • setSchema() public

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

  • supportsDynamicConstraints() public

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

Подробное описание методов

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, если драйвер поддерживает динамические ограничения

Наследованные методы из Cake\Database\Driver

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

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

Исключения

InvalidArgumentException

__debugInfo()source public

__debugInfo( )

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

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

массив

__destruct()source public

__destruct( )

Деструктор

autoQuoting()source public

autoQuoting( boolean|null $enable null )

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

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

Параметры

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
Используемый менеджер значений.

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

массив

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


connection()source abstract public

connection( null|PDO $connection null )

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

Параметры

null|PDO $connection необязательно null
Объект соединения

disableForeignKeySQL()source abstract public

disableForeignKeySQL( )

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

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

строка

disconnect()source abstract public

disconnect( )

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

enableForeignKeySQL()source abstract public

enableForeignKeySQL( )

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

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

строка

isConnected()source public

isConnected( )

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

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

boolean
END_OF_DOCUMENT_MARKER

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

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

Методы, используемые из Cake\Database\Driver\PDODriverTrait

_connect()source protected

_connect( string $dsn , array $config )

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

Параметры

string $dsn
Драйвер-специфический PDO-DSN
array $config
Настройка, используемая для создания соединения

Возвращает

boolean
Истина при успехе

beginTransaction()source public

beginTransaction( )

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

Возвращает

boolean
Истина при успехе, ложь в противном случае

commitTransaction()source public

commitTransaction( )

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

Возвращает

boolean
Истина при успехе, ложь в противном случае

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

Методы, используемые из Cake\Database\Dialect\PostgresDialectTrait

_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

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

disableForeignKeySQL()source public

disableForeignKeySQL( )

enableForeignKeySQL()source public

enableForeignKeySQL( )

schemaDialect()source public

schemaDialect( )

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

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

Возвращает

Cake\Database\Schema\PostgresSchema

Подробное описание свойств

$_baseConfigsource

protected массив

Основные параметры конфигурации для драйвера Postgres

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

© 2005–2017 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.3/class-Cake.Database.Driver.Postgres.html

Spec-Zone.ru

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