direct-sqlite-2.3.24: Low-level binding to SQLite3. Includes UTF8 and BLOB support.

Safe HaskellNone
LanguageHaskell2010

Database.SQLite3

Contents

Synopsis

Connection management

Simple query execution

exec :: Database -> Text -> IO () Source #

Execute zero or more SQL statements delimited by semicolons.

execPrint :: Database -> Text -> IO () Source #

Like exec, but print result rows to stdout.

This is mainly for convenience when experimenting in GHCi. The output format may change in the future.

execWithCallback :: Database -> Text -> ExecCallback -> IO () Source #

Like exec, but invoke the callback for each result row.

type ExecCallback Source #

Arguments

 = ColumnCount

Number of columns, which is the number of items in the following lists. This will be the same for every row.

-> [Text]

List of column names. This will be the same for every row.

-> [Maybe Text]

List of column values, as returned by columnText.

-> IO () 

Statement management

prepare :: Database -> Text -> IO Statement Source #

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

Unlike exec, prepare only executes the first statement, and ignores subsequent statements.

If the query string contains no SQL statements, this fails.

prepareUtf8 :: Database -> Utf8 -> IO Statement Source #

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

It can help to avoid redundant Utf8 to Text conversion if you already have Utf8

If the query string contains no SQL statements, this fails.

stepNoCB :: Statement -> IO StepResult Source #

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

Faster step for statements that don't callback to Haskell functions (e.g. by using custom SQL functions).

reset :: Statement -> IO () Source #

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

Note that in the C API, sqlite3_reset returns an error code if the most recent sqlite3_step indicated an error. We do not replicate that behavior here. reset never throws an exception.

clearBindings :: Statement -> IO () Source #

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

Set all parameters in the prepared statement to null.

Parameter and column information

bindParameterCount :: Statement -> IO ParamIndex Source #

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

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

See ParamIndex for more information.

bindParameterName :: Statement -> ParamIndex -> IO (Maybe Text) Source #

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

Return the N-th SQL parameter name.

Named parameters are returned as-is. E.g. ":v" is returned as Just ":v". Unnamed parameters, however, are converted to Nothing.

Note that the parameter index starts at 1, not 0.

columnName :: Statement -> ColumnIndex -> IO (Maybe Text) Source #

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

Return the name of a result column. If the column index is out of range, return Nothing.

Binding values to a prepared statement

bindSQLData :: Statement -> ParamIndex -> SQLData -> IO () Source #

If the index is not between 1 and bindParameterCount inclusive, this fails with ErrorRange. Otherwise, it succeeds, even if the query skips this index by using numbered parameters.

Example:

> stmt <- prepare conn "SELECT ?1, ?3, ?5"
> bindSQLData stmt 1 (SQLInteger 1)
> bindSQLData stmt 2 (SQLInteger 2)
> bindSQLData stmt 6 (SQLInteger 6)
*** Exception: SQLite3 returned ErrorRange while attempting to perform bind int64.
> step stmt >> columns stmt
[SQLInteger 1,SQLNull,SQLNull]

bind :: Statement -> [SQLData] -> IO () Source #

Convenience function for binding values to all parameters. This will fail if the list has the wrong number of parameters.

bindNamed :: Statement -> [(Text, SQLData)] -> IO () Source #

Convenience function for binding named values to all parameters. This will fail if the list has the wrong number of parameters or if an unknown name is used.

Example:

stmt <- prepare conn "SELECT :foo + :bar"
bindNamed stmt [(":foo", SQLInteger 1), (":bar", SQLInteger 2)]

Reading the result row

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

Warning: column and columns will throw a DecodeError if any TEXT datum contains invalid UTF-8.

typedColumns :: Statement -> [Maybe ColumnType] -> IO [SQLData] Source #

This avoids extra API calls using the list of column types. If passed types do not correspond to the actual types, the values will be converted according to the rules at https://www.sqlite.org/c3ref/column_blob.html. If the list contains more items that number of columns, the result is undefined.

columnText :: Statement -> ColumnIndex -> IO Text Source #

This will throw a DecodeError if the datum contains invalid UTF-8. If this behavior is undesirable, you can use columnText from Database.SQLite3.Direct, which does not perform conversion to Text.

Result statistics

changes :: Database -> IO Int Source #

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

Return the number of rows that were changed, inserted, or deleted by the most recent INSERT, DELETE, or UPDATE statement.

Create custom SQL functions

createFunction Source #

Arguments

:: Database 
-> Text

Name of the function.

-> Maybe ArgCount

