Joomla! API

Download
Demo

JDatabaseDriverSqlite

Extends \JDatabaseDriverPdo

SQLite database driver

link

https://secure.php.net/pdo
since

12.1
package

Joomla.Platform

Methods

__call

Magic method to provide method alias support for quote() and quoteName().

__call(string $method, array $args) : mixed
inherited
since

11.1

Arguments

$method

stringThe called method.

$args

arrayThe array of arguments passed to the method.

Response

mixedThe aliased method's return value or null.

__construct

Constructor.

__construct(array $options)
inherited
since

11.1

Arguments

$options

arrayList of options used to configure the connection

__destruct

Destructor.

__destruct()
inherited
since

3.8.0

__sleep

PDO does not support serialize

__sleep() : array
inherited
since

12.3

Response

array

__wakeup

Wake up after serialization

__wakeup() : array
inherited
since

12.3

Response

array

addDisconnectHandler

Adds a function callable just before disconnecting the database. Parameter of the callable is $this JDatabaseDriver

addDisconnectHandler(callable $callable) : void
inherited
since

Arguments

$callable

callableFunction to call in disconnect() method just before disconnecting from database

alterDbCharacterSet

Alter database's character set, obtaining query string from protected member.

alterDbCharacterSet(string $dbName) : string
inherited
since

12.2
throws

\RuntimeException

Arguments

$dbName

stringThe database name that will be altered

Response

stringThe query that alter the database query string

alterTableCharacterSet

Alter a table's character set, obtaining an array of queries to do so from a protected method. The conversion is wrapped in a transaction, if supported by the database driver. Otherwise the table will be locked before the conversion. This prevents data corruption.

alterTableCharacterSet(string $tableName, boolean $rethrow = false) : boolean
inherited
since
throws

\RuntimeExceptionIf the table name is empty

\ExceptionRelayed from the database layer if a database error occurs and $rethrow == true

Arguments

$tableName

stringThe name of the table to alter

$rethrow

booleanTrue to rethrow database exceptions. Default: false (exceptions are suppressed)

Response

booleanTrue if successful

connect

Connects to the database if needed.

connect() : void
inherited abstract
since

12.1
throws

\RuntimeException

connected

Determines if the connection to the server is active.

connected() : boolean
inherited abstract
since

11.1

Response

booleanTrue if connected to the database engine.

convertUtf8mb4QueryToUtf8

Automatically downgrade a CREATE TABLE or ALTER TABLE query from utf8mb4 (UTF-8 Multibyte) to plain utf8. Used when the server doesn't support UTF-8 Multibyte.

convertUtf8mb4QueryToUtf8(string $query) : string
inherited

Arguments

$query

stringThe query to convert

Response

stringThe converted query

createDatabase

Create a new database using information from $options object, obtaining query string from protected member.

createDatabase(\stdClass $options, boolean $utf = true) : string
inherited
since

12.2
throws

\RuntimeException

Arguments

$options

\stdClassObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.

$utf

booleanTrue if the database supports the UTF-8 character set.

Response

stringThe query that creates database

disconnect

Disconnects the database.

disconnect() : void
inherited abstract
since

12.1

dropTable

Drops a table from the database.

dropTable(string $table, boolean $ifExists = true) : \JDatabaseDriver
inherited abstract
since

11.4
throws

\RuntimeException

Arguments

$table

stringThe name of the database table to drop.

$ifExists

booleanOptionally specify that the table must exist before it is dropped.

Response

\JDatabaseDriverReturns this object to support chaining.

escape

Escapes a string for usage in an SQL statement.

escape(string $text, boolean $extra = false) : string
inherited abstract
since

11.1

Arguments

$text

stringThe string to be escaped.

$extra

booleanOptional parameter to provide extra escaping.

Response

stringThe escaped string.

execute

Execute the SQL statement.

execute() : mixed
inherited abstract
since

12.1
throws

\RuntimeException

Response

mixedA database cursor resource on success, boolean false on failure.

fetchArray

Method to fetch a row from the result set cursor as an array.

fetchArray(mixed $cursor = null) : mixed
inherited abstract
since

