Класс 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 )
Устанавливает кодировку подключения
Параметры
- строка
$encoding - Используемая кодировка.
setSchema()source public
setSchema( string $schema )
Устанавливает схему по умолчанию для подключения. Если какое-либо отношение, определённое в запросе, не является полностью квалифицированным, Postgres будет искать отношение в заданной схеме по умолчанию
Параметры
- строка
$schema - Имя схемы, которое необходимо установить
search_path.
supportsDynamicConstraints()source public
supportsDynamicConstraints( )
Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.
Возвращает
booleantrue, если драйвер поддерживает динамические ограничения
Методы, унаследованные от Cake\Database\Driver
__construct()source public
__construct( array $config [] )
Конструктор
Параметры
- массив
$configнеобязательно [] - Конфигурация для драйвера.
Исключения
InvalidArgumentException__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массивautoQuoting()source public
autoQuoting( boolean|null $enable null )
Возвращает, следует ли данному драйверу автоматически заключать идентификаторы в запросах
Если вызвана с логическим аргументом, она переключает настройку автоматического заключения в указанное значение
Параметры
- boolean|null
$enableнеобязательно 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 - Используемый обработчик значений.
Возвращает
массивсодержащий 2 элемента. Первый элемент — преобразованный запрос, а второй — скомпилированная строка SQL
connection()source abstract public
connection( null|PDO $connection null )
Возвращает правильный ресурс или объект подключения, который используется внутри. Если передан первый аргумент,
Параметры
- null|PDO
$connectionнеобязательно null - Объект подключения
disableForeignKeySQL()source abstract public
disableForeignKeySQL( )
Получение SQL для отключения внешних ключей
Возвращает
строкаenableForeignKeySQL()source abstract public
enableForeignKeySQL( )
Получение SQL для включения внешних ключей
Возвращает
строкаlastInsertId()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 - Имя таблицы
Возвращает
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 array
Основные параметры конфигурации для драйвера Postgres
[
'persistent' => true,
'host' => 'localhost',
'username' => 'root',
'password' => '',
'database' => 'cake',
'schema' => 'public',
'port' => 5432,
'encoding' => 'utf8',
'timezone' => null,
'flags' => [],
'init' => [],
]
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Database.Driver.Postgres.html