Number of arguments. Nothing means that the function accepts any number of arguments.

-> Bool

Is the function deterministic?

-> (FuncContext -> FuncArgs -> IO ())

Implementation of the function.

-> IO () 

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

Create a custom SQL function or redefine the behavior of an existing function. If the function is deterministic, i.e. if it always returns the same result given the same input, you can set the boolean flag to let sqlite perform additional optimizations.

createAggregate Source #

Arguments

:: Database 
-> Text

Name of the function.

-> Maybe ArgCount

Number of arguments.

-> a

Initial aggregate state.

-> (FuncContext -> FuncArgs -> a -> IO a)

Process one row and update the aggregate state.

-> (FuncContext -> a -> IO ())

Called after all rows have been processed. Can be used to construct the returned value from the aggregate state.

-> IO () 

Like createFunction except that it creates an aggregate function.

deleteFunction :: Database -> Text -> Maybe ArgCount -> IO () Source #

Delete an SQL function (scalar or aggregate).

Extract function arguments

Set the result of a function

Create custom collations

createCollation Source #

Arguments

:: Database 
-> Text

Name of the collation.

-> (Text -> Text -> Ordering)

Comparison function.

-> IO () 

deleteCollation :: Database -> Text -> IO () Source #

Delete a collation.

Interrupting a long-running query

interrupt :: Database -> IO () Source #

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

Cause any pending operation on the Database handle to stop at its earliest opportunity. This simply sets a flag and returns immediately. It does not wait for the pending operation to finish.

You'll need to compile with -threaded for this to do any good. Without -threaded, FFI calls block the whole RTS, meaning interrupt would never run at the same time as step.

interruptibly :: Database -> IO a -> IO a Source #

Make it possible to interrupt the given database operation with an asynchronous exception. This only works if the program is compiled with base >= 4.3 and -threaded.

It works by running the callback in a forked thread. If interrupted, it uses interrupt to try to stop the operation.

Incremental blob I/O

blobOpen Source #

Arguments

:: Database 
-> Text

The symbolic name of the database (e.g. "main").

-> Text

The table name.

-> Text

The column name.

-> Int64

The ROWID of the row.

-> Bool

Open the blob for read-write.

-> IO Blob 

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

Open a blob for incremental I/O.

blobRead Source #

Arguments

:: Blob 
-> Int

Number of bytes to read.

-> Int

Offset within the blob.

-> IO ByteString 

blobReadBuf :: Blob -> Ptr a -> Int -> Int -> IO () Source #

blobWrite Source #

Arguments

:: Blob 
-> ByteString 
-> Int

Offset within the blob.

-> IO () 

Online Backup API

backupInit Source #

Arguments

:: Database

Destination database handle.

-> Text

Destination database name.

-> Database

Source database handle.

-> Text

Source database name.

-> IO Backup 

Types

data Database Source #

Instances
Eq Database Source # 
Instance details

Defined in Database.SQLite3.Direct

Show Database Source # 
Instance details

Defined in Database.SQLite3.Direct

data Statement Source #

Instances
Eq Statement Source # 
Instance details

Defined in Database.SQLite3.Direct

Show Statement Source # 
Instance details

Defined in Database.SQLite3.Direct

data SQLData Source #

Instances
Eq SQLData Source # 
Instance details

Defined in Database.SQLite3

Methods

(==) :: SQLData -> SQLData -> Bool #

(/=) :: SQLData -> SQLData -> Bool #

Show SQLData Source # 
Instance details

Defined in Database.SQLite3

data SQLError Source #

Exception thrown when SQLite3 reports an error.

direct-sqlite may throw other types of exceptions if you misuse the API.

Constructors

SQLError 

Fields

data FuncContext Source #

The context in which a custom SQL function is executed.

data FuncArgs Source #

The arguments of a custom SQL function.

data Blob Source #

The type of blob handles used for incremental blob I/O

Instances
Eq Blob Source # 
Instance details

Defined in Database.SQLite3.Direct

Methods

(==) :: Blob -> Blob -> Bool #

(/=) :: Blob -> Blob -> Bool #

Show Blob Source # 
Instance details

Defined in Database.SQLite3.Direct

Methods

showsPrec :: Int -> Blob -> ShowS #

show :: Blob -> String #

showList :: [Blob] -> ShowS #

data Backup Source #

A handle for an online backup process.

Instances
Eq Backup Source # 
Instance details

Defined in Database.SQLite3.Direct

Methods

(==) :: Backup -> Backup -> Bool #

(/=) :: Backup -> Backup -> Bool #