11.1

Arguments

$cursor

mixedThe optional result set cursor from which to fetch the row.

Response

mixedEither 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 $cursor = null) : mixed
inherited abstract
since

11.1

Arguments

$cursor

mixedThe optional result set cursor from which to fetch the row.

Response

mixedEither 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 $cursor = null, string $class = 'stdClass') : mixed
inherited abstract
since

11.1

Arguments

$cursor

mixedThe optional result set cursor from which to fetch the row.

$class

stringThe class name to use for the returned row object.

Response

mixedEither 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(mixed $cursor = null) : void
inherited abstract
since

11.1

Arguments

$cursor

mixedThe optional result set cursor from which to fetch the row.

getAffectedRows

Get the number of affected rows for the previous executed SQL statement.

getAffectedRows() : integer
inherited abstract
since

11.1

Response

integerThe number of affected rows.

getAlterDbCharacterSet

Return the query string to alter the database character set.

getAlterDbCharacterSet(string $dbName) : string
inherited
since

12.2

Arguments

$dbName

stringThe database name

Response

stringThe query that alter the database query string

getAlterTableCharacterSet

Get the query strings to alter the character set and collation of a table.

getAlterTableCharacterSet(string $tableName) : array<mixed,string>
inherited
since

Arguments

$tableName

stringThe name of the table

Response

array<mixed,string>The queries required to alter the table's character set and collation

getCallStacks

Get the database driver SQL statement log.

getCallStacks() : array
inherited
since

Response

arraySQL statements executed by the database driver.

getCollation

Method to get the database collation in use by sampling a text field of a table in the database.

getCollation() : mixed
inherited abstract
since

11.1

Response

mixedThe 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
inherited
since

12.2

Response

stringThe query to check the health of the DB.

getConnection

Method that provides access to the underlying database connection. Useful for when you need to call a proprietary method such as postgresql's lo_* methods.

getConnection() : resource
inherited
since

11.1

Response

resourceThe underlying database connection resource.

getConnectionCollation

Method to get the database connection collation, as reported by the driver. If the connector doesn't support reporting this value please return an empty string.

getConnectionCollation() : string
inherited

Response

string

getConnectors

Get a list of available database connectors. The list will only be populated with connectors that both the class exists and the static test method returns true. 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.

getConnectors() : array
inherited static deprecated
since

11.1
deprecated

13.1 (Platform) & 4.0 (CMS)

Response

arrayAn array of available database connectors.

getCount

Get the total number of SQL statements executed by the database driver.

getCount() : integer
inherited
since

11.1

Response

integer

getCreateDatabaseQuery

Return the query string to create new Database.

getCreateDatabaseQuery(\stdClass $options, boolean $utf) : string
inherited

Each database driver, other than MySQL, need to override this member to return correct string.

since

12.2

Arguments

$options

\stdClassObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.

$utf

booleanTrue if the database supports the UTF-8 character set.

Response

stringThe query that creates database

getDatabase

Gets the name of the database used by this conneciton.

getDatabase() : string
inherited
since

11.4

Response

string

getDateFormat

Returns a PHP date() function compliant date format for the database driver.

getDateFormat() : string
inherited
since

11.1

Response

stringThe format string.

getErrorMessage

Return the actual SQL Error message

getErrorMessage() : string
inherited
since

3.4.6

Response

stringThe SQL Error message

getErrorMsg

Gets the error message from the database connection.

getErrorMsg(boolean $escaped = false) : string
inherited deprecated
deprecated

13.3 (Platform) & 4.0 (CMS)
since

11.1

Arguments

$escaped

booleanTrue to escape the message string for use in JavaScript.

Response

stringThe error message for the most recent query.

getErrorNum

Gets the error number from the database connection.

getErrorNum() : integer
inherited deprecated
since

11.1
deprecated

13.3 (Platform) & 4.0 (CMS)

Response

integerThe error number for the most recent query.

getErrorNumber

Return the actual SQL Error number

getErrorNumber() : integer
inherited
since

3.4.6

Response

integerThe SQL Error number

getExporter

Gets an exporter class object.

