Database.SQLite3.Bindings

Documentation

module Database.SQLite3.Bindings.Types

Connection management

c_sqlite3_open :: CString -> Ptr (Ptr CDatabase) -> IO CError

http://www.sqlite.org/c3ref/open.html

This sets the 'Ptr CDatabase' even on failure.

c_sqlite3_close :: Ptr CDatabase -> IO CError

http://www.sqlite.org/c3ref/close.html

c_sqlite3_errmsg :: Ptr CDatabase -> IO CString

http://www.sqlite.org/c3ref/errcode.html

c_sqlite3_interrupt :: Ptr CDatabase -> IO ()

http://www.sqlite.org/c3ref/interrupt.html

c_sqlite3_trace

Arguments

:: Ptr CDatabase

-> FunPtr (CTraceCallback a)

Optional callback function called for each row

-> Ptr a

Context passed to the callback

-> IO (Ptr ())

Returns context pointer from previously registered trace

http://www.sqlite.org/c3ref/profile.html

type CTraceCallback a

Arguments

 = Ptr a

-> CString

UTF-8 rendering of the SQL statement text as the statement first begins executing

-> IO ()

mkCTraceCallback :: CTraceCallback a -> IO (FunPtr (CTraceCallback a))

Simple query execution

http://sqlite.org/c3ref/exec.html

c_sqlite3_exec

Arguments

:: Ptr CDatabase

-> CString

SQL statement, UTF-8 encoded

-> FunPtr (CExecCallback a)

Optional callback function called for each row

-> Ptr a

Context passed to the callback

-> Ptr CString

OUT: Error message string

-> IO CError

type CExecCallback a

Arguments

 = Ptr a

-> CColumnCount

Number of columns, which is the number of elements in the following arrays.

-> Ptr CString

Array of column values, as returned by c_sqlite3_column_text. Null values are represented as null pointers.

-> Ptr CString

Array of column names

-> IO CInt

If the callback returns non-zero, then c_sqlite3_exec returns SQLITE_ABORT (ErrorAbort).

mkCExecCallback :: CExecCallback a -> IO (FunPtr (CExecCallback a))

A couple important things to know about callbacks from Haskell code:

• If the callback throws an exception, apparently, the whole program is terminated.
• Remember to call freeHaskellFunPtr when you are done with the wrapper, to avoid leaking memory.

Statement management

c_sqlite3_prepare_v2

Arguments

:: Ptr CDatabase

-> CString

SQL statement, UTF-8 encoded

-> CNumBytes

Maximum length of the SQL statement, in bytes. If this is negative, then the SQL statement is treated as a NUL-terminated string.

-> Ptr (Ptr CStatement)

OUT: Statement handle. This must not be null.

-> Ptr CString

OUT: Pointer to unused portion of zSql

-> IO CError

http://www.sqlite.org/c3ref/prepare.html

If the query contains no SQL statements, this returns SQLITE_OK and sets the Ptr CStatement to null.

c_sqlite3_db_handle :: Ptr CStatement -> IO (Ptr CDatabase)

http://www.sqlite.org/c3ref/db_handle.html

c_sqlite3_step :: Ptr CStatement -> IO CError

http://www.sqlite.org/c3ref/step.html

c_sqlite3_reset :: Ptr CStatement -> IO CError

http://www.sqlite.org/c3ref/reset.html

Warning: If the most recent c_sqlite3_step call failed, this will return the corresponding error code.

c_sqlite3_finalize :: Ptr CStatement -> IO CError

http://www.sqlite.org/c3ref/finalize.html

Warning: If the most recent c_sqlite3_step call failed, this will return the corresponding error code.

c_sqlite3_clear_bindings :: Ptr CStatement -> IO CError

http://www.sqlite.org/c3ref/clear_bindings.html

A look at the source reveals that this function always returns SQLITE_OK.

c_sqlite3_sql :: Ptr CStatement -> IO CString

http://www.sqlite.org/c3ref/sql.html

Parameter and column information

c_sqlite3_bind_parameter_count :: Ptr CStatement -> IO CParamIndex

http://www.sqlite.org/c3ref/bind_parameter_count.html

This returns the index of the largest (rightmost) parameter, which is not necessarily the number of parameters. If numbered parameters like ?5 are used, there may be gaps in the list.

c_sqlite3_bind_parameter_name :: Ptr CStatement -> CParamIndex -> IO CString

http://www.sqlite.org/c3ref/bind_parameter_name.html

c_sqlite3_column_count :: Ptr CStatement -> IO CColumnCount

http://www.sqlite.org/c3ref/column_count.html

Binding Values To Prepared Statements

http://www.sqlite.org/c3ref/bind_blob.html

c_sqlite3_bind_blob

Arguments

:: Ptr CStatement

-> CParamIndex

Index of the SQL parameter to be set

-> Ptr a

Value to bind to the parameter.

Warning: If this pointer is NULL, this will bind a null value, rather than an empty blob.

-> CNumBytes

Length, in bytes. This must not be negative.

-> Ptr CDestructor

-> IO CError

c_sqlite3_bind_text

Arguments

:: Ptr CStatement

-> CParamIndex

-> CString

Warning: If this pointer is NULL, this will bind a null value, rather than an empty text.

-> CNumBytes

Length, in bytes. If this is negative, the value is treated as a NUL-terminated string.

-> Ptr CDestructor

-> IO CError

c_sqlite3_bind_double :: Ptr CStatement -> CParamIndex -> Double -> IO CError

c_sqlite3_bind_int64 :: Ptr CStatement -> CParamIndex -> Int64 -> IO CError

c_sqlite3_bind_null :: Ptr CStatement -> CParamIndex -> IO CError

Result Values From A Query

http://www.sqlite.org/c3ref/column_blob.html

c_sqlite3_column_type :: Ptr CStatement -> CColumnIndex -> IO CColumnType

c_sqlite3_column_bytes :: Ptr CStatement -> CColumnIndex -> IO CNumBytes

c_sqlite3_column_blob :: Ptr CStatement -> CColumnIndex -> IO (Ptr a)

c_sqlite3_column_int64 :: Ptr CStatement -> CColumnIndex -> IO Int64

c_sqlite3_column_double :: Ptr CStatement -> CColumnIndex -> IO Double

c_sqlite3_column_text :: Ptr CStatement -> CColumnIndex -> IO CString

Result statistics

c_sqlite3_last_insert_rowid :: Ptr CDatabase -> IO Int64

http://www.sqlite.org/c3ref/last_insert_rowid.html

c_sqlite3_changes :: Ptr CDatabase -> IO CInt

http://www.sqlite.org/c3ref/changes.html

c_sqlite3_total_changes :: Ptr CDatabase -> IO CInt

http://www.sqlite.org/c3ref/total_changes.html

Miscellaneous

c_sqlite3_free :: Ptr a -> IO ()

http://sqlite.org/c3ref/free.html