API17

JDatabaseMySQL: Difference between revisions

From Joomla! Documentation

← Older edit
Doxiki2 (talk | contribs)
Bots
18,905 edits
Layout updates
m preparing for archive only
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<span class="editsection" style="font-size:76%;">
=={{JVer|11.1}} JDatabaseMySQL==
<nowiki>[</nowiki>[[Description:JDatabaseMySQL|Edit Descripton]]<nowiki>]</nowiki>
===Description===
</span>
[[JDatabaseMySQL]] is a concrete database handler class for [http://www.mysql.com/ MySQL].
{{Description:JDatabaseMySQL}}
 
===Defined in===
libraries/joomla/database/database/mysql.php
* see source code in [[jplatform:database/database/mysql.php|BitBucket]]
===Subpackage===
[[Subpackage Database/11.1|Database]]
===Extends===
[[JDatabase/11.1|JDatabase]]
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|[[JDatabaseMySQL::__construct/11.1|__construct]]
|public
|Database object constructor.  
|[[API17:JDatabaseMySQL::__destruct|__destruct]]
|Destructor.  
|-
|-
|[[JDatabaseMySQL::__destruct/11.1|__destruct]]
|public
|Database object destructor.
|[[API17:JDatabaseMySQL::connected|connected]]
|-
|[[JDatabaseMySQL::connected/11.1|connected]]
|Determines if the connection to the server is active.  
|Determines if the connection to the server is active.  
|-
|-
|[[JDatabaseMySQL::explain/11.1|explain]]
|public
|Diagnostic function.  
|[[API17:JDatabaseMySQL::dateToString|dateToString]]
|Method to get a  object represented as a datetime string in a format recognized by the database server.  
|-
|-
|[[JDatabaseMySQL::getAffectedRows/11.1|getAffectedRows]]
|public
|
|[[API17:JDatabaseMySQL::explain|explain]]
|Diagnostic method to return explain information for a query.
|-
|-
|[[JDatabaseMySQL::getCollation/11.1|getCollation]]
|public
|Assumes database collation in use by sampling one text field in one table.  
|[[API17:JDatabaseMySQL::getAffectedRows|getAffectedRows]]
|Get the number of affected rows for the previous executed SQL statement.  
|-
|-
|[[JDatabaseMySQL::getEscaped/11.1|getEscaped]]
|public
|Get a database escaped string.  
|[[API17:JDatabaseMySQL::getCollation|getCollation]]
|Method to get the database collation in use by sampling a text field of a table in the database.  
|-
|-
|[[JDatabaseMySQL::getExporter/11.1|getExporter]]
|public
|Gets an exporter class object.  
|[[API17:JDatabaseMySQL::getEscaped|getEscaped]]
|Method to escape a string for usage in an SQL statement.  
|-
|-
|[[JDatabaseMySQL::getImporter/11.1|getImporter]]
|public
|[[API17:JDatabaseMySQL::getExporter|getExporter]]
|Gets an exporter class object.  
|Gets an exporter class object.  
|-
|-
|[[JDatabaseMySQL::getNumRows/11.1|getNumRows]]
|public
|Description.  
|[[API17:JDatabaseMySQL::getImporter|getImporter]]
|Gets an importer class object.  
|-
|-
|[[JDatabaseMySQL::getTableCreate/11.1|getTableCreate]]
|public
|Shows the CREATE TABLE statement that creates the given tables.  
|[[API17:JDatabaseMySQL::getNumRows|getNumRows]]
|Get the number of returned rows for the previous executed SQL statement.  
|-
|-
|[[JDatabaseMySQL::getTableFields/11.1|getTableFields]]
|public
|Retrieves information about the given tables.  
|[[API17:JDatabaseMySQL::getQuery|getQuery]]
|Get the current or query, or new  object.  
|-
|-
|[[JDatabaseMySQL::getTableList/11.1|getTableList]]
|public
|Description.  
|[[API17:JDatabaseMySQL::getTableCreate|getTableCreate]]
|Shows the table CREATE statement that creates the given tables.  
|-
|-
|[[JDatabaseMySQL::getVersion/11.1|getVersion]]
|public
|Description.  
|[[API17:JDatabaseMySQL::getTableFields|getTableFields]]
|Retrieves field information about the given tables.  
|-
|-
|[[JDatabaseMySQL::hasUTF/11.1|hasUTF]]
|public
|Determines UTF support.  
|[[API17:JDatabaseMySQL::getTableList|getTableList]]
|Method to get an array of all tables in the database.  
|-
|-
|[[JDatabaseMySQL::insertid/11.1|insertid]]
|public
|Description.  
|[[API17:JDatabaseMySQL::getVersion|getVersion]]
|Get the version of the database connector.  
|-
|-
|[[JDatabaseMySQL::insertObject/11.1|insertObject]]
|public
|Inserts a row into a table based on an objects properties.  
|[[API17:JDatabaseMySQL::hasUTF|hasUTF]]
|Determines if the database engine supports UTF-8 character encoding.  
|-
|-
|[[JDatabaseMySQL::loadAssoc/11.1|loadAssoc]]
|public
|Fetch a result row as an associative array.  
|[[API17:JDatabaseMySQL::insertid|insertid]]
|Method to get the auto-incremented value from the last INSERT statement.  
|-
|-
|[[JDatabaseMySQL::loadAssocList/11.1|loadAssocList]]
|public
|Load a assoc list of database rows.  
|[[API17:JDatabaseMySQL::query|query]]
|Execute the SQL statement.  
|-
|-
|[[JDatabaseMySQL::loadNextObject/11.1|loadNextObject]]
|public
|Load the next row returned by the query.  
|[[API17:JDatabaseMySQL::queryBatch|queryBatch]]
|Execute a query batch.  
|-
|-
|[[JDatabaseMySQL::loadNextRow/11.1|loadNextRow]]
|public
|Load the next row returned by the query.  
|[[API17:JDatabaseMySQL::select|select]]
|Select a database for use.  
|-
|-
|[[JDatabaseMySQL::loadObject/11.1|loadObject]]
|public
|This global function loads the first row of a query into an object.  
|[[API17:JDatabaseMySQL::setUTF|setUTF]]
|Set the connection to use UTF-8 character encoding.  
|-
|-
|[[JDatabaseMySQL::loadObjectList/11.1|loadObjectList]]
|public
|Load a list of database objects.  
|[[API17:JDatabaseMySQL::transactionCommit|transactionCommit]]
|Method to commit a transaction.  
|-
|-
|[[JDatabaseMySQL::loadResult/11.1|loadResult]]
|public
|This method loads the first field of the first row returned by the query.  
|[[API17:JDatabaseMySQL::transactionRollback|transactionRollback]]
|Method to roll back a transaction.  
|-
|-
|[[JDatabaseMySQL::loadResultArray/11.1|loadResultArray]]
|public
|Load an array of single field results into an array.  
|[[API17:JDatabaseMySQL::transactionStart|transactionStart]]
|Method to initialize a transaction.  
|-
|-
|[[JDatabaseMySQL::loadRow/11.1|loadRow]]
|public static
|Description.
|[[API17:JDatabaseMySQL::test|test]]
|-
|Test to see if the MySQL connector is available.  
|[[JDatabaseMySQL::loadRowList/11.1|loadRowList]]
|Load a list of database rows (numeric column indexing).
|-
|[[JDatabaseMySQL::query/11.1|query]]
|Execute the query.  
|-
|-
|[[JDatabaseMySQL::queryBatch/11.1|queryBatch]]
|protected
|Execute a batch query.  
|[[API17:JDatabaseMySQL::__construct|__construct]]
|Constructor.  
|-
|-
|[[JDatabaseMySQL::select/11.1|select]]
|protected
|Select a database for use.  
|[[API17:JDatabaseMySQL::fetchArray|fetchArray]]
|Method to fetch a row from the result set cursor as an array.  
|-
|-
|[[JDatabaseMySQL::setUTF/11.1|setUTF]]
|protected
|Custom settings for UTF support.  
|[[API17:JDatabaseMySQL::fetchAssoc|fetchAssoc]]
|Method to fetch a row from the result set cursor as an associative array.  
|-
|-
|[[JDatabaseMySQL::test/11.1|test]]
|protected
|Test to see if the MySQL connector is available.  
|[[API17:JDatabaseMySQL::fetchObject|fetchObject]]
|Method to fetch a row from the result set cursor as an object.  
|-
|-
|[[JDatabaseMySQL::updateObject/11.1|updateObject]]
|protected
|Description.  
|[[API17:JDatabaseMySQL::freeResult|freeResult]]
|Method to free up the memory used for the result set.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/database/database/mysql.php
* '''Extends''' [[API17:JDatabase|JDatabase]]
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.database.database.mysql' );</source>
<source lang="php">jimport( 'joomla.database.database.mysql' );</source>
===See also===
===See also===
* JDatabaseMySQL source code in [[jplatform:database/database/mysql.php|BitBucket]]
* {{JVer|11.1}} '''JDatabaseMySQL source code''' on [[jplatform:database/database/mysql.php|BitBucket]]
* [[JDatabaseMySQL|Other versions of this class]]
* {{JVer|11.1}} Subpackage [[API17:Subpackage Database|Database]]
{{SeeAlso:JDatabaseMySQL}}
* [[API17:JDatabaseMySQL|Other versions of JDatabaseMySQL]]
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JDatabaseMySQL|Edit See Also]]<nowiki>]</nowiki>
 