getExporter() : \JDatabaseExporter
inherited
since

12.1
throws

\RuntimeException

Response

\JDatabaseExporterAn exporter object.

getImporter

Gets an importer class object.

getImporter() : \JDatabaseImporter
inherited
since

12.1
throws

\RuntimeException

Response

\JDatabaseImporterAn importer object.

getInstance

Method to return a JDatabaseDriver instance based on the given options. There are three global options and then the rest are specific to the database driver. The 'driver' option defines which JDatabaseDriver 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.

getInstance(array $options = array()) : \JDatabaseDriver
inherited static deprecated

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

11.1
deprecated

13.1 (Platform) & 4.0 (CMS)

Arguments

$options

arrayParameters to be passed to the database driver.

Response

\JDatabaseDriverA database object.

getIterator

Get a new iterator on the current query.

getIterator(string $column = null, string $class = 'stdClass') : \JDatabaseIterator
inherited
since

12.1
throws

\RuntimeException

Arguments

$column

stringAn option column to use as the iterator key.

$class

stringThe class of object that is returned.

Response

\JDatabaseIteratorA new database iterator.

getLog

Get the database driver SQL statement log.

getLog() : array
inherited
since

11.1

Response

arraySQL statements executed by the database driver.

getMinimum

Get the minimum supported database version.

getMinimum() : string
inherited
since

12.1

Response

stringThe minimum version number for the database driver.

getName

Get the name of the database driver. If $this->name is not set it will try guessing the driver name from the class name.

getName() : string
inherited
since

Response

string

getNullDate

Get the null or zero representation of a timestamp for the database driver.

getNullDate() : string
inherited
since

11.1

Response

stringNull or zero representation of a timestamp.

getNumRows

Get the number of returned rows for the previous executed SQL statement.

getNumRows(resource $cursor = null) : integer
inherited abstract
since

11.1

Arguments

$cursor

resourceAn optional database cursor resource to extract the row count from.

Response

integerThe number of returned rows.

getOption

Retrieve a PDO database connection attribute

getOption(mixed $key) : mixed
inherited

Usage: $db->getOption(PDO::ATTR_CASE);

link

https://secure.php.net/manual/en/pdo.getattribute.php
since

12.1

Arguments

$key

mixedOne of the PDO::ATTR_* Constants

Response

mixed

getPrefix

Get the common table prefix for the database driver.

getPrefix() : string
inherited
since

11.1

Response

stringThe common database table prefix.

getQuery

Get the current query object or a new JDatabaseQuery object.

getQuery(boolean $new = false) : \JDatabaseQuery
inherited
since

11.1
throws

\RuntimeException

Arguments

$new

booleanFalse to return the current query object, True to return a new JDatabaseQuery object.

Response

\JDatabaseQueryThe current query object or a new object extending the JDatabaseQuery class.

getServerType

Get the server family type, e.g. mysql, postgresql, oracle, sqlite, mssql. 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.

getServerType() : string
inherited
since

Response

string

getTableColumns

Retrieves field information about the given tables.

getTableColumns(string $table, boolean $typeOnly = true) : array
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$table

stringThe name of the database table.

$typeOnly

booleanTrue (default) to only return field types.

Response

arrayAn array of fields by table.

getTableCreate

Shows the table CREATE statement that creates the given tables.

getTableCreate(mixed $tables) : array
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$tables

mixedA table name or a list of table names.

Response

arrayA list of the create SQL for the tables.

getTableKeys

Retrieves keys information about the given table.

getTableKeys(string $table) : array
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$table

stringThe name of the table.

Response

arrayAn array of keys for the table.

getTableList

Method to get an array of all tables in the database.

getTableList() : array
inherited abstract
since

11.1
throws

\RuntimeException

Response

arrayAn array of all the tables in the database.

getTimings

Get the database driver SQL statement log.

getTimings() : array
inherited
since

Response

arraySQL statements executed by the database driver.

getUTFSupport

Determine whether or not the database engine supports UTF-8 character encoding.

getUTFSupport() : boolean
inherited deprecated
since

11.1
deprecated

