FixIO Documentation

Back to summary

use "io/sql";

SQLConnection class

Provides a connection to a SQL database. It is highly recommended to use the SQL token processor.

Subclasses: SQLiteDatabase, PostgreSQLConnection

Constants

SQL_TYPE_UNKNOWN
SQL_TYPE_INTEGER
SQL_TYPE_LONG
SQL_TYPE_FLOAT
SQL_TYPE_DOUBLE
SQL_TYPE_STRING
SQL_TYPE_BINARY


SQL types.

Initialization

static function create(): SQLConnection

Creates a new instance of SQLConnection class (for implementations only). Use the subclasses to connect to a particular type of SQL database.

function close()

Closes the SQL connection.

Transaction functions

function begin()

Begins a new transaction. Nested transactions work, but depending on the implementation only the topmost may have an effect.

function commit()

Commits the transaction, making the changes permanent.

function rollback()

Rollbacks the transaction, clearing any changes made in the transaction.
Note: there may be side effects such as gaps in the auto-incremented columns or sequences.

function in_transaction(): Boolean

Returns true when there is an active transaction.

Query functions

function query(query: String or ParamString, ...): ResultSet
function update(query: String or ParamString, ...)


Performs the specified SQL query or update command. The functions use the SQL token processor to provide an ability to pass parameters to the query. Only the supported types are accepted: Integer, Long, Float, Double, String and Byte[].

function int_query(query: String or ParamString, ...): Integer
function long_query(query: String or ParamString, ...): Long
function float_query(query: String or ParamString, ...): Float
function double_query(query: String or ParamString, ...): Double
function string_query(query: String or ParamString, ...): String
function binary_query(query: String or ParamString, ...): Byte[]


Variants of the query for obtaining just a single result of given type.

function row_query(query: String or ParamString, ...): ResultSet


A variant of the query that returns a single row (must be present).

function last_insert_id(): Long

Returns the last used value of an auto-incremented column.

SQLConnection interface

static function create(): SQLConnection
virtual function close()
virtual function begin()
virtual function commit()
virtual function rollback()
virtual function in_transaction(): Boolean
virtual function query(query: String, sig: String, params: Dynamic[]): ResultSet
virtual function update(query: String, sig: String, params: Dynamic[])
virtual function last_insert_id(): Long


The parameters in queries are internally passed with a signature string. Each letter represents a single parameter of given type:
i - integer
l - long
f - float
d - double
s - string
b - binary