Класс Postgres
Представляет драйвер базы данных, содержащий все особенности движка базы данных, включая его диалект SQL.
- Cake\Database\Driver
-
Cake\Database\Driver\Postgres использует Cake\Database\Driver\PDODriverTrait , Cake\Database\Dialect\PostgresDialectTrait
Краткое описание свойств
-
$_baseConfigprotectedОсновные параметры конфигурации для драйвера Postgresarray
Наследуемые магические свойства
Наследуемые свойства
-
_autoQuoting,_config_connection_endQuote,_schemaDialect,_startQuote
Краткое описание методов
- connect() publicУстанавливает соединение с сервером базы данных
- enabled() publicВозвращает, может ли php использовать этот драйвер для подключения к базе данных
- setEncoding() publicУстанавливает кодировку соединения
- setSchema() public
Устанавливает схему по умолчанию для соединения. Если в запросе определено отношение без полного квалификатора, postgres попытается найти отношение в заданной схеме по умолчанию
- supportsDynamicConstraints() public
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Подробное описание методов
connect()source public
connect( )
Устанавливает соединение с сервером базы данных
Возвращает
booleantrue при успехе
enabled()source public
enabled( )
Возвращает, может ли php использовать этот драйвер для подключения к базе данных
Возвращает
booleantrue, если этот драйвер может быть использован
setEncoding()source public
setEncoding( string $encoding )
Устанавливает кодировку соединения
Параметры
- string
$encoding - Используемая кодировка.
setSchema()source public
setSchema( string $schema )
Устанавливает схему по умолчанию для соединения. Если в запросе определено отношение без полного квалификатора, postgres попытается найти отношение в заданной схеме по умолчанию
Параметры
- string
$schema - Имя схемы, которое нужно установить
search_path.
supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения
Методы, унаследованные от Cake\Database\Driver
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- array
$configoptional [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
arrayautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, должен ли этот драйвер автоматически заключать идентификаторы в запросы
Если вызвана с логическим аргументом, она переключит авто-квотирование на переданное значение.
Устарело
3.4.0 использовать enableAutoQuoting()/isAutoQuotingEnabled() вместо этого.Параметры
- boolean|null
$enableoptional null - Включить авто-квотирование
Возвращает
booleanbeginTransaction()source abstract public
beginTransaction( )
Начинает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
commitTransaction()source abstract public
commitTransaction( )
Подтверждает транзакцию
Возвращает
booleantrue при успехе, 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
$connectionoptional null - Объект подключения
Возвращает
PDOdisableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получить SQL для отключения внешних ключей
Возвращает
stringenableAutoQuoting()source public
enableAutoQuoting( boolean $enable true )
Устанавливает, должен ли этот драйвер автоматически заключать идентификаторы в запросы.
Параметры
- boolean
$enableoptional true - Включить авто-квотирование
Возвращает
$this
enableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получить SQL для включения внешних ключей
Возвращает
stringisAutoQuotingEnabled()source public
isAutoQuotingEnabled( )
Возвращает, следует ли данному драйверу автоматически заключать идентификаторы в кавычки в запросах
Возвращает
booleanlastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableнеобязательный null - имя таблицы или последовательности, для получения последнего вставленного значения
- string|null
$columnнеобязательный null - имя столбца, представляющего первичный ключ
Возвращает
string|integernewCompiler()source public
newCompiler( )
Возвращает экземпляр QueryCompiler
Возвращает
Cake\Database\QueryCompilerprepare()source abstract public
prepare( string|Cake\Database\Query $query )
Подготавливает SQL-запрос к выполнению
Параметры
- string|
Cake\Database\Query$query - Запрос для преобразования в оператор.
Возвращает
Cake\Database\StatementInterfacequeryTranslator()source abstract public
queryTranslator( string $type )
Возвращает вызываемую функцию, которая будет использоваться для преобразования переданного объекта Query. Эта функция, в свою очередь, вернёт экземпляр объекта Query, который был преобразован для соответствия особенностям используемого диалекта SQL.
Параметры
- string
$type тип запроса, который должен быть преобразован (select, insert, update, delete)
Возвращает
callablequote()source abstract public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение, которое нужно заключить в кавычки.
- string
$type - Тип, используемый для определения вида заключаемых в кавычки
Возвращает
stringquoteIdentifier()source abstract public
quoteIdentifier( string $identifier )
Заключает в кавычки идентификатор базы данных (имя столбца, имя таблицы и т. д.) для безопасного использования в запросах без риска использования зарезервированных слов
Параметры
- string
$identifier - Выражение идентификатора, которое нужно заключить в кавычки.
Возвращает
stringreleaseSavePointSQL()source abstract public
releaseSavePointSQL( string $name )
Получить SQL для освобождения точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringrollbackSavePointSQL()source abstract public
rollbackSavePointSQL( string $name )
Получить SQL для отката точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringrollbackTransaction()source abstract public
rollbackTransaction( )
Откатывает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
savePointSQL()source abstract public
savePointSQL( string $name )
Получить SQL для создания точки сохранения.
Параметры
- string
$name - Имя таблицы
Возвращает
stringschema()source public
schema( )
Возвращает имя схемы, используемой в данный момент
Возвращает
stringschemaDialect()source abstract public
schemaDialect( )
Получить диалект схемы.
Используется пакетом Cake\Database\Schema для отражения схемы и генерации схемы.
Если все таблицы, использующие этот драйвер, указывают свои собственные схемы, то это может вернуть null.
Возвращает
Cake\Database\Schema\BaseSchemaschemaValue()source public
schemaValue( mixed $value )
Экранирует значения для использования в определениях схемы.
Параметры
- mixed
$value - Значение, которое нужно экранировать.
Возвращает
stringСтрока для использования в определениях схемы.
supportsQuoting()source public
supportsQuoting( )
Проверяет, поддерживает ли драйвер заключение в кавычки
Возвращает
booleansupportsSavePoints()source public
supportsSavePoints( )
Возвращает, поддерживает ли этот драйвер точки сохранения для вложенных транзакций
Возвращает
booleantrue, если точки сохранения поддерживаются, false в противном случае
Методы, используемые из Cake\Database\Driver\PDODriverTrait
_connect()source protected
_connect( string $dsn , array $config )
Устанавливает соединение с сервером базы данных
Параметры
- string
$dsn - Уникальный для драйвера PDO-DSN
- array
$config - конфигурация, используемая для создания соединения
Возвращает
booleantrue при успехе
beginTransaction()source public
beginTransaction( )
Начинает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
commitTransaction()source public
commitTransaction( )
Завершает транзакцию
Возвращает
booleantrue при успехе, false в противном случае
connection()source public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект соединения, используемый во внутренней работе. Если первый аргумент передан, он установит внутренний объект соединения или результат на переданное значение.
Параметры
- null|PDO
$connectionнеобязательный null - Экземпляр соединения PDO.
Возвращает
PDOобъект соединения, используемый во внутренней работе
lastInsertId()source public
lastInsertId( string|null $table null , string|null $column null )
Возвращает последний сгенерированный идентификатор для таблицы или последовательности в базе данных
Параметры
- string|null
$tableнеобязательно null - Имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnнеобязательно null - Имя столбца, представляющего первичный ключ
Возвращает
string|integerprepare()source public
prepare( string|Cake\Database\Query $query )
Подготавливает SQL-запрос для выполнения
Параметры
- string|
Cake\Database\Query$query - Запрос, который нужно преобразовать в подготовленный запрос.
Возвращает
Cake\Database\StatementInterfacequote()source public
quote( mixed $value , string $type )
Возвращает значение в безопасном представлении для использования в строке запроса
Параметры
- mixed
$value - Значение, которое нужно обрамить кавычками.
- string
$type - Тип, используемый для определения вида обрамления
Возвращает
stringrollbackTransaction()source public
rollbackTransaction( )
Откат транзакции
Возвращает
booleantrue при успехе, 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 Выражение функции для преобразования в SQL Postgres.
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.4/class-Cake.Database.Driver.Postgres.html