Database.SQLite3.Bindings · direct-sqlite-2.3.29

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

8 declarations

valuec_sqlite3_prepare_v2

:: 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

#

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

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

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

#

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

valuec_sqlite3_step :: Ptr CStatement -> IO CError

#

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

valuec_sqlite3_step_unsafe :: Ptr CStatement -> IO CError

#

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

valuec_sqlite3_reset :: Ptr CStatement -> IO CError

#

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

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

valuec_sqlite3_finalize :: Ptr CStatement -> IO CError

#

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

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

valuec_sqlite3_clear_bindings :: Ptr CStatement -> IO CError

#

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

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

valuec_sqlite3_sql :: Ptr CStatement -> IO CString

#

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

Parameter and column information

5 declarations

valuec_sqlite3_bind_parameter_count :: Ptr CStatement -> IO CParamIndex

#

https://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.

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

#

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

valuec_sqlite3_bind_parameter_index

#

https://www.sqlite.org/c3ref/bind_parameter_index.html

valuec_sqlite3_column_count :: Ptr CStatement -> IO CColumnCount

#

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

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

#

https://www.sqlite.org/c3ref/column_name.html

Binding Values To Prepared Statements

6 declarations

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

valuec_sqlite3_bind_blob

:: 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

#

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

valuec_sqlite3_bind_zeroblob

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

#

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

valuec_sqlite3_bind_text

:: 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

#

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

valuec_sqlite3_bind_double

#

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

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

#

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

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

#

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

Result Values From A Query

6 declarations

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

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

#

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

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

#

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

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

#

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

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

#

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

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

#

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

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

#

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

Result statistics

3 declarations

valuec_sqlite3_last_insert_rowid :: Ptr CDatabase -> IO Int64

#

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

valuec_sqlite3_changes :: Ptr CDatabase -> IO CInt

#

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

valuec_sqlite3_total_changes :: Ptr CDatabase -> IO CInt

#

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

Create Or Redefine SQL Functions

10 declarations

valuec_sqlite3_create_function_v2

:: Ptr CDatabase
-> CString
Name of the function.
-> CArgCount
Number of arguments.
-> CInt
Preferred text encoding (also used to pass flags).
-> Ptr a
User data.
-> FunPtr CFunc
-> FunPtr CFunc
-> FunPtr CFuncFinal
-> FunPtr (CFuncDestroy a)
-> IO CError

#

https://sqlite.org/c3ref/create_function.html

typetype CFunc = Ptr CContext -> CArgCount -> Ptr (Ptr CValue) -> IO ()

#

typetype CFuncFinal = Ptr CContext -> IO ()

#

typetype CFuncDestroy a = Ptr a -> IO ()

#

valuemkCFunc :: CFunc -> IO (FunPtr CFunc)

#

valuemkCFuncFinal :: CFuncFinal -> IO (FunPtr CFuncFinal)

#

valuemkCFuncDestroy :: CFuncDestroy a -> IO (FunPtr (CFuncDestroy a))

#

valuec_sqlite3_user_data :: Ptr CContext -> IO (Ptr a)

#

https://www.sqlite.org/c3ref/user_data.html

valuec_sqlite3_context_db_handle :: Ptr CContext -> IO (Ptr CDatabase)

#

https://www.sqlite.org/c3ref/context_db_handle.html

valuec_sqlite3_aggregate_context :: Ptr CContext -> CNumBytes -> IO (Ptr a)

#

https://www.sqlite.org/c3ref/aggregate_context.html

Obtaining SQL Function Parameter Values

6 declarations

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_type :: Ptr CValue -> IO CColumnType

#

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_bytes :: Ptr CValue -> IO CNumBytes

#

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_blob :: Ptr CValue -> IO (Ptr a)

#

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_text :: Ptr CValue -> IO CString

#

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_int64 :: Ptr CValue -> IO Int64

#

https://www.sqlite.org/c3ref/value_blob.html

valuec_sqlite3_value_double :: Ptr CValue -> IO Double

#

https://www.sqlite.org/c3ref/value_blob.html

Setting The Result Of An SQL Function

8 declarations

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_null :: Ptr CContext -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_blob