12.3 (Platform) & 4.0 (CMS) - Use hasUTFSupport() instead

Response

booleanTrue if the database engine supports UTF-8 character encoding.

getVersion

Get the version of the database connector

getVersion() : string
inherited abstract
since

11.1

Response

stringThe database connector version.

hasUTF8mb4Support

Determine whether the database engine support the UTF-8 Multibyte (utf8mb4) character encoding. This applies to MySQL databases.

hasUTF8mb4Support() : boolean
inherited
since

Response

booleanTrue if the database engine supports UTF-8 Multibyte.

hasUTFSupport

Determine whether or not the database engine supports UTF-8 character encoding.

hasUTFSupport() : boolean
inherited
since

12.1

Response

booleanTrue if the database engine supports UTF-8 character encoding.

insertid

Method to get the auto-incremented value from the last INSERT statement.

insertid() : mixed
inherited abstract
since

11.1

Response

mixedThe 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, string $key = null) : boolean
inherited
since

11.1
throws

\RuntimeException

Arguments

$table

stringThe name of the database table to insert into.

$object

$key

stringThe name of the primary key. If provided the object property is updated.

Response

booleanTrue on success.

isMinimumVersion

Method to check whether the installed database version is supported by the database driver

isMinimumVersion() : boolean
inherited
since

12.1

Response

booleanTrue if the database version is supported

isSupported

Test to see if the PDO extension is available.

isSupported() : boolean
inherited static

Override as needed to check for specific PDO Drivers.

since

12.1

Response

booleanTrue 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
inherited
since

11.1
throws

\RuntimeException

Response

mixedThe 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
inherited

NOTE: Chosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

since

11.1
throws

\RuntimeException

Arguments

$key

stringThe name of a field on which to key the result array.

$column

stringAn optional column name. Instead of the whole row, only this column value will be in the result array.

Response

mixedThe 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(integer $offset) : mixed
inherited
since

11.1
throws

\RuntimeException

Arguments

$offset

integerThe row offset to use to build the result array.

Response

mixedThe return value or null if the query failed.

loadNextAssoc

Method to get the next row in the result set from the database query as an array.

loadNextAssoc() : mixed
inherited
since

12.1
throws

\RuntimeException

Response

mixedThe result of the query as an array, false if there are no more rows.

loadNextObject

Method to get the next row in the result set from the database query as an object.

loadNextObject(string $class = 'stdClass') : mixed
inherited deprecated
since

11.1
throws

\RuntimeException
deprecated

12.3 (Platform) & 4.0 (CMS) - Use getIterator() instead

Arguments

$class

stringThe class name to use for the returned row object.

Response

mixedThe result of the query as an array, false if there are no more rows.

loadNextRow

Method to get the next row in the result set from the database query as an array.

loadNextRow() : mixed
inherited deprecated
since

11.1
throws

\RuntimeException
deprecated

4.0 (CMS) Use JDatabaseDriver::getIterator() instead

Response

mixedThe result of the query as an array, false if there are no more rows.

loadObject

Method to get the first row of the result set from the database query as an object.

loadObject(string $class = 'stdClass') : mixed
inherited
since

11.1
throws

\RuntimeException

Arguments

$class

stringThe class name to use for the returned row object.

Response

mixedThe 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') : mixed
inherited

NOTE: Choosing to key the result array by a non-unique field name can result in unwanted behavior and should be avoided.

since

11.1
throws

\RuntimeException

Arguments

$key

stringThe name of a field on which to key the result array.

$class

stringThe class name to use for the returned row objects.

Response

mixedThe 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
inherited
since

11.1
throws

\RuntimeException

Response

mixedThe 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. Columns are indexed numerically so the first column in the result set would be accessible via $row[0], etc.

loadRow() : mixed
inherited
since

11.1
throws

\RuntimeException

Response

mixedThe 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(integer $index = null) : mixed
inherited

NOTE: Choosing to key the result array by a non-unique field can result in unwanted behavior and should be avoided.

since

11.1
throws

\RuntimeException

Arguments

$index

integerThe index of a field on which to key the result array.

Response

mixedThe return value or null if the query failed.

