HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Moduledirect-sqlite-2.3.29Haskell2010

Database.SQLite3.Bindings.Types

  • 21 types
  • 1 class
  • 8 values

Objects

6 declarations

Enumerations

0 declarations

Error

valuedecodeError :: CError -> Error
#

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.

datadata Error
#

Constructors

Instances5Eq, Show, Generic, FFIType, Rep

ColumnType

Indices

3 declarations
newtypenewtype ParamIndex
#

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

Instances9Bounded, Enum, Eq, Integral, Num, Ord, …
  • Bounded ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • Enum ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show ParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ParamIndex CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
newtypenewtype ColumnIndex
#

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

Constructors

Instances9Bounded, Enum, Eq, Integral, Num, Ord, …
  • Bounded ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • Enum ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show ColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ColumnIndex CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

Indices (FFI)

newtypenewtype CParamIndex
#

Constructors

Instances8Enum, Eq, Integral, Num, Ord, Real, …
  • Enum CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ParamIndex CParamIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
newtypenewtype CColumnIndex
#

Constructors

Instances8Enum, Eq, Integral, Num, Ord, Real, …
  • Enum CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ColumnIndex CColumnIndexDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

Miscellaneous

5 declarations
newtypenewtype CNumBytes
#

Constructors

Instances7Enum, Eq, Integral, Num, Ord, Real, …
  • Enum CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show CNumBytesDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

Custom functions

4 declarations
newtypenewtype ArgCount
#

Number of arguments of a user defined SQL function.

Constructors

Instances9Bounded, Enum, Eq, Integral, Num, Ord, …
  • Bounded ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Enum ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show ArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ArgCount CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
typetype ArgIndex = ArgCount
#

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

newtypenewtype CArgCount
#

Constructors

Instances9Bounded, Enum, Eq, Integral, Num, Ord, …
  • Bounded CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Enum CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Eq CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Integral CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Num CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Ord CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Real CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types
  • Show CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

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

  • FFIType ArgCount CArgCountDefined in direct-sqlite-2.3.29 · Database.SQLite3.Bindings.Types

Conversion to and from FFI types

1 declaration
classclass FFIType public ffi | public -> ffi, ffi -> public where
#

The Database.SQLite3 and Database.SQLite3.Direct modules use higher-level representations of some types than those used in the FFI signatures (Database.SQLite3.Bindings). This typeclass helps with the conversions.

Methods

Instances5FFIType