JDatabaseMysql

class JDatabaseMysql extends JDatabaseDriverMysql

MySQL database driver

Properties

string $name The name of the database driver. from JDatabaseDriverMysql
string $serverType The type of the database server family supported by this driver. from JDatabaseDriverMysqli

Methods

mixed
query()

Execute the SQL statement.

from JDatabase
static  array
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.

from JDatabaseDriver
string
getErrorMsg( boolean $escaped = false)

Gets the error message from the database connection.

from JDatabase
integer
getErrorNum()

Gets the error number from the database connection.

from JDatabase
static  JDatabaseDriver
getInstance( array $options = array())

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.

from JDatabaseDriver
static  array
splitSql( string $sql)

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

from JDatabaseDriver
string
stderr( boolean $showSQL = false)

Return the most recent error message for the database connector.

from JDatabase
static  boolean
test()

Test to see if the connector is available.

from JDatabase
mixed
__call( string $method, array $args)

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

from JDatabaseDriver
__construct( array $options)

Constructor.

from JDatabaseDriverMysql
string
alterDbCharacterSet( string $dbName)

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

from JDatabaseDriver
boolean
alterTableCharacterSet( string $tableName, boolean $rethrow = false)

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.

from JDatabaseDriver
void
connect()

Connects to the database if needed.

from JDatabaseDriverMysql
boolean
connected()

Determines if the connection to the server is active.

from JDatabaseDriverMysql
string
createDatabase( stdClass $options, boolean $utf = true)

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

from JDatabaseDriver
__destruct()

Destructor.

from JDatabaseDriver
void
disconnect()

Disconnects the database.

from JDatabaseDriverMysql
void
addDisconnectHandler( callable $callable)

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

from JDatabaseDriver
JDatabaseDriver
dropTable( string $tableName, boolean $ifExists = true)

Drops a table from the database.

from JDatabaseDriverMysqli
string
escape( string $text, boolean $extra = false)

Method to escape a string for usage in an SQL statement.

from JDatabaseDriverMysql
integer
getAffectedRows()

Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE for the previous executed SQL statement.

from JDatabaseDriverMysql
string
getAlterDbCharacterSet( string $dbName)

Return the query string to alter the database character set.

from JDatabaseDriver
string[]
getAlterTableCharacterSet( string $tableName)

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

from JDatabaseDriver
string
convertUtf8mb4QueryToUtf8( string $query)

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.

from JDatabaseDriver
mixed
getCollation()

Method to get the database collation.

from JDatabaseDriverMysqli
string
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.

from JDatabaseDriverMysqli
resource
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.

from JDatabaseDriver
integer
getCount()

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

from JDatabaseDriver
string
getDateFormat()

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

from JDatabaseDriver
array
getLog()

Get the database driver SQL statement log.

from JDatabaseDriver
array
getTimings()

Get the database driver SQL statement log.

from JDatabaseDriver
array
getCallStacks()

Get the database driver SQL statement log.

from JDatabaseDriver
string
getMinimum()

Get the minimum supported database version.

from JDatabaseDriver
string
getNullDate()

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

from JDatabaseDriver
integer
getNumRows( resource $cursor = null)

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

from JDatabaseDriverMysql
string
getPrefix()

Get the common table prefix for the database driver.

from JDatabaseDriver
JDatabaseExporter
getExporter()

Gets an exporter class object.

from JDatabaseDriver
JDatabaseImporter
getImporter()

Gets an importer class object.

from JDatabaseDriver
string
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.

from JDatabaseDriver
string
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.

from JDatabaseDriver
JDatabaseQuery
getQuery( boolean $new = false)

Get the current query object or a new JDatabaseQuery object.

from JDatabaseDriver
JDatabaseIterator
getIterator( string $column = null, string $class = 'stdClass')

Get a new iterator on the current query.

from JDatabaseDriver
array
getTableColumns( string $table, boolean $typeOnly = true)

Retrieves field information about a given table.

from JDatabaseDriverMysqli
array
getTableCreate( mixed $tables)

Shows the table CREATE statement that creates the given tables.

from JDatabaseDriverMysqli
array
getTableKeys( string $table)

Get the details list of keys for a table.

from JDatabaseDriverMysqli
array
getTableList()

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

from JDatabaseDriverMysqli
boolean
getUTFSupport()

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

from JDatabaseDriver
boolean
hasUTFSupport()

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

from JDatabaseDriver
boolean
hasUTF8mb4Support()

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

from JDatabaseDriver
string
getVersion()

Get the version of the database connector.

from JDatabaseDriverMysql
mixed
insertid()

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

from JDatabaseDriverMysql
boolean
insertObject( string $table, object $object, string $key = null)

Inserts a row into a table based on an object's properties.

from JDatabaseDriver
boolean
isMinimumVersion()

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

from JDatabaseDriver
mixed
loadAssoc()

Method to get the first row of the result set from the database query as an associative array of ['fieldname' => 'rowvalue'].

from JDatabaseDriver
mixed
loadAssocList( string $key = null, string $column = null)

Method to get an array of the result set rows from the database query where each row is an associative array of ['fieldname' => 'rowvalue']. The array of rows can optionally be keyed by a field name, but defaults to a sequential numeric array.

from JDatabaseDriver
mixed
loadColumn( integer $offset)

Method to get an array of values from the $offset field in each row of the result set from the database query.

from JDatabaseDriver
mixed
loadNextObject( string $class = 'stdClass')

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

from JDatabaseDriver
mixed
loadNextRow()

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

from JDatabaseDriver
mixed
loadObject( string $class = 'stdClass')

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

from JDatabaseDriver
mixed
loadObjectList( string $key = '', string $class = 'stdClass')

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.

from JDatabaseDriver
mixed
loadResult()

Method to get the first field of the first row of the result set from the database query.

from JDatabaseDriver
mixed
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.

from JDatabaseDriver
mixed
loadRowList( integer $index = null)

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.

from JDatabaseDriver
JDatabaseDriver
lockTable( string $table)

Locks a table in the database.

from JDatabaseDriverMysqli
string|array
quote( mixed $text, boolean $escape = true)

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

from JDatabaseDriver
mixed
quoteName( mixed $name, mixed $as = null)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

from JDatabaseDriver
string
replacePrefix( string $sql, string $prefix = '#__')

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

from JDatabaseDriver
JDatabaseDriver
renameTable( string $oldTable, string $newTable, string $backup = null, string $prefix = null)

Renames a table in the database.

from JDatabaseDriverMysqli
boolean
select( string $database)

Select a database for use.

from JDatabaseDriverMysql
boolean
setDebug( boolean $level)

Sets the database debugging state for the driver.

from JDatabaseDriver
JDatabaseDriver
setQuery( mixed $query, integer $offset, integer $limit)

Sets the SQL statement string for later execution.

from JDatabaseDriver
boolean
setUtf()

Set the connection to use UTF-8 character encoding.

from JDatabaseDriverMysql
void
transactionCommit( boolean $toSavepoint = false)

Method to commit a transaction.

from JDatabaseDriverMysqli
void
transactionRollback( boolean $toSavepoint = false)

Method to roll back a transaction.

from JDatabaseDriverMysqli
void
transactionStart( boolean $asSavepoint = false)

Method to initialize a transaction.

from JDatabaseDriverMysqli
void
truncateTable( string $table)

Method to truncate a table.

from JDatabaseDriver
boolean
updateObject( string $table, object $object, array $key, boolean $nulls = false)

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

from JDatabaseDriver
mixed
execute()

Execute the SQL statement.

from JDatabaseDriverMysql
JDatabaseDriver
unlockTables()

Unlocks tables in the database.

from JDatabaseDriverMysqli
string|array
q($text, $escape = true)

Alias for quote method

from JDatabaseDriver
string|array
qn($name, $as = null)

Alias for quoteName method

from JDatabaseDriver
static  boolean
isSupported()

Test to see if the MySQL connector is available.

from JDatabaseDriverMysql

Details

mixed query()

Execute the SQL statement.

Return Value

mixed A database cursor resource on success, boolean false on failure.

Exceptions

RuntimeException

static array 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.

Return Value

array An array of available database connectors.

string getErrorMsg( boolean $escaped = false)

Gets the error message from the database connection.

Parameters

boolean $escaped True to escape the message string for use in JavaScript.