lockTable

Locks a table in the database.

lockTable(string $tableName) : \JDatabaseDriver
inherited abstract
since

11.4
throws

\RuntimeException

Arguments

$tableName

stringThe name of the table to unlock.

Response

\JDatabaseDriverReturns this object to support chaining.

q

q(mixed $text, \= $escape) : string|array
inherited

Alias for quote method

Arguments

$text

mixed

$escape

\=

Response

string|array

qn

qn(mixed $name, \= $as) : string|array
inherited

Alias for quoteName method

Arguments

$name

mixed

$as

\=

Response

string|array

query

Execute the SQL statement.

query() : mixed
inherited deprecated
since

11.1
throws

\RuntimeException
deprecated

13.1 (Platform) & 4.0 (CMS)

Response

mixedA database cursor resource on success, boolean false on failure.

quote

Quotes and optionally escapes a string to database requirements for use in database queries.

quote(mixed $text, boolean $escape = true) : string|array
inherited
note

Accepting an array of strings was added in 12.3.
since

11.1

Arguments

$text

mixedA string or an array of strings to quote.

$escape

booleanTrue (default) to escape the string, false to leave it unchanged.

Response

string|arrayThe quoted input.

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(mixed $name, mixed $as = null) : mixed
inherited
since

11.1

Arguments

$name

mixedThe identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.

$as

mixedThe 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

mixedThe quote wrapped name, same type of $name.

quoteNameStr

Quote strings coming from quoteName call.

quoteNameStr(array $strArr) : string
inherited
since

11.3

Arguments

$strArr

arrayArray of strings coming from quoteName dot-explosion.

Response

stringDot-imploded string of quoted parts.

renameTable

Renames a table in the database.

renameTable(string $oldTable, string $newTable, string $backup = null, string $prefix = null) : \JDatabaseDriver
inherited abstract
since

11.4
throws

\RuntimeException

Arguments

$oldTable

stringThe name of the table to be renamed

$newTable

stringThe new name for the table.

$backup

stringTable prefix

$prefix

stringFor the table - used to rename constraints in non-mysql databases

Response

\JDatabaseDriverReturns this object to support chaining.

replacePrefix

This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.

replacePrefix(string $sql, string $prefix = '#__') : string
inherited
since

11.1

Arguments

$sql

stringThe SQL statement to prepare.

$prefix

stringThe common table prefix.

Response

stringThe processed SQL statement.

select

Select a database for use.

select(string $database) : boolean
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$database

stringThe name of the database to select for use.

Response

booleanTrue if the database was successfully selected.

setDebug

Sets the database debugging state for the driver.

setDebug(boolean $level) : boolean
inherited
since

11.1

Arguments

$level

booleanTrue to enable debugging.

Response

booleanThe old debugging level.

setOption

Sets an attribute on the PDO database handle.

setOption(integer $key, mixed $value) : boolean
inherited

Usage: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);

link

https://secure.php.net/manual/en/pdo.setattribute.php
since

12.1

Arguments

$key

integerOne of the PDO::ATTR_* Constants

$value

mixedOne of the associated PDO Constants related to the particular attribute key.

Response

boolean

setQuery

Sets the SQL statement string for later execution.

setQuery(mixed $query, integer $offset, integer $limit) : \JDatabaseDriver
inherited
since

11.1

Arguments

$query

mixedThe SQL statement to set either as a JDatabaseQuery object or a string.

$offset

integerThe affected row offset to set.

$limit

integerThe maximum affected rows to set.

Response

\JDatabaseDriverThis object to support method chaining.

setUtf

Set the connection to use UTF-8 character encoding.

setUtf() : boolean
inherited abstract
since

11.1

Response

booleanTrue on success.

splitSql

Splits a string of multiple queries into an array of individual queries.

splitSql(string $query) : array
inherited static deprecated
since

11.1
deprecated

13.1 (Platform) & 4.0 (CMS)

Arguments

$query

stringInput SQL string with which to split into individual queries.

Response

arrayThe queries from the input string separated into an array.

stderr

Return the most recent error message for the database connector.