Show Backup Source # 
Instance details

Defined in Database.SQLite3.Direct

Results and errors

data StepResult Source #

Constructors

Row 
Done 
Instances
Eq StepResult Source # 
Instance details

Defined in Database.SQLite3.Direct

Show StepResult Source # 
Instance details

Defined in Database.SQLite3.Direct

data BackupStepResult Source #

Constructors

BackupOK

There are still more pages to be copied.

BackupDone

All pages were successfully copied.

data Error Source #

Constructors

ErrorOK

Successful result

ErrorError

SQL error or missing database

ErrorInternal

Internal logic error in SQLite

ErrorPermission

Access permission denied

ErrorAbort

Callback routine requested an abort

ErrorBusy

The database file is locked

ErrorLocked

A table in the database is locked

ErrorNoMemory

A malloc() failed

ErrorReadOnly

Attempt to write a readonly database

ErrorInterrupt

Operation terminated by sqlite3_interrupt()

ErrorIO

Some kind of disk I/O error occurred

ErrorCorrupt

The database disk image is malformed

ErrorNotFound

Unknown opcode in sqlite3_file_control()

ErrorFull

Insertion failed because database is full

ErrorCan'tOpen

Unable to open the database file

ErrorProtocol

Database lock protocol error

ErrorEmpty

Database is empty

ErrorSchema

The database schema changed

ErrorTooBig

String or BLOB exceeds size limit

ErrorConstraint

Abort due to constraint violation

ErrorMismatch

Data type mismatch

ErrorMisuse

Library used incorrectly

ErrorNoLargeFileSupport

Uses OS features not supported on host

ErrorAuthorization

Authorization denied

ErrorFormat

Auxiliary database format error

ErrorRange

2nd parameter to sqlite3_bind out of range

ErrorNotADatabase

File opened that is not a database file

ErrorNotice

Notifications from sqlite3_log()

ErrorWarning

Warnings from sqlite3_log()

ErrorRow

sqlite3_step() has another row ready

ErrorDone

sqlite3_step() has finished executing

Instances
Eq Error Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Methods

(==) :: Error -> Error -> Bool #

(/=) :: Error -> Error -> Bool #

Show Error Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Methods

showsPrec :: Int -> Error -> ShowS #

show :: Error -> String #

showList :: [Error] -> ShowS #

FFIType Error CError Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Special integers

newtype ParamIndex Source #

Index of a parameter in a parameterized query. Parameter indices start from 1.

When a query is prepared, SQLite allocates an array indexed from 1 to the highest parameter index. For example:

>Right stmt <- prepare conn "SELECT ?1, ?5, ?3, ?"
>bindParameterCount stmt
ParamIndex 6

This will allocate an array indexed from 1 to 6 (? takes the highest preceding index plus one). The array is initialized with null values. When you bind a parameter with bindSQLData, it assigns a new value to one of these indices.

See https://www.sqlite.org/lang_expr.html#varparam for the syntax of parameter placeholders, and how parameter indices are assigned.

Constructors

ParamIndex Int 
Instances
Bounded ParamIndex Source #

Limit min/max bounds to fit into SQLite's native parameter ranges.

Instance details

Defined in Database.SQLite3.Bindings.Types

Enum ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Num ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Real ParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Show ParamIndex Source #

This just shows the underlying integer, without the data constructor.

Instance details

Defined in Database.SQLite3.Bindings.Types

FFIType ParamIndex CParamIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

newtype ColumnIndex Source #

Index of a column in a result set. Column indices start from 0.

Constructors

ColumnIndex Int 
Instances
Bounded ColumnIndex Source #

Limit min/max bounds to fit into SQLite's native parameter ranges.

Instance details

Defined in Database.SQLite3.Bindings.Types

Enum ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Num ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Real ColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Show ColumnIndex Source #

This just shows the underlying integer, without the data constructor.

Instance details

Defined in Database.SQLite3.Bindings.Types

FFIType ColumnIndex CColumnIndex Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

type ColumnCount = ColumnIndex Source #

Number of columns in a result set.

newtype ArgCount Source #

Number of arguments of a user defined SQL function.

Constructors

ArgCount Int 
Instances
Bounded ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Enum ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Num ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Real ArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

Show ArgCount Source #

This just shows the underlying integer, without the data constructor.

Instance details

Defined in Database.SQLite3.Bindings.Types

FFIType ArgCount CArgCount Source # 
Instance details

Defined in Database.SQLite3.Bindings.Types

type ArgIndex = ArgCount Source #

Index of an argument to a custom function. Indices start from 0.