:: Ptr CContext
-> Ptr a
-> CNumBytes
-> Ptr CDestructor
-> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_zeroblob :: Ptr CContext -> CNumBytes -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_text

:: Ptr CContext
-> CString
-> CNumBytes
-> Ptr CDestructor
-> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_int64 :: Ptr CContext -> Int64 -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_double :: Ptr CContext -> Double -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_value :: Ptr CContext -> Ptr CValue -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

valuec_sqlite3_result_error :: Ptr CContext -> CString -> CNumBytes -> IO ()

#

https://www.sqlite.org/c3ref/result_blob.html

Define New Collating Sequences

3 declarations

valuec_sqlite3_create_collation_v2

:: Ptr CDatabase
-> CString
Name of the collation.
-> CInt
Text encoding.
-> Ptr a
User data.
-> FunPtr (CCompare a)
-> FunPtr (CFuncDestroy a)
-> IO CError

#

https://www.sqlite.org/c3ref/create_collation.html

typetype CCompare a = Ptr a -> CNumBytes -> CString -> CNumBytes -> CString -> IO CInt

#

valuemkCCompare :: CCompare a -> IO (FunPtr (CCompare a))

#

Miscellaneous

2 declarations

valuec_sqlite3_free :: Ptr a -> IO ()

#

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

valuec_sqlite3_free_p :: FunPtr (Ptr a -> IO ())

#

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

Extensions

1 declaration

valuec_sqlite3_enable_load_extension :: Ptr CDatabase -> Bool -> IO CError

#

https://sqlite.org/c3ref/enable_load_extension.html

Write-Ahead Log Commit Hook

3 declarations

valuec_sqlite3_wal_hook

:: Ptr CDatabase
-> FunPtr CWalHook
-> Ptr a
-> IO (Ptr ())

#

https://www.sqlite.org/c3ref/wal_hook.html

typetype CWalHook = Ptr () -> Ptr CDatabase -> CString -> CInt -> IO CError

#

valuemkCWalHook :: CWalHook -> IO (FunPtr CWalHook)

#

Incremental blob I/O

6 declarations

valuec_sqlite3_blob_open

:: Ptr CDatabase
-> CString
Database name.
-> CString
Table name.
-> CString
Column name.
-> Int64
Row ROWID.
-> CInt
Flags.
-> Ptr (Ptr CBlob)
OUT: Blob handle, will be NULL on error.
-> IO CError

#

https://www.sqlite.org/c3ref/blob_open.html

valuec_sqlite3_blob_close :: Ptr CBlob -> IO CError

#

https://www.sqlite.org/c3ref/blob_close.html

valuec_sqlite3_blob_reopen :: Ptr CBlob -> Int64 -> IO CError

#

https://www.sqlite.org/c3ref/blob_reopen.html

valuec_sqlite3_blob_bytes :: Ptr CBlob -> IO CInt

#

https://www.sqlite.org/c3ref/blob_bytes.html

valuec_sqlite3_blob_read :: Ptr CBlob -> Ptr a -> CInt -> CInt -> IO CError

#

https://www.sqlite.org/c3ref/blob_read.html

valuec_sqlite3_blob_write :: Ptr CBlob -> Ptr a -> CInt -> CInt -> IO CError

#

https://www.sqlite.org/c3ref/blob_write.html

Online Backup API

5 declarations

https://www.sqlite.org/backup.html and https://www.sqlite.org/c3ref/backup_finish.html

valuec_sqlite3_backup_init

:: Ptr CDatabase
Destination database handle.
-> CString
Destination database name.
-> Ptr CDatabase
Source database handle.
-> CString
Source database name.
-> IO (Ptr CBackup)

#

https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backupinit

valuec_sqlite3_backup_finish :: Ptr CBackup -> IO CError

#

https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backupfinish

valuec_sqlite3_backup_step :: Ptr CBackup -> CInt -> IO CError

#

https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backupstep

valuec_sqlite3_backup_remaining :: Ptr CBackup -> IO CInt

#

https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backupremaining

valuec_sqlite3_backup_pagecount :: Ptr CBackup -> IO CInt

#

https://www.sqlite.org/c3ref/backup_finish.html#sqlite3backuppagecount