stderr(boolean $showSQL = false) : string
inherited deprecated
since

11.1
deprecated

13.3 (Platform) & 4.0 (CMS)

Arguments

$showSQL

booleanTrue to display the SQL statement sent to the database as well as the error.

Response

stringThe error message for the most recent query.

test

Test to see if the connector is available.

test() : boolean
inherited static deprecated
since

11.1
deprecated

12.3 (Platform) & 4.0 (CMS) - Use JDatabaseDriver::isSupported() instead.

Response

booleanTrue on success, false otherwise.

transactionCommit

Method to commit a transaction.

transactionCommit(boolean $toSavepoint = false) : void
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$toSavepoint

booleanIf true, commit to the last savepoint.

transactionRollback

Method to roll back a transaction.

transactionRollback(boolean $toSavepoint = false) : void
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$toSavepoint

booleanIf true, rollback to the last savepoint.

transactionStart

Method to initialize a transaction.

transactionStart(boolean $asSavepoint = false) : void
inherited abstract
since

11.1
throws

\RuntimeException

Arguments

$asSavepoint

booleanIf true and a transaction is already active, a savepoint will be created.

truncateTable

Method to truncate a table.

truncateTable(string $table) : void
inherited
since

11.3
throws

\RuntimeException

Arguments

$table

stringThe table to truncate

unlockTables

Unlocks tables in the database.

unlockTables() : \JDatabaseDriver
inherited abstract
since

11.4
throws

\RuntimeException

Response

\JDatabaseDriverReturns this object to support chaining.

updateObject

Updates a row in a table based on an object's properties.

updateObject(string $table,  &$object, array $key, boolean $nulls = false) : boolean
inherited
since

11.1
throws

\RuntimeException

Arguments

$table

stringThe name of the database table to update.

$object

$key

arrayThe name of the primary key.

$nulls

booleanTrue to update null fields or false to ignore them.

Response

booleanTrue on success.

Properties

name

The name of the database driver.

inherited

Type(s)

string

serverType

The type of the database server family supported by this driver. Examples: mysql, oracle, postgresql, mssql, sqlite.

inherited

Type(s)

string

nameQuote

The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. 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.

inherited

Type(s)

string

connection

The database connection resource.

inherited

Type(s)

resource

nullDate

The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine.

inherited

Type(s)

string

prepared

The prepared statement.

inherited

Type(s)

resource

executed

Contains the current query execution status

inherited

Type(s)

array

_database

The name of the database.

inherited

Type(s)

string

count

The number of SQL statements executed by the database driver.

inherited

Type(s)

integer

cursor

The database connection cursor from the last query.

inherited

Type(s)

resource

debug

The database driver debugging state.

inherited

Type(s)

boolean

limit

The affected row limit for the current SQL statement.

inherited

Type(s)

integer

log

The log of executed SQL statements by the database driver.

inherited

Type(s)

array

timings

The log of executed SQL statements timings (start and stop microtimes) by the database driver.

inherited

Type(s)

array

callStacks

The log of executed SQL statements timings (start and stop microtimes) by the database driver.

inherited

Type(s)

array

offset

The affected row offset to apply for the current SQL statement.

inherited

Type(s)

integer

options

Passed in upon instantiation and saved.

inherited

Type(s)

array

sql

The current SQL statement to execute.

inherited

Type(s)

mixed

tablePrefix

The common database table prefix.

inherited

Type(s)

string

utf

True if the database engine supports UTF-8 character encoding.

inherited

Type(s)

boolean

utf8mb4

True if the database engine supports UTF-8 Multibyte (utf8mb4) character encoding.

inherited

Type(s)

boolean

errorNum

The database error number

inherited deprecated

Type(s)

integer

errorMsg

The database error message

inherited deprecated

Type(s)

string

instances

JDatabaseDriver instances container.

inherited static

Type(s)

array

dbMinimum

The minimum supported database version.

inherited static

Type(s)

string

transactionDepth

The depth of the current transaction.

inherited

Type(s)

integer

disconnectHandlers

List of callables to call just before disconnecting database

inherited

Type(s)

array<mixed,callable>