Class Postgres
Property Summary
-
$_autoQuoting protected
boolIndicates whether or not the driver is doing automatic identifier quoting for all queries
-
$_baseConfig protected
arrayBase configuration settings for Postgres driver
-
$_config protected
arrayConfiguration data.
-
$_connection protected
PDOInstance of PDO.
-
$_endQuote protected
stringString used to end a database identifier quoting to make it safe
-
$_schemaDialect protected
Cake\Database\Schema\PostgresSchemaThe schema dialect class for this driver
-
$_startQuote protected
stringString used to start a database identifier quoting to make it safe
Method Summary
-
__construct() public
Constructor
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__destruct() public
Destructor
-
_connect() protected
Establishes a connection to the database server
-
_deleteQueryTranslator() protected
Apply translation steps to delete queries.
-
_expressionTranslators() protected
Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
-
_insertQueryTranslator() protected
Modifies the original insert query to append a "RETURNING *" epilogue so that the latest insert id can be retrieved
-
_selectQueryTranslator() protected
Apply translation steps to select queries.
-
_transformDistinct() protected
Distinct clause needs no transformation
-
_transformFunctionExpression() protected
Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
-
_updateQueryTranslator() protected
Apply translation steps to update queries.
-
autoQuoting() public
Returns whether or not this driver should automatically quote identifiers in queries
-
beginTransaction() public
Starts a transaction
-
commitTransaction() public
Commits a transaction
-
compileQuery() public
Transforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string
-
connect() public
Establishes a connection to the database server
-
connection() public
Returns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed
-
disableForeignKeySQL() public
Get the SQL for disabling foreign keys
-
disconnect() public
Disconnects from database server
-
enableForeignKeySQL() public
Get the SQL for enabling foreign keys
-
enabled() public
Returns whether php is able to use this driver for connecting to database
-
isConnected() public
Check whether or not the driver is connected.
-
lastInsertId() public
Returns last id generated for a table or sequence in database
-
newCompiler() public
Returns an instance of a QueryCompiler
-
prepare() public
Prepares a sql statement to be executed
-
queryTranslator() public
Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
-
quote() public
Returns a value in a safe representation to be used in a query string
-
quoteIdentifier() public
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words
-
releaseSavePointSQL() public
Returns a SQL snippet for releasing a previously created save point
-
rollbackSavePointSQL() public
Returns a SQL snippet for rollbacking a previously created save point
-
rollbackTransaction() public
Rollback a transaction
-
savePointSQL() public
Returns a SQL snippet for creating a new transaction savepoint
-
schemaDialect() public
Get the schema dialect.
-
schemaValue() public
Escapes values for use in schema definitions.
-
setEncoding() public
Sets connection encoding
-
setSchema() public
Sets connection default schema, if any relation defined in a query is not fully qualified postgres will fallback to looking the relation into defined default schema
-
supportsDynamicConstraints() public
Returns whether the driver supports adding or dropping constraints to already created tables.
-
supportsQuoting() public
Checks if the driver supports quoting, as PDO_ODBC does not support it.
-
supportsSavePoints() public
Returns whether this driver supports save points for nested transactions
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor
Parameters
-
array$config optional The configuration for the driver.
Throws
InvalidArgumentException__debugInfo() ¶ public
__debugInfo(): arrayReturns an array that can be used to describe the internal state of this object.
Returns
array_connect() ¶ protected
_connect(string $dsn, array $config): boolEstablishes a connection to the database server
Parameters
-
string$dsn A Driver-specific PDO-DSN
-
array$config configuration to be used for creating connection
Returns
bool_deleteQueryTranslator() ¶ protected
_deleteQueryTranslator(Cake\Database\Query $query): Cake\Database\QueryApply translation steps to delete queries.
Chops out aliases on delete query conditions as most database dialects do not support aliases in delete queries. This also removes aliases in table names as they frequently don't work either.
We are intentionally not supporting deletes with joins as they have even poorer support.
Parameters
-
Cake\Database\Query$query The query to translate
Returns
Cake\Database\Query_expressionTranslators() ¶ protected
_expressionTranslators(): arrayReturns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
Returns
array_insertQueryTranslator() ¶ protected
_insertQueryTranslator(Cake\Database\Query $query): Cake\Database\QueryModifies the original insert query to append a "RETURNING *" epilogue so that the latest insert id can be retrieved
Parameters
-
Cake\Database\Query$query The query to translate.
Returns
Cake\Database\Query_selectQueryTranslator() ¶ protected
_selectQueryTranslator(Cake\Database\Query $query): Cake\Database\QueryApply translation steps to select queries.
Parameters
-
Cake\Database\Query$query The query to translate
Returns
Cake\Database\Query_transformDistinct() ¶ protected
_transformDistinct(Cake\Database\Query $query): Cake\Database\QueryDistinct clause needs no transformation
Parameters
-
Cake\Database\Query$query The query to be transformed
Returns
Cake\Database\Query_transformFunctionExpression() ¶ protected
_transformFunctionExpression(Cake\Database\Expression\FunctionExpression $expression): voidReceives a FunctionExpression and changes it so that it conforms to this SQL dialect.
Parameters
-
Cake\Database\Expression\FunctionExpression$expression The function expression to convert to postgres SQL.
Returns
void_updateQueryTranslator() ¶ protected
_updateQueryTranslator(Cake\Database\Query $query): Cake\Database\QueryApply translation steps to update queries.
Parameters
-
Cake\Database\Query$query The query to translate
Returns
Cake\Database\QueryautoQuoting() ¶ public
autoQuoting(bool|null $enable = null): boolReturns whether or not this driver should automatically quote identifiers in queries
If called with a boolean argument, it will toggle the auto quoting setting to the passed value
Parameters
-
bool|null$enable optional whether to enable auto quoting
Returns
boolcompileQuery() ¶ public
compileQuery(Cake\Database\Query $query, Cake\Database\ValueBinder $generator): arrayTransforms the passed query to this Driver's dialect and returns an instance of the transformed query and the full compiled SQL string
Parameters
-
Cake\Database\Query$query The query to compile.
-
Cake\Database\ValueBinder$generator The value binder to use.
Returns
arrayconnection() ¶ public
connection(nullPDO $connection = null): PDOReturns correct connection resource or object that is internally used If first argument is passed, it will set internal connection object or result to the value passed
Parameters
-
nullPDO$connection optional The PDO connection instance.
Returns
PDOdisableForeignKeySQL() ¶ public
disableForeignKeySQL(): stringGet the SQL for disabling foreign keys
Returns
stringenableForeignKeySQL() ¶ public
enableForeignKeySQL(): stringGet the SQL for enabling foreign keys
Returns
stringenabled() ¶ public
enabled(): boolReturns whether php is able to use this driver for connecting to database
Returns
boolisConnected() ¶ public
isConnected(): boolCheck whether or not the driver is connected.
Returns
boollastInsertId() ¶ public
lastInsertId(string|null $table = null, string|null $column = null): string|intReturns last id generated for a table or sequence in database
Parameters
-
string|null$table optional table name or sequence to get last insert value from
-
string|null$column optional the name of the column representing the primary key
Returns
string|intnewCompiler() ¶ public
newCompiler(): Cake\Database\QueryCompilerReturns an instance of a QueryCompiler
Returns
Cake\Database\QueryCompilerprepare() ¶ public
prepare(stringCake\Database\Query $query): Cake\Database\StatementInterfacePrepares a sql statement to be executed
Parameters
-
stringCake\Database\Query$query The query to turn into a prepared statement.
Returns
Cake\Database\StatementInterfacequeryTranslator() ¶ public
queryTranslator(string $type): callableReturns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
Parameters
-
string$type the type of query to be transformed (select, insert, update, delete)
Returns
callablequote() ¶ public
quote(mixed $value, string $type): stringReturns a value in a safe representation to be used in a query string
Parameters
-
mixed$value The value to quote.
-
string$type Type to be used for determining kind of quoting to perform
Returns
stringquoteIdentifier() ¶ public
quoteIdentifier(string $identifier): stringQuotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words
Parameters
-
string$identifier The identifier to quote.
Returns
stringreleaseSavePointSQL() ¶ public
releaseSavePointSQL(string $name): stringReturns a SQL snippet for releasing a previously created save point
Parameters
-
string$name save point name
Returns
stringrollbackSavePointSQL() ¶ public
rollbackSavePointSQL(string $name): stringReturns a SQL snippet for rollbacking a previously created save point
Parameters
-
string$name save point name
Returns
stringsavePointSQL() ¶ public
savePointSQL(string $name): stringReturns a SQL snippet for creating a new transaction savepoint
Parameters
-
string$name save point name
Returns
stringschemaDialect() ¶ public
schemaDialect(): Cake\Database\Schema\PostgresSchemaGet the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
Returns
Cake\Database\Schema\PostgresSchemaschemaValue() ¶ public
schemaValue(mixed $value): stringEscapes values for use in schema definitions.
Parameters
-
mixed$value The value to escape.
Returns
stringsetEncoding() ¶ public
setEncoding(string $encoding): voidSets connection encoding
Parameters
-
string$encoding The encoding to use.
Returns
voidsetSchema() ¶ public
setSchema(string $schema): voidSets connection default schema, if any relation defined in a query is not fully qualified postgres will fallback to looking the relation into defined default schema
Parameters
-
string$schema The schema names to set
search_pathto.
Returns
voidsupportsDynamicConstraints() ¶ public
supportsDynamicConstraints(): boolReturns whether the driver supports adding or dropping constraints to already created tables.
Returns
boolsupportsQuoting() ¶ public
supportsQuoting(): boolChecks if the driver supports quoting, as PDO_ODBC does not support it.
Returns
boolsupportsSavePoints() ¶ public
supportsSavePoints(): boolReturns whether this driver supports save points for nested transactions
Returns
boolProperty Detail
$_autoQuoting ¶ protected
Indicates whether or not the driver is doing automatic identifier quoting for all queries
Type
bool$_schemaDialect ¶ protected
The schema dialect class for this driver
Type
Cake\Database\Schema\PostgresSchema$_startQuote ¶ protected
String used to start a database identifier quoting to make it safe
Type
string