PgsqlDriver
Extends PdoDriverPostgreSQL PDO Database Driver
since |
1.5.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(array options) : mixed
since |
1.0 |
---|
Arguments
- options
array
List of options used to configure the connection
Response
mixed
__destruct
Destructor.
__destruct() : mixed
since |
2.0.0 |
---|
Response
mixed
__get
Magic method to access properties of the database driver.
__get(string name) : mixed
since |
1.4.0 |
---|---|
deprecated |
3.0 This is a B/C proxy since $this->name was previously public |
Arguments
- name
string
The name of the property.
Response
mixed
A value if the property name is valid, null otherwise.
__sleep
PDO does not support serialize
__sleep() : array
since |
1.0 |
---|
Response
array
__wakeup
Wake up after serialization
__wakeup() : void
since |
1.0 |
---|
alterDbCharacterSet
Alter database's character set.
alterDbCharacterSet(string dbName) : bool|resource
since |
2.0.0 |
---|---|
throws |
|
Arguments
- dbName
string
The database name that will be altered
Response
bool|resource
connect
Connects to the database if needed.
connect() : void
since |
1.0 |
---|---|
throws |
|
connected
Determines if the connection to the server is active.
connected() : bool
since |
1.0 |
---|---|
throws |
|
Response
bool
True if connected to the database engine.
createDatabase
Create a new database using information from $options object.
createDatabase(\stdClass options, bool utf = true) : bool|resource
since |
2.0.0 |
---|---|
throws |
|
Arguments
- options
\stdClass
Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.- utf
bool
True if the database supports the UTF-8 character set.
Response
bool|resource
decodeBinary
Replace special placeholder representing binary field with the original string.
decodeBinary(string|resource data) : string
since |
1.7.0 |
---|
Arguments
- data
string|resource
Encoded string or resource.
Response
string
The original string.
disconnect
Disconnects the database.
disconnect() : void
since |
2.0.0 |
---|
dispatchEvent
Dispatch an event.
dispatchEvent(\Joomla\Event\EventInterface event) : void
since |
2.0.0 |
---|
Arguments
- event
\Joomla\Event\EventInterface
The event to dispatch
dropTable
Drops a table from the database.
dropTable(string table, bool ifExists = true) : $this
since |
2.0.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the database table to drop.- ifExists
bool
Optionally specify that the table must exist before it is dropped.
Response
$this
escape
Method to escape a string for usage in an SQL statement.
escape(string text, bool extra = false) : string
Oracle escaping reference: http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F
SQLite escaping notes: http://www.sqlite.org/faq.html#q14
Method body is as implemented by the Zend Framework
Note: Using query objects with bound variables is preferable to the below.
since |
1.0 |
---|
Arguments
- text
string
The string to be escaped.- extra
bool
Unused optional parameter to provide extra escaping.
Response
string
The escaped string.
execute
Execute the SQL statement.
execute() : bool
since |
2.0.0 |
---|---|
throws |
|
Response
bool
fetchArray
Method to fetch a row from the result set cursor as an array.
fetchArray() : mixed
since |
1.0 |
---|
Response
mixed
Either the next row from the result set or false if there are no more rows.
fetchAssoc
Method to fetch a row from the result set cursor as an associative array.
fetchAssoc() : mixed
since |
1.0 |
---|
Response
mixed
Either the next row from the result set or false if there are no more rows.
fetchObject
Method to fetch a row from the result set cursor as an object.
fetchObject() : mixed
Note, the fetch mode should be configured before calling this method using StatementInterface::setFetchMode()
.
since |
1.0 |
---|
Response
mixed
Either the next row from the result set or false if there are no more rows.
freeResult
Method to free up the memory used for the result set.
freeResult() : void
since |
1.0 |
---|
getAffectedRows
Get the number of affected rows for the previous executed SQL statement.
getAffectedRows() : int
since |
2.0.0 |
---|
Response
int
The number of affected rows in the previous operation
getAlterDbCharacterSet
Return the query string to alter the database character set.
getAlterDbCharacterSet(string dbName) : string
since |
1.6.0 |
---|
Arguments
- dbName
string
The database name
Response
string
The query that alter the database query string
getCollation
Method to get the database collation in use by sampling a text field of a table in the database.
getCollation() : string|bool
since |
1.5.0 |
---|---|
throws |
|
Response
string|bool
The collation in use by the database or boolean false if not supported.
getConnectedQuery
Get a query to run and verify the database is operational.
getConnectedQuery() : string
since |
1.0 |
---|
Response
string
The query to check the health of the DB.
getConnection
Method that provides access to the underlying database connection.
getConnection() : resource
since |
1.0 |
---|
Response
resource
The underlying database connection resource.
getConnectionCollation
Method to get the database connection collation in use by sampling a text field of a table in the database.
getConnectionCollation() : string|bool
since |
1.6.0 |
---|---|
throws |
|
Response
string|bool
The collation in use by the database connection (string) or boolean false if not supported.
getConnectionEncryption
Method to get the database encryption details (cipher and protocol) in use.
getConnectionEncryption() : string
since |
2.0.0 |
---|---|
throws |
|
Response
string
The database encryption details.
getConnectors
Get a list of available database connectors.
getConnectors() : array
The list will only be populated with connectors that the class exists for and the environment supports its use. This gives us the ability to have a multitude of connector classes that are self-aware as to whether or not they are able to be used on a given system.
since |
1.0 |
---|
Response
array
An array of available database connectors.
getCount
Get the total number of SQL statements executed by the database driver.
getCount() : int
since |
1.0 |
---|
Response
int
getCreateDatabaseQuery
Return the query string to create new Database.
getCreateDatabaseQuery(\Joomla\Database\stdClass options, bool utf) : string
since |
2.0.0 |
---|
Arguments
- options
\Joomla\Database\stdClass
Object used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.- utf
bool
True if the database supports the UTF-8 character set.
Response
string
The query that creates database
getCreateDbQuery
Get the query string to create new Database in correct PostgreSQL syntax.
getCreateDbQuery(object options, bool utf) : string
since |
1.5.0 |
---|
Arguments
- options
object
object coming from "initialise" function to pass user and database name to database driver.- utf
bool
True if the database supports the UTF-8 character set, not used in PostgreSQL "CREATE DATABASE" query.
Response
string
The query that creates database, owned by $options['user']
getDatabase
Gets the name of the database used by this connection.
getDatabase() : string
since |
1.0 |
---|
Response
string
getDateFormat
Returns a PHP date() function compliant date format for the database driver.
getDateFormat() : string
since |
1.0 |
---|
Response
string
getDefaultSchema
Internal function to get the name of the default schema for the current PostgreSQL connection.
getDefaultSchema() : string
That is the schema where tables are created by Joomla.
since |
1.8.0 |
---|
Response
string
getDispatcher
Get the event dispatcher.
getDispatcher() : \Joomla\Event\DispatcherInterface
since |
1.2.0 |
---|---|
throws |
|
Response
\Joomla\Event\DispatcherInterface
getExporter
Gets an exporter class object.
getExporter() : \Joomla\Database\DatabaseExporter
since |
1.0 |
---|---|
throws |
|
Response
\Joomla\Database\DatabaseExporter
An exporter object.
getImporter
Gets an importer class object.
getImporter() : \Joomla\Database\DatabaseImporter
since |
1.0 |
---|
Response
\Joomla\Database\DatabaseImporter
getInstance
Method to return a DatabaseDriver instance based on the given options.
getInstance(array options = []) : \Joomla\Database\DatabaseDriver
There are three global options and then the rest are specific to the database driver.
- The 'driver' option defines which DatabaseDriver class is used for the connection -- the default is 'mysqli'.
- The 'database' option determines which database is to be used for the connection.
- The 'select' option determines whether the connector should automatically select the chosen database.
Instances are unique to the given options and new objects are only created when a unique options array is passed into the method. This ensures that we don't end up with unnecessary database connection resources.
since |
1.0 |
---|---|
throws |
|
deprecated |
3.0 Use DatabaseFactory::getDriver() instead |
Arguments
- options
array
Parameters to be passed to the database driver.
Response
\Joomla\Database\DatabaseDriver
getIterator
Get a new iterator on the current query.
getIterator(string column = null, string class = stdClass::class) : \Joomla\Database\DatabaseIterator
since |
1.0 |
---|
Arguments
- column
string
An option column to use as the iterator key.- class
string
The class of object that is returned.
Response
\Joomla\Database\DatabaseIterator
getMinimum
Get the minimum supported database version.
getMinimum() : string
since |
1.0 |
---|
Response
string
getMonitor
Get the query monitor.
getMonitor() : \Joomla\Database\QueryMonitorInterface|null
since |
2.0.0 |
---|
Response
\Joomla\Database\QueryMonitorInterface|null
The query monitor or null if not set.
getName
Get the name of the database driver.
getName() : string
If $this->name is not set it will try guessing the driver name from the class name.
since |
1.4.0 |
---|
Response
string
getNamesKey
Get the list of column names this index indexes.
getNamesKey(string table, string indKey) : string
since |
2.0.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the table.- indKey
string
The list of column numbers for the table
Response
string
A list of the column names for the table.
getNullDate
Get the null or zero representation of a timestamp for the database driver.
getNullDate() : string
since |
1.0 |
---|
Response
string
getNumRows
Get the number of returned rows for the previous executed SQL statement.
getNumRows() : int
since |
2.0.0 |
---|
Response
int
The number of returned rows.
getOption
Retrieve a PDO database connection attribute https://www.php.net/manual/en/pdo.getattribute.php
getOption(mixed key) : mixed
Usage: $db->getOption(PDO::ATTR_CASE);
since |
1.0 |
---|
Arguments
- key
mixed
One of the PDO::ATTR_* Constants
Response
mixed
getPrefix
Get the common table prefix for the database driver.
getPrefix() : string
since |
1.0 |
---|
Response
string
The common database table prefix.
getQuery
Get the current query object or a new DatabaseQuery object.
getQuery(bool new = false) : \Joomla\Database\DatabaseQuery
since |
1.0 |
---|
Arguments
- new
bool
False to return the current query object, True to return a new DatabaseQuery object.
Response
\Joomla\Database\DatabaseQuery
getRandom
Generate a random value
getRandom() : float
since |
1.5.0 |
---|
Response
float
The random generated number
getSequenceIsCalled
Method to get the is_called attribute of a sequence.
getSequenceIsCalled(string sequence) : bool
since |
2.0.0 |
---|---|
throws |
|
Arguments
- sequence
string
The name of the sequence.
Response
bool
The is_called attribute of the sequence.
getSequenceLastValue
Method to get the last value of a sequence in the database.
getSequenceLastValue(string sequence) : int
since |
2.0.0 |
---|---|
throws |
|
Arguments
- sequence
string
The name of the sequence.
Response
int
The last value of the sequence.
getServerType
Get the server family type.
getServerType() : string
If $this->serverType is not set it will attempt guessing the server family type from the driver name. If this is not possible the driver name will be returned instead.
since |
1.4.0 |
---|
Response
string
getStringPositionSql
Get the substring position inside a string
getStringPositionSql(string substring, string string) : int
since |
1.5.0 |
---|
Arguments
- substring
string
The string being sought- string
string
The string/column being searched
Response
int
The position of $substring in $string
getTableColumns
Retrieves field information about a given table.
getTableColumns(string table, bool typeOnly = true) : array
since |
1.5.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the database table.- typeOnly
bool
True to only return field types.
Response
array
An array of fields for the database table.
getTableCreate
Shows the table CREATE statement that creates the given tables.
getTableCreate(mixed tables) : array
since |
1.0 |
---|---|
throws |
|
Arguments
- tables
mixed
A table name or a list of table names.
Response
array
A list of the create SQL for the tables.
getTableKeys
Get the details list of keys for a table.
getTableKeys(string table) : array
since |
1.5.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the table.
Response
array
An array of the column specification for the table.
getTableList
Method to get an array of all tables in the database.
getTableList() : array
since |
1.5.0 |
---|---|
throws |
|
Response
array
An array of all the tables in the database.
getTableSequences
Get the details list of sequences for a table.
getTableSequences(string table) : array
since |
1.5.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the table.
Response
array
An array of sequences specification for the table.
getVersion
Get the version of the database connector.
getVersion() : string
since |
1.5.0 |
---|
Response
string
The database connector version.
hasUtfSupport
Determine whether or not the database engine supports UTF-8 character encoding.
hasUtfSupport() : bool
since |
1.0 |
---|
Response
bool
True if the database engine supports UTF-8 character encoding.
insertid
Method to get the auto-incremented value from the last INSERT statement.
insertid() : string
since |
1.0 |
---|
Response
string
The value of the auto-increment field from the last inserted row.
insertObject
Inserts a row into a table based on an object's properties.
insertObject(string table, object &object, string key = null) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the database table to insert into.- object
object
A reference to an object whose public properties match the table fields.- key
string
The name of the primary key. If provided the object property is updated.
Response
bool
isConnectionEncryptionSupported
Method to test if the database TLS connections encryption are supported.
isConnectionEncryptionSupported() : bool
since |
2.0.0 |
---|
Response
bool
Whether the database supports TLS connections encryption.
isMinimumVersion
Method to check whether the installed database version is supported by the database driver
isMinimumVersion() : bool
since |
1.0 |
---|
Response
bool
True if the database version is supported
isSupported
Test to see if the PDO extension is available.
isSupported() : bool
Override as needed to check for specific PDO Drivers.
since |
1.0 |
---|
Response
bool
True on success, false otherwise.
loadAssoc
Method to get the first row of the result set from the database query as an associative array of ['field_name' => 'row_value'].
loadAssoc() : mixed
since |
1.0 |
---|---|
throws |
|
Response
mixed
The return value or null if the query failed.
loadAssocList
Method to get an array of the result set rows from the database query where each row is an associative array of ['field_name' => 'row_value']. The array of rows can optionally be keyed by a field name, but defaults to a sequential numeric array.
loadAssocList(string key = null, string column = null) : mixed
NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.
since |
1.0 |
---|---|
throws |
|
Arguments
- key
string
The name of a field on which to key the result array.- column
string
An optional column name. Instead of the whole row, only this column value will be in the result array.
Response
mixed
The return value or null if the query failed.
loadColumn
Method to get an array of values from the $offset field in each row of the result set from the database query.
loadColumn(int offset) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- offset
int
The row offset to use to build the result array.
Response
mixed
The return value or null if the query failed.
loadObject
Method to get the first row of the result set from the database query as an object.
loadObject(string class = stdClass::class) : mixed
since |
1.0 |
---|---|
throws |
|
Arguments
- class
string
The class name to use for the returned row object.
Response
mixed
The return value or null if the query failed.
loadObjectList
Method to get an array of the result set rows from the database query where each row is an object. The array of objects can optionally be keyed by a field name, but defaults to a sequential numeric array.
loadObjectList(string key = '', string class = stdClass::class) : mixed
NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.
since |
1.0 |
---|---|
throws |
|
Arguments
- key
string
The name of a field on which to key the result array.- class
string
The class name to use for the returned row objects.
Response
mixed
The return value or null if the query failed.
loadResult
Method to get the first field of the first row of the result set from the database query.
loadResult() : mixed
since |
1.0 |
---|---|
throws |
|
Response
mixed
The return value or null if the query failed.
loadRow
Method to get the first row of the result set from the database query as an array.
loadRow() : mixed
Columns are indexed numerically so the first column in the result set would be accessible via $row[0], etc.
since |
1.0 |
---|---|
throws |
|
Response
mixed
The return value or null if the query failed.
loadRowList
Method to get an array of the result set rows from the database query where each row is an array. The array of objects can optionally be keyed by a field offset, but defaults to a sequential numeric array.
loadRowList(string key = null) : array
NOTE: Choosing to key the result array by a non-unique field can result in unwanted behavior and should be avoided.
since |
1.0 |
---|---|
throws |
|
Arguments
- key
string
The name of a field on which to key the result array.
Response
array
An array of results.
lockTable
Locks a table in the database.
lockTable(string tableName) : $this
since |
1.5.0 |
---|---|
throws |
|
Arguments
- tableName
string
The name of the table to unlock.
Response
$this
prepareStatement
Prepares a SQL statement for execution
prepareStatement(string query) : \Joomla\Database\StatementInterface
since |
2.0.0 |
---|---|
throws |
|
Arguments
- query
string
The SQL query to be prepared.
Response
\Joomla\Database\StatementInterface
q
Alias for quote method
q(array|string text, bool escape = true) : string
since |
1.0 |
---|
Arguments
- text
array|string
A string or an array of strings to quote.- escape
bool
True (default) to escape the string, false to leave it unchanged.
Response
string
The quoted input string.
qn
Alias for quoteName method
qn(array|string name, array|string as = null) : array|string
since |
1.0 |
---|
Arguments
- name
array|string
The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.- as
array|string
The AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.
Response
array|string
The quote wrapped name, same type of $name.
quote
Quotes and optionally escapes a string to database requirements for use in database queries.
quote(array|string text, bool escape = true) : string
since |
1.0 |
---|
Arguments
- text
array|string
A string or an array of strings to quote.- escape
bool
True (default) to escape the string, false to leave it unchanged.
Response
string
The quoted input string.
quoteBinary
Quotes a binary string to database requirements for use in database queries.
quoteBinary(string data) : string
since |
1.7.0 |
---|
Arguments
- data
string
A binary string to quote.
Response
string
The binary quoted input string.
quoteName
Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.
quoteName(array|string name, array|string as = null) : array|string
since |
1.0 |
---|
Arguments
- name
array|string
The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.- as
array|string
The AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.
Response
array|string
The quote wrapped name, same type of $name.
quoteNameStr
Quote strings coming from quoteName call.
quoteNameStr(array strArr) : string
since |
1.0 |
---|---|
deprecated |
2.0 Use quoteNameString instead |
Arguments
- strArr
array
Array of strings coming from quoteName dot-explosion.
Response
string
Dot-imploded string of quoted parts.
quoteNameString
Quote string coming from quoteName call.
quoteNameString(string name, bool asSinglePart = false) : string
since |
1.7.0 |
---|
Arguments
- name
string
Identifier name to be quoted.- asSinglePart
bool
Treat the name as a single part of the identifier.
Response
string
Quoted identifier string.
renameTable
Renames a table in the database.
renameTable(string oldTable, string newTable, string backup = null, string prefix = null) : $this
since |
1.5.0 |
---|---|
throws |
|
Arguments
- oldTable
string
The name of the table to be renamed- newTable
string
The new name for the table.- backup
string
Not used by PostgreSQL.- prefix
string
Not used by PostgreSQL.
Response
$this
replacePrefix
This function replaces a string identifier with the configured table prefix.
replacePrefix(string sql, string prefix = '#__') : string
since |
1.0 |
---|
Arguments
- sql
string
The SQL statement to prepare.- prefix
string
The table prefix.
Response
string
The processed SQL statement.
select
Select a database for use.
select(string database) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- database
string
The name of the database to select for use.
Response
bool
True if the database was successfully selected.
setDispatcher
Set the dispatcher to use.
setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) : $this
since |
1.2.0 |
---|
Arguments
- dispatcher
\Joomla\Event\DispatcherInterface
The dispatcher to use.
Response
$this
setMonitor
Set a query monitor.
setMonitor(\Joomla\Database\QueryMonitorInterface|null monitor = null) : $this
since |
2.0.0 |
---|
Arguments
- monitor
\Joomla\Database\QueryMonitorInterface|null
The query monitor.
Response
$this
setOption
Sets an attribute on the PDO database handle.
setOption(int key, mixed value) : bool
https://www.php.net/manual/en/pdo.setattribute.php
Usage: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
since |
1.0 |
---|
Arguments
- key
int
One of the PDO::ATTR_* Constants- value
mixed
One of the associated PDO Constants related to the particular attribute key.
Response
bool
setQuery
Sets the SQL statement string for later execution.
setQuery(string|\Joomla\Database\QueryInterface query, int offset, int limit) : $this
since |
1.0 |
---|---|
throws |
|
Arguments
- query
string|\Joomla\Database\QueryInterface
The SQL statement to set either as a Query object or a string.- offset
int
The affected row offset to set. {@deprecated Use LimitableInterface::setLimit() instead}- limit
int
The maximum affected rows to set. {@deprecated Use LimitableInterface::setLimit() instead}
Response
$this
setUtf
Set the connection to use UTF-8 character encoding.
setUtf() : bool
since |
1.0 |
---|
Response
bool
True on success.
showTables
Returns an array containing database's table list.
showTables() : array
since |
1.5.0 |
---|
Response
array
The database's table list.
splitSql
Splits a string of multiple queries into an array of individual queries.
splitSql(string sql) : array
since |
1.0 |
---|
Arguments
- sql
string
Input SQL string with which to split into individual queries.
Response
array
sqlValue
This function return a field value as a prepared string to be used in a SQL statement.
sqlValue(array columns, string fieldName, string fieldValue) : string
since |
1.5.0 |
---|
Arguments
- columns
array
Array of table's column returned by ::getTableColumns.- fieldName
string
The table field's name.- fieldValue
string
The variable value to quote and return.
Response
string
The quoted string.
transactionCommit
Method to commit a transaction.
transactionCommit(bool toSavepoint = false) : void
since |
1.0 |
---|---|
throws |
|
Arguments
- toSavepoint
bool
If true, commit to the last savepoint.
transactionRollback
Method to roll back a transaction.
transactionRollback(bool toSavepoint = false) : void
since |
1.0 |
---|---|
throws |
|
Arguments
- toSavepoint
bool
If true, rollback to the last savepoint.
transactionStart
Method to initialize a transaction.
transactionStart(bool asSavepoint = false) : void
since |
1.0 |
---|---|
throws |
|
Arguments
- asSavepoint
bool
If true and a transaction is already active, a savepoint will be created.
truncateTable
Method to truncate a table.
truncateTable(string table) : void
since |
1.0 |
---|---|
throws |
|
Arguments
- table
string
The table to truncate
unlockTables
Unlocks tables in the database, this command does not exist in PostgreSQL, it is automatically done on commit or rollback.
unlockTables() : $this
since |
1.5.0 |
---|---|
throws |
|
Response
$this
updateObject
Updates a row in a table based on an object's properties.
updateObject(string table, object &object, array|string key, bool nulls = false) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- table
string
The name of the database table to update.- object
object
A reference to an object whose public properties match the table fields.- key
array|string
The name of the primary key.- nulls
bool
True to update null fields or false to ignore them.
Response
bool
True on success.
Properties
name
The name of the database driver.
since |
1.0 |
---|
Type(s)
string
nameQuote
The character(s) used to quote SQL statement names such as table names or field names, etc.
If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote.
since |
1.0 |
---|
Type(s)
string
nullDate
The null or zero representation of a timestamp for the database driver.
since |
1.0 |
---|
Type(s)
string
dbMinimum
The minimum supported database version.
since |
1.0 |
---|
Type(s)
string
concat_operator
Operator used for concatenation
since |
1.5.0 |
---|
Type(s)
string
connection
The database connection resource.
since |
1.0 |
---|
Type(s)
resource
database
The name of the database.
since |
1.0 |
---|
Type(s)
string
serverType
The type of the database server family supported by this driver.
since |
1.4.0 |
---|
Type(s)
string
connectors
Holds the list of available db connectors.
since |
1.0 |
---|
Type(s)
array
count
The number of SQL statements executed by the database driver.
since |
1.0 |
---|
Type(s)
int
cursor
The database connection cursor from the last query.
since |
1.0 |
---|
Type(s)
resource
executed
Contains the current query execution status
since |
2.0.0 |
---|
Type(s)
bool
limit
The affected row limit for the current SQL statement.
since |
1.0 |
---|
Type(s)
int
offset
The affected row offset to apply for the current SQL statement.
since |
1.0 |
---|
Type(s)
int
options
Passed in upon instantiation and saved.
since |
1.0 |
---|
Type(s)
array
sql
The current SQL statement to execute.
since |
1.0 |
---|
Type(s)
mixed
statement
The prepared statement.
since |
2.0.0 |
---|
Type(s)
\Joomla\Database\StatementInterface
tablePrefix
The common database table prefix.
since |
1.0 |
---|
Type(s)
string
utf
True if the database engine supports UTF-8 character encoding.
since |
1.0 |
---|
Type(s)
bool
errorNum
The database error number.
since |
1.0 |
---|
Type(s)
int
errorMsg
The database error message.
since |
1.0 |
---|
Type(s)
string
instances
DatabaseDriver instances container.
since |
1.0 |
---|---|
deprecated |
3.0 Singleton storage will no longer be supported. |
Type(s)
\Joomla\Database\DatabaseDriver[]
transactionDepth
The depth of the current transaction.
since |
1.0 |
---|
Type(s)
int
factory
DatabaseFactory object
since |
2.0.0 |
---|
Type(s)
\Joomla\Database\DatabaseFactory
monitor
Query monitor object
since |
2.0.0 |
---|
Type(s)
\Joomla\Database\QueryMonitorInterface
dispatcher
Event Dispatcher
since |
1.2.0 |
---|
Type(s)
\Joomla\Event\DispatcherInterface|null