https://www.sqlite.org/c3ref/open.html
This sets the 'Ptr CDatabase' even on failure.
Moduledirect-sqlite-2.3.29Haskell2010
Database.SQLite3.Bindings
Contents
- Connection management
- Simple query execution
- Statement management
- Parameter and column information
- Binding Values To Prepared Statements
- Result Values From A Query
- Result statistics
- Create Or Redefine SQL Functions
- Obtaining SQL Function Parameter Values
- Setting The Result Of An SQL Function
- Define New Collating Sequences
- Miscellaneous
- Extensions
- Write-Ahead Log Commit Hook
- Incremental blob I/O
- Online Backup API
Synopsis
- value c_sqlite3_open
- value c_sqlite3_open_v2
- value c_sqlite3_close
- value c_sqlite3_errcode
- value c_sqlite3_extended_errcode
- value c_sqlite3_errmsg
- value c_sqlite3_extended_result_codes
- value c_sqlite3_interrupt
- value c_sqlite3_trace
- type CTraceCallback
- value mkCTraceCallback
- value c_sqlite3_get_autocommit
- value c_sqlite3_enable_shared_cache
- value c_sqlite3_exec
- type CExecCallback
- value mkCExecCallback
- value c_sqlite3_prepare_v2
- value c_sqlite3_db_handle
- value c_sqlite3_step
- value c_sqlite3_step_unsafe
- value c_sqlite3_reset
- value c_sqlite3_finalize
- value c_sqlite3_clear_bindings
- value c_sqlite3_sql
- value c_sqlite3_bind_parameter_count
- value c_sqlite3_bind_parameter_name
- value c_sqlite3_bind_parameter_index
- value c_sqlite3_column_count
- value c_sqlite3_column_name
- value c_sqlite3_bind_blob
- value c_sqlite3_bind_zeroblob
- value c_sqlite3_bind_text
- value c_sqlite3_bind_double
- value c_sqlite3_bind_int64
- value c_sqlite3_bind_null
- value c_sqlite3_column_type
- value c_sqlite3_column_bytes
- value c_sqlite3_column_blob
- value c_sqlite3_column_int64
- value c_sqlite3_column_double
- value c_sqlite3_column_text
- value c_sqlite3_last_insert_rowid
- value c_sqlite3_changes
- value c_sqlite3_total_changes
- value c_sqlite3_create_function_v2
- type CFunc
- type CFuncFinal
- type CFuncDestroy
- value mkCFunc
- value mkCFuncFinal
- value mkCFuncDestroy
- value c_sqlite3_user_data
- value c_sqlite3_context_db_handle
- value c_sqlite3_aggregate_context
- value c_sqlite3_value_type
- value c_sqlite3_value_bytes
- value c_sqlite3_value_blob
- value c_sqlite3_value_text
- value c_sqlite3_value_int64
- value c_sqlite3_value_double
- value c_sqlite3_result_null
- value c_sqlite3_result_blob
- value c_sqlite3_result_zeroblob
- value c_sqlite3_result_text
- value c_sqlite3_result_int64
- value c_sqlite3_result_double
- value c_sqlite3_result_value
- value c_sqlite3_result_error
- value c_sqlite3_create_collation_v2
- type CCompare
- value mkCCompare
- value c_sqlite3_free
- value c_sqlite3_free_p
- value c_sqlite3_enable_load_extension
- value c_sqlite3_wal_hook
- type CWalHook
- value mkCWalHook
- value c_sqlite3_blob_open
- value c_sqlite3_blob_close
- value c_sqlite3_blob_reopen
- value c_sqlite3_blob_bytes
- value c_sqlite3_blob_read
- value c_sqlite3_blob_write
- value c_sqlite3_backup_init
- value c_sqlite3_backup_finish
- value c_sqlite3_backup_step
- value c_sqlite3_backup_remaining
- value c_sqlite3_backup_pagecount
- Packagedirect-sqlite-2.3.29
- Exports88
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceBindings.hs
Connection management
https://www.sqlite.org/c3ref/open.html
This sets the 'Ptr CDatabase' even on failure.
value
c_sqlite3_trace Simple query execution
value
c_sqlite3_exec 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
value
c_sqlite3_prepare_v2 :: Ptr CDatabase-> CStringSQL statement, UTF-8 encoded.
-> CNumBytesMaximum 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 CStringOUT: 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.
https://www.sqlite.org/c3ref/reset.html
Warning: If the most recent c_sqlite3_step call failed, this will return the corresponding error code.
https://www.sqlite.org/c3ref/finalize.html
Warning: If the most recent c_sqlite3_step call failed, this will return the corresponding error code.
https://www.sqlite.org/c3ref/clear_bindings.html
A look at the source reveals that this function always returns SQLITE_OK.
Parameter and column information
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.
Binding Values To Prepared Statements
value
c_sqlite3_bind_blob :: Ptr CStatement-> CParamIndexIndex of the SQL parameter to be set
-> Ptr aValue to bind to the parameter.
Warning: If this pointer is
NULL, this will bind a null value, rather than an empty blob.-> CNumBytesLength, in bytes. This must not be negative.
-> Ptr CDestructor-> IO CError
value
c_sqlite3_bind_text :: Ptr CStatement-> CParamIndex-> CStringWarning: If this pointer is
NULL, this will bind a null value, rather than an empty text.-> CNumBytesLength, in bytes. If this is negative, the value is treated as a NUL-terminated string.
-> Ptr CDestructor-> IO CError
Result Values From A Query
Result statistics
Create Or Redefine SQL Functions
Obtaining SQL Function Parameter Values
Setting The Result Of An SQL Function
Define New Collating Sequences
Miscellaneous
Extensions
Write-Ahead Log Commit Hook
Incremental blob I/O
value
c_sqlite3_blob_open