direct-sqlite-2.3.27: Low-level binding to SQLite3. Includes UTF8 and BLOB support.
Safe Haskell None
Language Haskell2010

Database.SQLite3.Bindings.Types

Synopsis

Objects

Enumerations

Error

decodeError :: CError -> Error Source #

Note that this is a partial function. If the error code is invalid, or perhaps introduced in a newer version of SQLite but this library has not been updated to support it, the result is undefined.

To be clear, if decodeError fails, it is undefined behavior , not an exception you can handle.

Therefore, do not use direct-sqlite with a different version of SQLite than the one bundled (currently, 3.24.0). If you do, ensure that decodeError and decodeColumnType are still exhaustive.

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

ColumnType

decodeColumnType :: CColumnType -> ColumnType Source #

Note that this is a partial function. See decodeError for more information.

Indices

newtype ParamIndex Source #

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

When a query is prepare d, 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

Instances details
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

Instances details
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.

Indices (FFI)

newtype CParamIndex Source #

Instances

Instances details
Enum CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Num CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Real CParamIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Show CParamIndex 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 CColumnIndex Source #

Instances

Instances details
Enum CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Num CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Real CColumnIndex Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Show CColumnIndex 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

Miscellaneous

newtype CNumBytes Source #

Constructors

CNumBytes CInt

Instances

Instances details
Enum CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Num CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Real CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Show CNumBytes Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

c_SQLITE_STATIC :: Ptr CDestructor Source #

Tells SQLite3 that the content pointer is constant and will never change

c_SQLITE_TRANSIENT :: Ptr CDestructor Source #

Tells SQLite3 to make its own private copy of the data

Custom functions

newtype ArgCount Source #

Number of arguments of a user defined SQL function.

Constructors

ArgCount Int

Instances

Instances details
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.

newtype CArgCount Source #

Constructors

CArgCount CInt

Instances

Instances details
Bounded CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Enum CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Eq CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Integral CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Num CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Ord CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Real CArgCount Source #
Instance details

Defined in Database.SQLite3.Bindings.Types

Show CArgCount 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

c_SQLITE_DETERMINISTIC :: CInt Source #

Tells SQLite3 that the defined custom SQL function is deterministic.

Conversion to and from FFI types