</span>
===User contributed notes===
===Examples===
=== Code Examples ===
<CodeExamplesForm />
<dpl>
<dpl>
noresultsheader=\n
noresultsheader=\n
category=JDatabaseMySQL
category=JDatabaseMySQL
category=CodeExample
namespace=CodeExample
category=ClassExample
category=ClassExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JDatabaseMySQL]]</noinclude>
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 02:37, 25 March 2017

Joomla 11.1 JDatabaseMySQL

Description

JDatabaseMySQL is a concrete database handler class for MySQL.

Methods

Visibility Method name Description
public __destruct Destructor.
public connected Determines if the connection to the server is active.
public dateToString Method to get a object represented as a datetime string in a format recognized by the database server.
public explain Diagnostic method to return explain information for a query.
public getAffectedRows Get the number of affected rows for the previous executed SQL statement.
public getCollation Method to get the database collation in use by sampling a text field of a table in the database.
public getEscaped Method to escape a string for usage in an SQL statement.
public getExporter Gets an exporter class object.
public getImporter Gets an importer class object.
public getNumRows Get the number of returned rows for the previous executed SQL statement.
public getQuery Get the current or query, or new object.
public getTableCreate Shows the table CREATE statement that creates the given tables.
public getTableFields Retrieves field information about the given tables.
public getTableList Method to get an array of all tables in the database.
public getVersion Get the version of the database connector.
public hasUTF Determines if the database engine supports UTF-8 character encoding.
public insertid Method to get the auto-incremented value from the last INSERT statement.
public query Execute the SQL statement.
public queryBatch Execute a query batch.
public select Select a database for use.
public setUTF Set the connection to use UTF-8 character encoding.
public transactionCommit Method to commit a transaction.
public transactionRollback Method to roll back a transaction.
public transactionStart Method to initialize a transaction.
public static test Test to see if the MySQL connector is available.
protected __construct Constructor.
protected fetchArray Method to fetch a row from the result set cursor as an array.
protected fetchAssoc Method to fetch a row from the result set cursor as an associative array.
protected fetchObject Method to fetch a row from the result set cursor as an object.
protected freeResult Method to free up the memory used for the result set.
  • Defined in libraries/joomla/database/database/mysql.php
  • Extends JDatabase

Importing

jimport( 'joomla.database.database.mysql' );

See also


User contributed notes

Code Examples


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JDatabaseMySQL&oldid=384422"