Kaya 0.5.3 module reference for DB

List of modules in this version

DB module

A generic database connection and querying API. Separate database-specific modules are then used to set up connections to particular databases. Kaya currently distributes:

• MyDB (MySQL)
• PostgresDB (Postgres)
• SQLiteDB (SQLite)

Data types

• DB::DBHandle<a> - A database handle
• DB::DBIncResult<a> - An incremental query result
• DB::DBResult - A query result
• DB::DBStatement<a> - A prepared database statement
• DB::DBValue - Query result values

Exceptions

• InvalidTime - Converting to Time failed

Functions

• DBHandle<a> DBh(a handle,DBResult(a, String) exec,DBIncResult<a> (a, String, DBHandle<a> ) incexec=defaultIncExec,DBStatement<a> (DBHandle<a> , String) prep=defaultPrepare,DBResult(DBStatement<a> , [Maybe<String> ]) execp=defaultExecPrepared,DBIncResult<a> (DBStatement<a> , [Maybe<String> ]) incexecp=defaultIncExecPrepared,[DBValue](DBIncResult<a> ) getrow=defaultGetRow,Void(DBIncResult<a> ) incdiscard=defaultIncDiscard,Void(a) close=Coercions::void,String() pkey=defaultPrimaryKey) -
• Bool bool(DBValue val) - Convert a database result to a Bool
• Void close(DBHandle<a> con) - Close a connection
• String column(DBResult res,Int col) - Get a column name
• DBResult defaultExecPrepared(DBStatement<a> con,[Maybe<String> ] params) - Default function
• [DBValue] defaultGetRow(DBIncResult<a> res) - Default function
• Void defaultIncDiscard(DBIncResult<a> res) - Default function
• DBIncResult<a> defaultIncExec(a con,String query,DBHandle<a> cptr) - Default function
• DBIncResult<a> defaultIncExecPrepared(DBStatement<a> con,[Maybe<String> ] params) - Default function
• DBStatement<a> defaultPrepare(DBHandle<a> con,String query) - Default function
• String defaultPrimaryKey() -
• String escape(String val) - Escape a string to be used as part of a query
• DBResult exec(DBHandle<a> con,String query) - Execute a query
• DBResult execPrepared(DBStatement<a> statement,[Maybe<String> ] params) - Execute a prepared statement
• DBResult execPrepared(DBStatement<a> statement,[String] params) - Execute a prepared statement
• Float float(DBValue val) - Convert a database result to a Float
• a getHandle(DBHandle<a> h) - Get the raw handle
• [DBValue] getRow(DBIncResult<a> res) - Retrieve a row from an incremental query
• Void incDiscard(DBIncResult<a> res) - Discard an incremental query
• DBIncResult<a> incExec(DBHandle<a> con,String query) - Execute an incremental query
• DBIncResult<a> incExecPrepared(DBStatement<a> statement,[Maybe<String> ] params) - Incrementally execute a prepared statement
• Int int(DBValue val) - Convert a database result to an Int
• Bool isNull(DBValue val) - Check if a database result is NULL
• Maybe<a> maybeA(a(DBValue) f,DBValue val) - Convert a database result to a Maybe type
• DBStatement<a> prepare(DBHandle<a> con,String query) - Prepare a database query
• String primaryKey(DBHandle<a> db) -
• String string(DBValue val) - Convert a database result to a String
• Time time(DBValue val) - Convert a database result to a Time