Return Value

string The error message for the most recent query.

integer getErrorNum()

Gets the error number from the database connection.

Return Value

integer The error number for the most recent query.

static JDatabaseDriver getInstance( array $options = array())

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.

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.

Parameters

array $options Parameters to be passed to the database driver.

Return Value

JDatabaseDriver A database object.

Exceptions

RuntimeException

static array splitSql( string $sql)

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

Single line or line end comments and multi line comments are stripped off.

Parameters

string $sql Input SQL string with which to split into individual queries.

Return Value

array The queries from the input string separated into an array.

string stderr( boolean $showSQL = false)

Return the most recent error message for the database connector.

Parameters

boolean $showSQL True to display the SQL statement sent to the database as well as the error.

Return Value

string The error message for the most recent query.

static boolean test()

Test to see if the connector is available.

Return Value

boolean True on success, false otherwise.

mixed __call( string $method, array $args)

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

Parameters

string $method The called method.
array $args The array of arguments passed to the method.

Return Value

mixed The aliased method's return value or null.

__construct( array $options)

Constructor.

Parameters

array $options List of options used to configure the connection

string alterDbCharacterSet( string $dbName)

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

Parameters

string $dbName The database name that will be altered

Return Value

string The query that alter the database query string

Exceptions

RuntimeException

boolean alterTableCharacterSet( string $tableName, boolean $rethrow = false)

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.

Parameters

string $tableName The name of the table to alter
boolean $rethrow True to rethrow database exceptions. Default: false (exceptions are suppressed)

Return Value

boolean True if successful

Exceptions

RuntimeException If the table name is empty
Exception Relayed from the database layer if a database error occurs and $rethrow == true

void connect()

Connects to the database if needed.

Return Value

void Returns void if the database connected successfully.

Exceptions

RuntimeException

boolean connected()

Determines if the connection to the server is active.

Return Value

boolean True if connected to the database engine.

string createDatabase( stdClass $options, boolean $utf = true)

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

Parameters

stdClass $options Object used to pass user and database name to database driver. This object must have "dbname" and "dbuser" set.
boolean $utf True if the database supports the UTF-8 character set.

Return Value

string The query that creates database

Exceptions

RuntimeException

__destruct()

Destructor.

void disconnect()

Disconnects the database.

Return Value

void

void addDisconnectHandler( callable $callable)

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

Parameters

callable $callable Function to call in disconnect() method just before disconnecting from database

Return Value

void

JDatabaseDriver dropTable( string $tableName, boolean $ifExists = true)

Drops a table from the database.

Parameters

string $tableName The name of the database table to drop.
boolean $ifExists Optionally specify that the table must exist before it is dropped.

Return Value

JDatabaseDriver Returns this object to support chaining.

Exceptions

RuntimeException

string escape( string $text, boolean $extra = false)

Method to escape a string for usage in an SQL statement.

Parameters

string $text The string to be escaped.
boolean $extra Optional parameter to provide extra escaping.

Return Value

string The escaped string.

integer getAffectedRows()

Get the number of affected rows by the last INSERT, UPDATE, REPLACE or DELETE for the previous executed SQL statement.

Return Value

integer The number of affected rows.

string getAlterDbCharacterSet( string $dbName)

Return the query string to alter the database character set.

Parameters

string $dbName The database name

Return Value

string The query that alter the database query string

string[] getAlterTableCharacterSet( string $tableName)

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

Parameters

string $tableName The name of the table

Return Value

string[] The queries required to alter the table's character set and collation

string convertUtf8mb4QueryToUtf8( string $query)

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.

Parameters

string $query The query to convert

Return Value

string The converted query

mixed getCollation()

Method to get the database collation.

Return Value

mixed The collation in use by the database or boolean false if not supported.

Exceptions

RuntimeException

string 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.

Return Value

string

resource 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.

Return Value

resource The underlying database connection resource.

integer getCount()

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

Return Value

integer

string getDateFormat()

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

Return Value

string The format string.

array getLog()

Get the database driver SQL statement log.

Return Value

array SQL statements executed by the database driver.

array getTimings()

Get the database driver SQL statement log.

Return Value

array SQL statements executed by the database driver.

array getCallStacks()

