User Tools

Site Tools


en:code:data:sql

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:code:data:sql [2016/10/09 11:10] (current)
Line 1: Line 1:
 +====== Sql ======
 +This object allows you to establish a connection to a SQL database like MySQL, PostgreSQL, SQLite and others.
  
 +===== Functions =====
 +
 +==== Sql ====
 +Constructor function.
 +
 +=== Syntax ===
 +<code javascript>​
 +var myObject = new Sql(driver);​
 +</​code>​
 +
 +=== Arguments ===
 +  - driver - ([[#​driver|Driver]]) the database driver to use
 +
 +=== Exceptions ===
 +  * (NoDatabaseDriverError) no database driver specified
 +
 +=== Example ===
 +Create a Sql object operating on a MySQL database.
 +<code javascript>​
 +var myObject = new Sql(Sql.MySQL);​
 +</​code>​
 +
 +=== Notes ===
 +On Windows only the MySQL, PostgreSQL, SQLite 3, Firebird and ODBC drivers are installed by default.
 +To see all available drivers call the [[#​drivers|drivers]] function.
 +
 +==== drivers ====
 +Returns a list of available Drivers.
 +
 +=== Syntax ===
 +<code javascript>​
 +Sql.drivers();​
 +</​code>​
 +
 +===== Methods =====
 +
 +==== connect ====
 +Opens a connection with a database.
 +
 +=== Syntax ===
 +<code javascript>​
 +myObject.connect(parameters);​
 +</​code>​
 +
 +=== Arguments ===
 +  - parameters - (object) the connection parameters
 +    * hostName - (string) the host name
 +    * port - (integer) the port to use (use the default port if not specified)
 +    * databaseName - (string) the database name (when using SQLite this is the filename of the database)
 +    * userName - (string) the user name
 +    * password - (string) the password
 +    * options - (string) connection options (see [[http://​doc.qt.nokia.com/​latest/​qsqldatabase.html#​setConnectOptions]])
 +
 +=== Returns ===
 +  * (Sql) this Sql
 +
 +=== Exceptions ===
 +  * (DatabaseDriverUnavailableError) this driver is not available
 +  * (ConnectionError) connection failed
 +
 +==== prepare ====
 +Prepare a request on the current database.
 +
 +=== Syntax ===
 +<code javascript>​
 +myObject.prepare(queryString,​ parameters);​
 +</​code>​
 +
 +=== Arguments ===
 +  - queryString - (string) the query string to prepare
 +  - parameters - (object) the prepare parameters
 +
 +=== Returns ===
 +  * (Sql) this Sql
 +
 +=== Exceptions ===
 +  * (PrepareQueryError) unable to prepare the query
 +
 +=== Example ===
 +<code javascript>​
 +myObject.prepare("​INSERT INTO myTable (id, data) VALUES(:id, :​data)",​ {
 + id: 1,
 + data: "My data"
 +});
 +</​code>​
 +
 +==== execute ====
 +Execute a prepared request or executes a request on the current database.
 +
 +=== Syntax ===
 +<code javascript>​
 +myObject.execute(queryString);​
 +</​code>​
 +<code javascript>​
 +myObject.execute();​
 +</​code>​
 +
 +=== Arguments ===
 +  - queryString - (string) the query string to execute
 +
 +=== Returns ===
 +  * (Sql) this Sql
 +
 +=== Exceptions ===
 +  * (ExecuteQueryError) failed to execute the query
 +
 +==== fetchResult ====
 +Retrieves the result of an executed request.
 +
 +=== Syntax ===
 +<code javascript>​
 +myObject.fetchResult(indexStyle);​
 +</​code>​
 +<code javascript>​
 +myObject.fetchResult();​
 +</​code>​
 +
 +=== Arguments ===
 +  - indexStyle - ([[#​indexstyle|IndexStyle]]) the fetch index style
 +
 +=== Returns ===
 +  * (Sql) this Sql
 +
 +=== Exceptions ===
 +  * (FetchError) cannot fetch the result of a non-select query
 +
 +==== disconnect ====
 +Disconnects the current database connection.
 +
 +=== Syntax ===
 +<code javascript>​
 +myObject.disconnect();​
 +</​code>​
 +
 +=== Returns ===
 +  * (Sql) this Sql
 +
 +===== Enumerations =====
 +
 +==== Driver ====
 +SQL drivers. On Windows only the MySQL, PostgreSQL, SQLite 3, Firebird and ODBC drivers are installed by default.
 +
 +=== Values ===
 +  - SQLite2: [[http://​www.sqlite.org/​|SQLite 2]]
 +  - SQLite: [[http://​www.sqlite.org/​|SQLite 3]]
 +  - PostgreSQL: [[http://​www.postgresql.org/​|PostgreSQL]] (versions 7.3 and above)
 +  - MySQL: [[http://​www.mysql.com/​|MySQL]]
 +  - ODBC: [[http://​msdn.microsoft.com/​en-us/​library/​ms710252(v=vs.85).aspx|Open Database Connectivity]] (ODBC) - Microsoft SQL Server and other ODBC-compliant databases
 +  - InterBase: [[http://​www.borland.com/​fr/​products/​interbase/​index.html|Borland InterBase]] ([[http://​www.firebirdsql.org/​|Firebird]])
 +  - OCI: [[http://​www.oracle.com/​technetwork/​database/​features/​oci/​index.html|Oracle Call Interface Driver]]
 +  - TDS: [[http://​www.sybase.com/​products/​databasemanagement/​adaptiveserverenterprise|Sybase Adaptive Server]] (obsolete)
 +  - DB2: [[http://​www-01.ibm.com/​software/​data/​db2/​|IBM DB2]] (version 7.1 and above)
 +
 +==== IndexStyle ====
 +The fetch index style.
 +
 +=== Values ===
 +  - IndexNumber:​ indexes the results by number
 +  - IndexName: indexes the results by column name
en/code/data/sql.txt ยท Last modified: 2016/10/09 11:10 (external edit)