Difference between revisions of "JDatabaseSQLAzure"
From Joomla! Documentation
(Updated to r1448:247ba8d88526) |
m (preparing for archive only) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
=={{JVer|11.1}} JDatabaseSQLAzure== | =={{JVer|11.1}} JDatabaseSQLAzure== | ||
===Description=== | ===Description=== | ||
− | + | ||
− | + | ||
− | |||
− | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::__destruct | + | |[[API17:JDatabaseSQLAzure::__destruct|__destruct]] |
|Destructor. | |Destructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::connected | + | |[[API17:JDatabaseSQLAzure::connected|connected]] |
|Determines if the connection to the server is active. | |Determines if the connection to the server is active. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::dateToString | + | |[[API17:JDatabaseSQLAzure::dateToString|dateToString]] |
|Method to get a object represented as a datetime string in a format recognized by the database server. | |Method to get a object represented as a datetime string in a format recognized by the database server. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::explain | + | |[[API17:JDatabaseSQLAzure::explain|explain]] |
|Diagnostic method to return explain information for a query. | |Diagnostic method to return explain information for a query. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getAffectedRows | + | |[[API17:JDatabaseSQLAzure::getAffectedRows|getAffectedRows]] |
|Get the number of affected rows for the previous executed SQL statement. | |Get the number of affected rows for the previous executed SQL statement. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getCollation | + | |[[API17:JDatabaseSQLAzure::getCollation|getCollation]] |
|Method to get the database collation in use by sampling a text field of a table in the database. | |Method to get the database collation in use by sampling a text field of a table in the database. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getEscaped | + | |[[API17:JDatabaseSQLAzure::getEscaped|getEscaped]] |
|Method to escape a string for usage in an SQL statement. | |Method to escape a string for usage in an SQL statement. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getExporter | + | |[[API17:JDatabaseSQLAzure::getExporter|getExporter]] |
|Gets an exporter class object. | |Gets an exporter class object. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getImporter | + | |[[API17:JDatabaseSQLAzure::getImporter|getImporter]] |
|Gets an importer class object. | |Gets an importer class object. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getNumRows | + | |[[API17:JDatabaseSQLAzure::getNumRows|getNumRows]] |
|Get the number of returned rows for the previous executed SQL statement. | |Get the number of returned rows for the previous executed SQL statement. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getQuery | + | |[[API17:JDatabaseSQLAzure::getQuery|getQuery]] |
|Get the current or query, or new object. | |Get the current or query, or new object. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getTableCreate | + | |[[API17:JDatabaseSQLAzure::getTableCreate|getTableCreate]] |
|Shows the table CREATE statement that creates the given tables. | |Shows the table CREATE statement that creates the given tables. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getTableFields | + | |[[API17:JDatabaseSQLAzure::getTableFields|getTableFields]] |
|Retrieves field information about the given tables. | |Retrieves field information about the given tables. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getTableList | + | |[[API17:JDatabaseSQLAzure::getTableList|getTableList]] |
|Method to get an array of all tables in the database. | |Method to get an array of all tables in the database. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::getVersion | + | |[[API17:JDatabaseSQLAzure::getVersion|getVersion]] |
|Get the version of the database connector. | |Get the version of the database connector. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::hasUTF | + | |[[API17:JDatabaseSQLAzure::hasUTF|hasUTF]] |
|Determines if the database engine supports UTF-8 character encoding. | |Determines if the database engine supports UTF-8 character encoding. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::insertid | + | |[[API17:JDatabaseSQLAzure::insertid|insertid]] |
|Method to get the auto-incremented value from the last INSERT statement. | |Method to get the auto-incremented value from the last INSERT statement. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::query | + | |[[API17:JDatabaseSQLAzure::query|query]] |
|Execute the SQL statement. | |Execute the SQL statement. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::queryBatch | + | |[[API17:JDatabaseSQLAzure::queryBatch|queryBatch]] |
|Execute a query batch. | |Execute a query batch. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::select | + | |[[API17:JDatabaseSQLAzure::select|select]] |
|Select a database for use. | |Select a database for use. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::setUTF | + | |[[API17:JDatabaseSQLAzure::setUTF|setUTF]] |
|Set the connection to use UTF-8 character encoding. | |Set the connection to use UTF-8 character encoding. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::transactionCommit | + | |[[API17:JDatabaseSQLAzure::transactionCommit|transactionCommit]] |
|Method to commit a transaction. | |Method to commit a transaction. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::transactionRollback | + | |[[API17:JDatabaseSQLAzure::transactionRollback|transactionRollback]] |
|Method to roll back a transaction. | |Method to roll back a transaction. | ||
|- | |- | ||
|public | |public | ||
− | |[[JDatabaseSQLAzure::transactionStart | + | |[[API17:JDatabaseSQLAzure::transactionStart|transactionStart]] |
|Method to initialize a transaction. | |Method to initialize a transaction. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JDatabaseSQLAzure::test | + | |[[API17:JDatabaseSQLAzure::test|test]] |
|Test to see if the SQLSRV connector is available. | |Test to see if the SQLSRV connector is available. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JDatabaseSQLAzure::__construct | + | |[[API17:JDatabaseSQLAzure::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JDatabaseSQLAzure::fetchArray | + | |[[API17:JDatabaseSQLAzure::fetchArray|fetchArray]] |
|Method to fetch a row from the result set cursor as an array. | |Method to fetch a row from the result set cursor as an array. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JDatabaseSQLAzure::fetchAssoc | + | |[[API17:JDatabaseSQLAzure::fetchAssoc|fetchAssoc]] |
|Method to fetch a row from the result set cursor as an associative array. | |Method to fetch a row from the result set cursor as an associative array. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JDatabaseSQLAzure::fetchObject | + | |[[API17:JDatabaseSQLAzure::fetchObject|fetchObject]] |
|Method to fetch a row from the result set cursor as an object. | |Method to fetch a row from the result set cursor as an object. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JDatabaseSQLAzure::freeResult | + | |[[API17:JDatabaseSQLAzure::freeResult|freeResult]] |
|Method to free up the memory used for the result set. | |Method to free up the memory used for the result set. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/database/database/sqlazure.php | * '''Defined in''' libraries/joomla/database/database/sqlazure.php | ||
− | * '''Extends''' [[JDatabase | + | * '''Extends''' [[API17:JDatabase|JDatabase]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.database.database.sqlazure' );</source> | <source lang="php">jimport( 'joomla.database.database.sqlazure' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JDatabaseSQLAzure source code''' on [[jplatform:database/database/sqlazure.php|BitBucket]] | * {{JVer|11.1}} '''JDatabaseSQLAzure source code''' on [[jplatform:database/database/sqlazure.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Database | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Database|Database]] |
− | * [[JDatabaseSQLAzure|Other versions of JDatabaseSQLAzure]] | + | * [[API17:JDatabaseSQLAzure|Other versions of JDatabaseSQLAzure]] |
− | + | ||
− | + | ||
− | |||
− | |||
===User contributed notes=== | ===User contributed notes=== | ||
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JDatabaseSQLAzure | category=JDatabaseSQLAzure | ||
− | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Line 157: | Line 153: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 21:48, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JDatabaseSQLAzure[edit]
Description[edit]
Methods[edit]
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 SQLSRV 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/sqlazure.php
- Extends JDatabase
Importing[edit]
jimport( 'joomla.database.database.sqlazure' );
See also[edit]
- JDatabaseSQLAzure source code on BitBucket
- Subpackage Database
- Other versions of JDatabaseSQLAzure
User contributed notes[edit]
Code Examples[edit]