Get the database driver SQL statement log.

Return Value

array SQL statements executed by the database driver.

string getMinimum()

Get the minimum supported database version.

Return Value

string The minimum version number for the database driver.

string getNullDate()

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

Return Value

string Null or zero representation of a timestamp.

integer getNumRows( resource $cursor = null)

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

This command is only valid for statements like SELECT or SHOW that return an actual result set. To retrieve the number of rows affected by an INSERT, UPDATE, REPLACE or DELETE query, use getAffectedRows().

Parameters

resource $cursor An optional database cursor resource to extract the row count from.

Return Value

integer The number of returned rows.

string getPrefix()

Get the common table prefix for the database driver.

Return Value

string The common database table prefix.

JDatabaseExporter getExporter()

Gets an exporter class object.

Return Value

JDatabaseExporter An exporter object.

Exceptions

RuntimeException

JDatabaseImporter getImporter()

Gets an importer class object.

Return Value

JDatabaseImporter An importer object.

Exceptions

RuntimeException

string 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.

Return Value

string

string 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.

Return Value

string

JDatabaseQuery getQuery( boolean $new = false)

Get the current query object or a new JDatabaseQuery object.

Parameters

boolean $new False to return the current query object, True to return a new JDatabaseQuery object.

Return Value

JDatabaseQuery The current query object or a new object extending the JDatabaseQuery class.

Exceptions

RuntimeException

JDatabaseIterator getIterator( string $column = null, string $class = 'stdClass')

Get a new iterator on the current query.

Parameters

string $column An option column to use as the iterator key.
string $class The class of object that is returned.

Return Value

JDatabaseIterator A new database iterator.

Exceptions

RuntimeException

array getTableColumns( string $table, boolean $typeOnly = true)

Retrieves field information about a given table.

Parameters

string $table The name of the database table.
boolean $typeOnly True (default) to only return field types.

Return Value

array An array of fields by table.

Exceptions

RuntimeException

array getTableCreate( mixed $tables)

Shows the table CREATE statement that creates the given tables.

Parameters

mixed $tables A table name or a list of table names.

Return Value

array A list of the create SQL for the tables.

Exceptions

RuntimeException

array getTableKeys( string $table)

Get the details list of keys for a table.

Parameters

string $table The name of the table.

Return Value

array An array of keys for the table.

Exceptions

RuntimeException

array getTableList()

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

Return Value

array An array of all the tables in the database.

Exceptions

RuntimeException

boolean getUTFSupport()

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

Return Value

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

boolean hasUTFSupport()

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

Return Value

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

boolean hasUTF8mb4Support()

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

Return Value

boolean True if the database engine supports UTF-8 Multibyte.

string getVersion()

Get the version of the database connector.

Return Value

string The database connector version.

mixed insertid()

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

Return Value

mixed The value of the auto-increment field from the last inserted row.

boolean insertObject( string $table, object $object, string $key = null)

Inserts a row into a table based on an object's properties.

Parameters

string $table The name of the database table to insert into.
object $object &$object A reference to an object whose public properties match the table fields.
string $key The name of the primary key. If provided the object property is updated.

Return Value

boolean True on success.

Exceptions

RuntimeException

boolean isMinimumVersion()

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

Return Value

boolean True if the database version is supported

mixed loadAssoc()

Method to get the first row of the result set from the database query as an associative array of ['fieldname' => 'rowvalue'].

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadAssocList( string $key = null, string $column = null)

Method to get an array of the result set rows from the database query where each row is an associative array of ['fieldname' => 'rowvalue']. The array of rows can optionally be keyed by a field name, but defaults to a sequential numeric array.

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

Parameters

string $key The name of a field on which to key the result array.
string $column An optional column name. Instead of the whole row, only this column value will be in the result array.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadColumn( integer $offset)

Method to get an array of values from the $offset field in each row of the result set from the database query.

Parameters

integer $offset The row offset to use to build the result array.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadNextObject( string $class = 'stdClass')

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

Parameters

string $class The class name to use for the returned row object.

Return Value

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

Exceptions

RuntimeException

mixed loadNextRow()

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

Return Value

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

Exceptions

RuntimeException

mixed loadObject( string $class = 'stdClass')

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

Parameters

string $class The class name to use for the returned row object.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadObjectList( string $key = '', string $class = 'stdClass')

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.

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

Parameters

string $key The name of a field on which to key the result array.
string $class The class name to use for the returned row objects.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadResult()

Method to get the first field of the first row of the result set from the database query.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed 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.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

mixed loadRowList( integer $index = null)

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.

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

Parameters

integer $index The index of a field on which to key the result array.

Return Value

mixed The return value or null if the query failed.

Exceptions

RuntimeException

JDatabaseDriver lockTable( string $table)

Locks a table in the database.

Parameters

string $table The name of the table to unlock.

Return Value

JDatabaseDriver Returns this object to support chaining.

Exceptions

RuntimeException

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

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

Parameters

mixed $text A string or an array of strings to quote.
boolean $escape True (default) to escape the string, false to leave it unchanged.

Return Value

string|array The quoted input.

mixed quoteName( mixed $name, mixed $as = null)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

Parameters

mixed $name The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.
mixed $as 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.

Return Value

mixed The quote wrapped name, same type of $name.

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

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

Parameters

string $sql The SQL statement to prepare.
string $prefix The common table prefix.

Return Value

string The processed SQL statement.

JDatabaseDriver renameTable( string $oldTable, string $newTable, string $backup = null, string $prefix = null)

Renames a table in the database.

Parameters

string $oldTable The name of the table to be renamed
string $newTable The new name for the table.
string $backup Table prefix
string $prefix For the table - used to rename constraints in non-mysql databases

Return Value

JDatabaseDriver Returns this object to support chaining.

Exceptions

RuntimeException

boolean select( string $database)

Select a database for use.

Parameters

string $database The name of the database to select for use.

Return Value

boolean True if the database was successfully selected.

Exceptions

RuntimeException

boolean setDebug( boolean $level)

Sets the database debugging state for the driver.

Parameters

boolean $level True to enable debugging.

Return Value

boolean The old debugging level.

JDatabaseDriver setQuery( mixed $query, integer $offset, integer $limit)

Sets the SQL statement string for later execution.

Parameters

mixed $query The SQL statement to set either as a JDatabaseQuery object or a string.
integer $offset The affected row offset to set.
integer $limit The maximum affected rows to set.

Return Value

JDatabaseDriver This object to support method chaining.

boolean setUtf()

Set the connection to use UTF-8 character encoding.

Return Value

boolean True on success.

void transactionCommit( boolean $toSavepoint = false)

Method to commit a transaction.

Parameters

boolean $toSavepoint If true, commit to the last savepoint.

Return Value

void

Exceptions

RuntimeException

void transactionRollback( boolean $toSavepoint = false)

Method to roll back a transaction.

Parameters

boolean $toSavepoint If true, rollback to the last savepoint.

Return Value

void

Exceptions

RuntimeException

void transactionStart( boolean $asSavepoint = false)

Method to initialize a transaction.

Parameters

boolean $asSavepoint If true and a transaction is already active, a savepoint will be created.

Return Value

void

Exceptions

RuntimeException

void truncateTable( string $table)

Method to truncate a table.

Parameters

string $table The table to truncate

Return Value

void

Exceptions

RuntimeException

boolean updateObject( string $table, object $object, array $key, boolean $nulls = false)

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

Parameters

string $table The name of the database table to update.
object $object &$object A reference to an object whose public properties match the table fields.
array $key The name of the primary key.
boolean $nulls True to update null fields or false to ignore them.

Return Value

boolean True on success.

Exceptions

RuntimeException

mixed execute()

Execute the SQL statement.

Return Value

mixed A database cursor resource on success, boolean false on failure.

Exceptions

RuntimeException

JDatabaseDriver unlockTables()

Unlocks tables in the database.

Return Value

JDatabaseDriver Returns this object to support chaining.

Exceptions

RuntimeException

string|array q($text, $escape = true)

Alias for quote method

Parameters

$text
$escape

Return Value

string|array

string|array qn($name, $as = null)

Alias for quoteName method

Parameters

$name
$as

Return Value

string|array

static boolean isSupported()

Test to see if the MySQL connector is available.

Return Value

boolean True on success, false otherwise.