JDatabaseMySQL
Extends \JDatabaseMySQL database driver
package |
Joomla.Platform |
---|---|
subpackage |
Database |
see | |
since |
11.1 |
Methods
__call
Magic method to provide method alias support for quote() and quoteName().
__call(string $method, array $args) : string
since |
11.1 |
---|
Arguments
- $method
string
The called method.- $args
array
The array of arguments passed to the method.
Response
string
The aliased method's return value or null.
__construct
Constructor.
__construct(array $options)
since |
11.1 |
---|
Arguments
- $options
array
List of options used to configure the connection
__destruct
Destructor.
__destruct()
since |
11.1 |
---|
addQuoted
Adds a field or array of field names to the list that are to be quoted.
addQuoted(mixed $quoted) : void
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $quoted
mixed
Field name or array of names.
connected
Determines if the connection to the server is active.
connected() : boolean
since |
11.1 |
---|
Response
boolean
True if connected to the database engine.
debug
Sets the debug level on or off
debug(integer $level) : void
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $level
integer
0 to disable debugging and 1 to enable it.
dropTable
Drops a table from the database.
dropTable(string $table, boolean $ifExists = true) : \JDatabase
since |
11.4 |
---|---|
throws |
|
Arguments
- $table
string
The name of the database table to drop.- $ifExists
boolean
Optionally specify that the table must exist before it is dropped.
Response
\JDatabase
Returns this object to support chaining.
escape
Method to escape a string for usage in an SQL statement.
escape(string $text, boolean $extra = false) : string
since |
11.1 |
---|
Arguments
- $text
string
The string to be escaped.- $extra
boolean
Optional parameter to provide extra escaping.
Response
string
The escaped string.
execute
Execute the SQL statement.
execute() : mixed
since |
12.1 |
---|---|
throws |
|
Response
mixed
A database cursor resource on success, boolean false on failure.
explain
Diagnostic method to return explain information for a query.
explain() : string
deprecated |
12.1 |
---|---|
since |
11.1 |
Response
string
The explain output.
fetchArray
Method to fetch a row from the result set cursor as an array.
fetchArray(mixed $cursor = null) : mixed
since |
11.1 |
---|
Arguments
- $cursor
mixed
The optional result set cursor from which to fetch the row.
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 $cursor = null) : mixed
since |
11.1 |
---|
Arguments
- $cursor
mixed
The optional result set cursor from which to fetch the row.
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 $cursor = null, string $class = 'stdClass') : mixed
since |
11.1 |
---|
Arguments
- $cursor
mixed
The optional result set cursor from which to fetch the row.- $class
string
The class name to use for the returned row object.
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(mixed $cursor = null) : void
since |
11.1 |
---|
Arguments
- $cursor
mixed
The 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
since |
11.1 |
---|
Response
integer
The number of affected rows.
getCollation
Method to get the database collation in use by sampling a text field of a table in the database.
getCollation() : mixed
since |
11.1 |
---|
Response
mixed
The collation in use by the database or boolean false if not supported.
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
since |
11.1 |
---|
Response
resource
The underlying database connection resource.
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
since |
11.1 |
---|
Response
array
An array of available database connectors.
getCount
Get the total number of SQL statements executed by the database driver.
getCount() : integer
since |
11.1 |
---|
Response
integer
getDatabase
Gets the name of the database used by this conneciton.
getDatabase() : string
since |
11.4 |
---|
Response
string
getDateFormat
Returns a PHP date() function compliant date format for the database driver.
getDateFormat() : string
since |
11.1 |
---|
Response
string
The format string.
getErrorMsg
Gets the error message from the database connection.
getErrorMsg(boolean $escaped = false) : string
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $escaped
boolean
True to escape the message string for use in JavaScript.
Response
string
The error message for the most recent query.
getErrorNum
Gets the error number from the database connection.
getErrorNum() : integer
since |
11.1 |
---|---|
deprecated |
12.1 |
Response
integer
The error number for the most recent query.
getEscaped
Method to escape a string for usage in an SQL statement.
getEscaped(string $text, boolean $extra = false) : string
since |
11.1 |
---|---|
deprecated |
12.1 |
Arguments
- $text
string
The string to be escaped.- $extra
boolean
Optional parameter to provide extra escaping.
Response
string
The escaped string.
getExporter
Gets an exporter class object.
getExporter() : \JDatabaseExporterMySQL
getImporter
Gets an importer class object.
getImporter() : \JDatabaseImporterMySQL
getInstance
Method to return a JDatabase 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 'mysql'. 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()) : \JDatabase
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 |
---|
Arguments
- $options
array
Parameters to be passed to the database driver.
Response
\JDatabase
A database object.
getLimit
Get the row limit for the current SQL statement.
getLimit() : integer
since |
2.5.17 |
---|---|
deprecated |
3.0 Required for SQLSRV support for 2.5 only |
Response
integer
The affected row limit for the current SQL statement.
getLog
Get the database driver SQL statement log.
getLog() : array
since |
11.1 |
---|
Response
array
SQL statements executed by the database driver.
getMinimum
Get the minimum supported database version.
getMinimum() : string
since |
12.1 |
---|
Response
string
The minimum version number for the database driver.
getNullDate
Get the null or zero representation of a timestamp for the database driver.
getNullDate() : string
since |
11.1 |
---|
Response
string
Null or zero representation of a timestamp.
getNumRows
Get the number of returned rows for the previous executed SQL statement.
getNumRows(resource $cursor = null) : integer
since |
11.1 |
---|
Arguments
- $cursor
resource
An optional database cursor resource to extract the row count from.
Response
integer
The number of returned rows.
getOffset
Get the row offset for the current SQL statement.
getOffset() : integer
since |
2.5.17 |
---|---|
deprecated |
3.0 Required for SQLSRV support for 2.5 only |
Response
integer
The affected row offset to apply for the current SQL statement.
getPrefix
Get the common table prefix for the database driver.
getPrefix() : string
since |
11.1 |
---|
Response
string
The common database table prefix.
getQuery
Get the current query object or a new JDatabaseQuery object.
getQuery(boolean $new = false) : \JDatabaseQuery
since |
11.1 |
---|---|
throws |
|
Arguments
- $new
boolean
False to return the current query object, True to return a new JDatabaseQuery object.
Response
\JDatabaseQuery
The current query object or a new object extending the JDatabaseQuery class.
getTableColumns
Retrieves field information about the given tables.
getTableColumns(string $table, boolean $typeOnly = true) : array
since |
11.1 |
---|---|
throws |
|
Arguments
- $table
string
The name of the database table.- $typeOnly
boolean
True (default) to only return field types.
Response
array
An array of fields by table.
getTableCreate
Shows the table CREATE statement that creates the given tables.
getTableCreate(mixed $tables) : array
since |
11.1 |
---|---|
throws |
|
Arguments
- $tables
mixed
A table name or a list of table names.
Response
array
A list of the create SQL for the tables.
getTableFields
Retrieves field information about the given tables.
getTableFields(mixed $tables, boolean $typeOnly = true) : array
since |
11.1 |
---|---|
throws |
|
deprecated |
12.1 |
Arguments
- $tables
mixed
A table name or a list of table names.- $typeOnly
boolean
True to only return field types.
Response
array
An array of fields by table.
getTableKeys
Retrieves field information about the given tables.
getTableKeys(mixed $tables) : array
since |
11.1 |
---|---|
throws |
|
Arguments
- $tables
mixed
A table name or a list of table names.
Response
array
An array of keys for the table(s).
getTableList
Method to get an array of all tables in the database.
getTableList() : array
since |
11.1 |
---|---|
throws |
|
Response
array
An array of all the tables in the database.
getTicker
Get the total number of SQL statements executed by the database driver.
getTicker() : integer
since |
11.1 |
---|---|
deprecated |
12.1 |
Response
integer
getUTFSupport
Determine whether or not the database engine supports UTF-8 character encoding.
getUTFSupport() : boolean
since |
11.1 |
---|
Response
boolean
True if the database engine supports UTF-8 character encoding.
getVersion
Get the version of the database connector
getVersion() : string
since |
11.1 |
---|
Response
string
The database connector version.
hasUTF
Determines if the database engine supports UTF-8 character encoding.
hasUTF() : boolean
since |
11.1 |
---|---|
deprecated |
12.1 |
Response
boolean
True if supported.
insertid
Method to get the auto-incremented value from the last INSERT statement.
insertid() : integer
since |
11.1 |
---|
Response
integer
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, string $key = null) : boolean
since |
11.1 |
---|---|
throws |
|
Arguments
- $table
string
The name of the database table to insert into.- $object
- $key
string
The name of the primary key. If provided the object property is updated.
Response
boolean
True on success.
isMinimumVersion
Method to check whether the installed database version is supported by the database driver
isMinimumVersion() : boolean
since |
12.1 |
---|
Response
boolean
True if the database version is supported
isQuoted
Checks if field name needs to be quoted.
isQuoted(string $field) : boolean
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $field
string
The field name to be checked.
Response
boolean
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 |
11.1 |
---|---|
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: 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 |
|
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(integer $offset) : mixed
since |
11.1 |
---|---|
throws |
|
Arguments
- $offset
integer
The row offset to use to build the result array.
Response
mixed
The return value or null if the query failed.
loadNextObject
Method to get the next row in the result set from the database query as an object.
loadNextObject(string $class = 'stdClass') : mixed
since |
11.1 |
---|---|
throws |
|
Arguments
- $class
string
The class name to use for the returned row object.
Response
mixed
The 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
since |
11.1 |
---|---|
throws |
|
Response
mixed
The 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
since |
11.1 |
---|---|
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') : mixed
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 |
|
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 |
11.1 |
---|---|
throws |
|
Response
mixed
The return value or null if the query failed.
loadResultArray
Method to get an array of values from the $offset field in each row of the result set from the database query.
loadResultArray(integer $offset) : mixed
since |
11.1 |
---|---|
throws |
|
deprecated |
12.1 |
Arguments
- $offset
integer
The row offset to use to build the result array.
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. Columns are indexed numerically so the first column in the result set would be accessible via $row[0], etc.
loadRow() : mixed
since |
11.1 |
---|---|
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) : mixed
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 |
|
Arguments
- $key
string
The name of a field on which to key the result array.
Response
mixed
The return value or null if the query failed.
lockTable
Locks a table in the database.
lockTable(string $tableName) : \JDatabase
since |
11.4 |
---|---|
throws |
|
Arguments
- $tableName
string
The name of the table to unlock.
Response
\JDatabase
Returns this object to support chaining.
nameQuote
Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.
nameQuote(string $name) : string
since |
11.1 |
---|---|
deprecated |
12.1 |
Arguments
- $name
string
The identifier name to wrap in quotes.
Response
string
The quote wrapped name.
query
Execute the SQL statement.
query() : mixed
since |
11.1 |
---|---|
throws |
|
Response
mixed
A database cursor resource on success, boolean false on failure.
queryBatch
Execute a query batch.
queryBatch(boolean $abortOnError = true, boolean $transactionSafe = false) : mixed
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $abortOnError
boolean
Abort on error.- $transactionSafe
boolean
Transaction safe queries.
Response
mixed
A database resource if successful, false if not.
quote
Method to quote and optionally escape a string to database requirements for insertion into the database.
quote(string $text, boolean $escape = true) : string
since |
11.1 |
---|
Arguments
- $text
string
The string to quote.- $escape
boolean
True (default) to escape the string, false to leave it unchanged.
Response
string
The 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(mixed $name, mixed $as = null) : mixed
since |
11.1 |
---|
Arguments
- $name
mixed
The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.- $as
mixed
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
mixed
The quote wrapped name, same type of $name.
quoteNameStr
Quote strings coming from quoteName call.
quoteNameStr(array $strArr) : string
since |
11.3 |
---|
Arguments
- $strArr
array
Array of strings coming from quoteName dot-explosion.
Response
string
Dot-imploded string of quoted parts.
renameTable
Renames a table in the database.
renameTable(string $oldTable, string $newTable, string $backup = null, string $prefix = null) : \JDatabase
since |
11.4 |
---|---|
throws |
|
Arguments
- $oldTable
string
The name of the table to be renamed- $newTable
string
The new name for the table.- $backup
string
Table prefix- $prefix
string
For the table - used to rename constraints in non-mysql databases
Response
\JDatabase
Returns 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
since |
11.1 |
---|
Arguments
- $sql
string
The SQL statement to prepare.- $prefix
string
The common table prefix.
Response
string
The processed SQL statement.
select
Select a database for use.
select(string $database) : boolean
since |
11.1 |
---|---|
throws |
|
Arguments
- $database
string
The name of the database to select for use.
Response
boolean
True if the database was successfully selected.
setDebug
Sets the database debugging state for the driver.
setDebug(boolean $level) : boolean
since |
11.1 |
---|
Arguments
- $level
boolean
True to enable debugging.
Response
boolean
The old debugging level.
setQuery
Sets the SQL statement string for later execution.
setQuery(mixed $query, integer $offset, integer $limit) : \JDatabase
since |
11.1 |
---|
Arguments
- $query
mixed
The SQL statement to set either as a JDatabaseQuery object or a string.- $offset
integer
The affected row offset to set.- $limit
integer
The maximum affected rows to set.
Response
\JDatabase
This object to support method chaining.
setUTF
Set the connection to use UTF-8 character encoding.
setUTF() : boolean
since |
11.1 |
---|
Response
boolean
True on success.
splitSql
Splits a string of multiple queries into an array of individual queries.
splitSql(string $sql) : array
since |
11.1 |
---|
Arguments
- $sql
string
Input SQL string with which to split into individual queries.
Response
array
The 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
deprecated |
12.1 |
---|---|
since |
11.1 |
Arguments
- $showSQL
boolean
True to display the SQL statement sent to the database as well as the error.
Response
string
The error message for the most recent query.
test
Test to see if the MySQL connector is available.
test() : boolean
since |
11.1 |
---|
Response
boolean
True on success, false otherwise.
transactionCommit
Method to commit a transaction.
transactionCommit() : void
since |
11.1 |
---|---|
throws |
|
transactionRollback
Method to roll back a transaction.
transactionRollback() : void
since |
11.1 |
---|---|
throws |
|
transactionStart
Method to initialize a transaction.
transactionStart() : void
since |
11.1 |
---|---|
throws |
|
truncateTable
Method to truncate a table.
truncateTable(string $table) : void
since |
11.3 |
---|---|
throws |
|
Arguments
- $table
string
The table to truncate
unlockTables
Unlocks tables in the database.
unlockTables() : \JDatabase
updateObject
Updates a row in a table based on an object's properties.
updateObject(string $table, &$object, string $key, boolean $nulls = false) : boolean
since |
11.1 |
---|---|
throws |
|
Arguments
- $table
string
The name of the database table to update.- $object
- $key
string
The name of the primary key.- $nulls
boolean
True to update null fields or false to ignore them.
Response
boolean
True on success.
Properties
name
The name of the database driver.
since |
11.1 |
---|
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.
since |
11.1 |
---|
Type(s)
string
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.
since |
11.1 |
---|
Type(s)
string
dbMinimum
The minimum supported database version.
since |
12.1 |
---|
Type(s)
string
_database
The name of the database.
since |
11.4 |
---|
Type(s)
string
connection
The database connection resource.
since |
11.1 |
---|
Type(s)
resource
count
The number of SQL statements executed by the database driver.
since |
11.1 |
---|
Type(s)
integer
cursor
The database connection cursor from the last query.
since |
11.1 |
---|
Type(s)
resource
debug
The database driver debugging state.
since |
11.1 |
---|
Type(s)
boolean
limit
The affected row limit for the current SQL statement.
since |
11.1 |
---|
Type(s)
integer
log
The log of executed SQL statements by the database driver.
since |
11.1 |
---|
Type(s)
array
offset
The affected row offset to apply for the current SQL statement.
since |
11.1 |
---|
Type(s)
integer
sql
The current SQL statement to execute.
since |
11.1 |
---|
Type(s)
mixed
tablePrefix
The common database table prefix.
since |
11.1 |
---|
Type(s)
string
utf
True if the database engine supports UTF-8 character encoding.
since |
11.1 |
---|
Type(s)
boolean
errorNum
The database error number
since |
11.1 |
---|---|
deprecated |
12.1 |
Type(s)
integer
errorMsg
The database error message
since |
11.1 |
---|---|
deprecated |
12.1 |
Type(s)
string
hasQuoted
If true then there are fields to be quoted for the query.
since |
11.1 |
---|---|
deprecated |
12.1 |
Type(s)
boolean
quoted
The fields that are to be quoted.
since |
11.1 |
---|---|
deprecated |
12.1 |
Type(s)
array
instances
JDatabase instances container.
since |
11.1 |
---|
Type(s)
array