Class QPostgreSqlDatabase

PostgreSQL database adapter.

To allow QCubed to determine the identity column in a PostgreSQL table (and because a table may have more than one column generated by the SERIAL "data type"), this adapter assumes that if the first column (ordinal position 1) was created as SERIAL, it is the identity column. Otherwise, no identity column will be set for that table.

QBaseClass

QDatabaseBase

QPostgreSqlDatabase

Package: DatabaseAdapters
Located at includes/database/QPostgreSqlDatabase.class.php

Methods summary
`public string`	# `SqlVariable( mixed $mixData, boolean $blnIncludeEquality = false, boolean $blnReverseEquality = false )` Properly escapes $mixData to be used as a SQL query parameter. If IncludeEquality is set (usually not), then include an equality operator. So for most data, it would just be "=". But, for example, if $mixData is NULL, then most RDBMS's require the use of "IS". Properly escapes $mixData to be used as a SQL query parameter. If IncludeEquality is set (usually not), then include an equality operator. So for most data, it would just be "=". But, for example, if $mixData is NULL, then most RDBMS's require the use of "IS". Parameters `$mixData` `$blnIncludeEquality` whether or not to include an equality operator `$blnReverseEquality` whether the included equality operator should be a "NOT EQUAL", e.g. "!=" Returns string the properly formatted SQL variable Overrides `QDatabaseBase::SqlVariable()`
`public`	# `SqlLimitVariablePrefix( $strLimitInfo )`
`public`	# `SqlLimitVariableSuffix( $strLimitInfo )`
`public`	# `SqlSortByVariable( $strSortByInfo )`
`public`	# `InsertOrUpdate( string $strTable, array $mixColumnsAndValuesArray, null\|string\|array $strPKNames = null )` INSERTs or UPDATEs a table INSERTs or UPDATEs a table Parameters `$strTable` Table name `$mixColumnsAndValuesArray` column=>value array (they are given to 'EscapeIdentifiersAndValues' method) `$strPKNames` Name(s) of primary key column(s) (expressed as string or array) Overrides `QDatabaseBase::InsertOrUpdate()`
`public`	# `Connect( )` Connects to the database Connects to the database Throws `QPostgreSqlDatabaseException`
`public mixed`	# `__get( string $strName )` PHP magic method PHP magic method Parameters `$strName` Property name Returns mixed Throws Exception\|`QCallerException` Overrides `QDatabaseBase::__get()`
`protected mixed`	# `ExecuteQuery( string $strQuery )` Sends a SQL query for execution to the database In this regard, a query is a 'SELECT' statement Sends a SQL query for execution to the database In this regard, a query is a 'SELECT' statement Parameters `$strQuery` The Query to be executed Returns mixed Result that the database returns after running the query.
`protected mixed`	# `ExecuteNonQuery( string $strNonQuery )` Sends a non-SELECT query (such as INSERT, UPDATE, DELETE, TRUNCATE) to DB server. In most cases, the results of this function are not used and you should not send 'SELECT' queries using this method because a result is not guaranteed to be returned Sends a non-SELECT query (such as INSERT, UPDATE, DELETE, TRUNCATE) to DB server. In most cases, the results of this function are not used and you should not send 'SELECT' queries using this method because a result is not guaranteed to be returned If there was an error, it would most probably be caught as an exception. Parameters `$strNonQuery` The Query to be executed Returns mixed Result that the database returns after running the query
`public array`	# `GetTables( )` Returns the list of tables in the database as string Returns the list of tables in the database as string Returns array List of tables in the database as string
`public mixed`	# `GetFieldsForTable( string $strTableName )` Get the list of columns/fields for a given table Get the list of columns/fields for a given table Parameters `$strTableName` Name of table whose fields we have to get Returns mixed
`public mixed`	# `InsertId( null\|string $strTableName = null, null\|string $strColumnName = null )` Returns the ID to be inserted in a table column (normally it an autoincrement column) Returns the ID to be inserted in a table column (normally it an autoincrement column) Parameters `$strTableName` Table name where the ID has to be inserted `$strColumnName` Column name where the ID has to be inserted Returns mixed
`public mixed`	# `Close( )` Closes the database connection Closes the database connection Returns mixed
`protected`	# `ExecuteTransactionBegin( )` Sends the 'BEGIN' command to the PostgreSQL server to start a transaction Sends the 'BEGIN' command to the PostgreSQL server to start a transaction Returns Nothing
`protected`	# `ExecuteTransactionCommit( )` Sends the 'COMMIT' command to the PostgreSQL server to commit/end a transaction Sends the 'COMMIT' command to the PostgreSQL server to commit/end a transaction Returns Nothing
`protected`	# `ExecuteTransactionRollBack( )` Sends the 'ROLLBACK' command to the PostgreSQL server to revert a transaction Sends the 'ROLLBACK' command to the PostgreSQL server to revert a transaction Returns Nothing
`public mixed`	# `GetIndexesForTable( string $strTableName )` Get list of indexes for a table Get list of indexes for a table Parameters `$strTableName` Name of table whose column indexes we have to get Returns mixed
`public mixed`	# `GetForeignKeysForTable( string $strTableName )` Get list of foreign keys for a table Get list of foreign keys for a table Parameters `$strTableName` Name of table whose foreign keys we are trying to get Returns mixed
`public null`	# `ExplainStatement( $sql )` Executes the explain statement for a given query and returns the output without any transformation. If the database adapter does not support EXPLAIN statements, returns null. Executes the explain statement for a given query and returns the output without any transformation. If the database adapter does not support EXPLAIN statements, returns null. Parameters `$sql` Returns null Overrides `QDatabaseBase::ExplainStatement()`

Methods inherited from QDatabaseBase
`EnableProfiling(), EscapeIdentifier(), EscapeIdentifiers(), EscapeIdentifiersAndValues(), EscapeValues(), ExecuteProcedure(), ExtractCommentOptions(), NonQuery(), OutputProfiling(), PrepareStatement(), Query(), TransactionBegin(), TransactionCommit(), TransactionRollBack(), __construct(), __set(), transactionCacheFlush(), transactionCacheRestore()`

Methods inherited from QBaseClass
`OverrideAttributes(), __call()`

Constants inherited from QDatabaseBase
`Adapter`

Properties summary
`protected`	`$objPgSql`	#
`protected`	`$objMostRecentResult`	#
`protected boolean`	`$blnOnlyFullGroupBy`	# `true`

Properties inherited from QDatabaseBase
`$blnConnectedFlag, $blnEnableProfiling, $intDatabaseIndex, $intTransactionDepth, $objCacheProviderStack, $objConfigArray, $strEscapeIdentifierBegin, $strEscapeIdentifierEnd, $strProfileArray`

Magic properties inherited from QDatabaseBase
`$Adapter, $AffectedRows, $Caching, $Database, $DatabaseIndex, $DateFormat, $EnableProfiling, $EscapeIdentifierBegin, $EscapeIdentifierEnd, $Host, $OnlyFullGroupBy, $Password, $Port, $Profile, $Protocol, $Server, $Service, $Username`

Packages

Classes

Exceptions

Class QPostgreSqlDatabase

Parameters

Returns

Overrides

Parameters

Overrides

Throws

Parameters

Returns

Throws

Overrides

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides