Database.SQLCipher.Types

Objects, types and constants used in the SQLCipher binding.

Documentation

type SQLiteInt64 = Int64

type SQLiteWord64 = Word64

newtype SQLite

An open SQLite database object.

Constructors

SQLite (Ptr ())

Instances

Storable SQLite

Methods

sizeOf :: SQLite -> Int

alignment :: SQLite -> Int

peekElemOff :: Ptr SQLite -> Int -> IO SQLite

pokeElemOff :: Ptr SQLite -> Int -> SQLite -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLite

pokeByteOff :: Ptr b -> Int -> SQLite -> IO ()

peek :: Ptr SQLite -> IO SQLite

poke :: Ptr SQLite -> SQLite -> IO ()

newtype SQLiteStmt

An instance of this object represent single SQL statements. This object is variously known as a "prepared statement" or a "compiled SQL statement" or simply as a "statement".

Constructors

SQLiteStmt (Ptr ())

Instances

Storable SQLiteStmt

Methods

sizeOf :: SQLiteStmt -> Int

alignment :: SQLiteStmt -> Int

peekElemOff :: Ptr SQLiteStmt -> Int -> IO SQLiteStmt

pokeElemOff :: Ptr SQLiteStmt -> Int -> SQLiteStmt -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteStmt

pokeByteOff :: Ptr b -> Int -> SQLiteStmt -> IO ()

peek :: Ptr SQLiteStmt -> IO SQLiteStmt

poke :: Ptr SQLiteStmt -> SQLiteStmt -> IO ()

newtype SQLiteValue

SQLite uses the sqlite3_value object to represent all values that are or can be stored in a database table. SQLite uses dynamic typing for the values it stores. Values stored in sqlite3_value objects can be be integers, floating point values, strings, BLOBs, or NULL.

Constructors

SQLiteValue (Ptr ())

Instances

Storable SQLiteValue

Methods

sizeOf :: SQLiteValue -> Int

alignment :: SQLiteValue -> Int

peekElemOff :: Ptr SQLiteValue -> Int -> IO SQLiteValue

pokeElemOff :: Ptr SQLiteValue -> Int -> SQLiteValue -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteValue

pokeByteOff :: Ptr b -> Int -> SQLiteValue -> IO ()

peek :: Ptr SQLiteValue -> IO SQLiteValue

poke :: Ptr SQLiteValue -> SQLiteValue -> IO ()

IsValue SQLiteValue

Methods

fromSQLiteValue :: SQLiteValue -> IO SQLiteValue

returnSQLiteValue :: SQLiteContext -> SQLiteValue -> IO ()

newtype SQLiteContext

The context in which an SQL function executes is stored in an sqlite3_context object. A pointer to an sqlite3_context object is always first parameter to application-defined SQL functions.

Constructors

SQLiteContext (Ptr ())

Instances

Storable SQLiteContext

Methods

sizeOf :: SQLiteContext -> Int

alignment :: SQLiteContext -> Int

peekElemOff :: Ptr SQLiteContext -> Int -> IO SQLiteContext

pokeElemOff :: Ptr SQLiteContext -> Int -> SQLiteContext -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteContext

pokeByteOff :: Ptr b -> Int -> SQLiteContext -> IO ()

peek :: Ptr SQLiteContext -> IO SQLiteContext

poke :: Ptr SQLiteContext -> SQLiteContext -> IO ()

newtype SQLiteBLOB

A BLOB handle

Constructors

SQLiteBLOB (Ptr ())

Instances

Storable SQLiteBLOB

Methods

sizeOf :: SQLiteBLOB -> Int

alignment :: SQLiteBLOB -> Int

peekElemOff :: Ptr SQLiteBLOB -> Int -> IO SQLiteBLOB

pokeElemOff :: Ptr SQLiteBLOB -> Int -> SQLiteBLOB -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteBLOB

pokeByteOff :: Ptr b -> Int -> SQLiteBLOB -> IO ()

peek :: Ptr SQLiteBLOB -> IO SQLiteBLOB

poke :: Ptr SQLiteBLOB -> SQLiteBLOB -> IO ()

newtype SQLiteUTF16

Constructors

SQLiteUTF16 (Ptr ())

Instances

Storable SQLiteUTF16

Methods

sizeOf :: SQLiteUTF16 -> Int

alignment :: SQLiteUTF16 -> Int

peekElemOff :: Ptr SQLiteUTF16 -> Int -> IO SQLiteUTF16

pokeElemOff :: Ptr SQLiteUTF16 -> Int -> SQLiteUTF16 -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteUTF16

pokeByteOff :: Ptr b -> Int -> SQLiteUTF16 -> IO ()

peek :: Ptr SQLiteUTF16 -> IO SQLiteUTF16

poke :: Ptr SQLiteUTF16 -> SQLiteUTF16 -> IO ()

newtype SQLiteContextBuffer

Constructors

SQLiteContextBuffer (Ptr ())

Instances

Storable SQLiteContextBuffer

Methods

sizeOf :: SQLiteContextBuffer -> Int

alignment :: SQLiteContextBuffer -> Int

peekElemOff :: Ptr SQLiteContextBuffer -> Int -> IO SQLiteContextBuffer

pokeElemOff :: Ptr SQLiteContextBuffer -> Int -> SQLiteContextBuffer -> IO ()

peekByteOff :: Ptr b -> Int -> IO SQLiteContextBuffer

pokeByteOff :: Ptr b -> Int -> SQLiteContextBuffer -> IO ()

peek :: Ptr SQLiteContextBuffer -> IO SQLiteContextBuffer

poke :: Ptr SQLiteContextBuffer -> SQLiteContextBuffer -> IO ()

newtype SQLiteCallback a

Constructors

SQLiteCallback (FunPtr a)

Instances

Storable (SQLiteCallback a)

Methods

sizeOf :: SQLiteCallback a -> Int

alignment :: SQLiteCallback a -> Int

peekElemOff :: Ptr (SQLiteCallback a) -> Int -> IO (SQLiteCallback a)

pokeElemOff :: Ptr (SQLiteCallback a) -> Int -> SQLiteCallback a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (SQLiteCallback a)

pokeByteOff :: Ptr b -> Int -> SQLiteCallback a -> IO ()

peek :: Ptr (SQLiteCallback a) -> IO (SQLiteCallback a)

poke :: Ptr (SQLiteCallback a) -> SQLiteCallback a -> IO ()

type SQLiteCallbackUserData = Ptr ()

data SQLiteType

SQLite types

Constructors

SQLiteInt

SQLiteFloat

SQLiteText

SQLiteBlob

SQLiteNull

Instances

Enum SQLiteType

Methods

succ :: SQLiteType -> SQLiteType

pred :: SQLiteType -> SQLiteType

toEnum :: Int -> SQLiteType

fromEnum :: SQLiteType -> Int

enumFrom :: SQLiteType -> [SQLiteType]

enumFromThen :: SQLiteType -> SQLiteType -> [SQLiteType]

enumFromTo :: SQLiteType -> SQLiteType -> [SQLiteType]

enumFromThenTo :: SQLiteType -> SQLiteType -> SQLiteType -> [SQLiteType]

Eq SQLiteType

Methods

(==) :: SQLiteType -> SQLiteType -> Bool

(/=) :: SQLiteType -> SQLiteType -> Bool

type Status = Word32

sQLITE_OK :: Status

SQLite C status codes.

• http://www.sqlite.org/c3ref/c_abort.html

sQLITE_ERROR :: Status

sQLITE_INTERNAL :: Status

sQLITE_PERM :: Status

sQLITE_ABORT :: Status

sQLITE_BUSY :: Status

sQLITE_LOCKED :: Status

sQLITE_NOMEM :: Status

sQLITE_READONLY :: Status

sQLITE_INTERRUPT :: Status

sQLITE_IOERR :: Status

sQLITE_CORRUPT :: Status

sQLITE_NOTFOUND :: Status

sQLITE_FULL :: Status

sQLITE_CANTOPEN :: Status

sQLITE_PROTOCOL :: Status

sQLITE_EMPTY :: Status

sQLITE_SCHEMA :: Status

sQLITE_TOOBIG :: Status

sQLITE_CONSTRAINT :: Status

sQLITE_MISMATCH :: Status

sQLITE_MISUSE :: Status

sQLITE_NOLFS :: Status

sQLITE_AUTH :: Status

sQLITE_FORMAT :: Status

sQLITE_RANGE :: Status

sQLITE_NOTADB :: Status

sQLITE_ROW :: Status

sQLITE_DONE :: Status

sQLITE_IOERR_READ :: Status

SQLite extended result codes:

• http://www.sqlite.org/c3ref/c_ioerr_blocked.html

sQLITE_IOERR_SHORT_READ :: Status

sQLITE_IOERR_WRITE :: Status

sQLITE_IOERR_FSYNC :: Status

sQLITE_IOERR_DIR_FSYNC :: Status

sQLITE_IOERR_TRUNCATE :: Status

sQLITE_IOERR_FSTAT :: Status

sQLITE_IOERR_UNLOCK :: Status

sQLITE_IOERR_RDLOCK :: Status

sQLITE_IOERR_DELETE :: Status

sQLITE_IOERR_BLOCKED :: Status

sQLITE_IOERR_NOMEM :: Status

type OpenFlags = Word32

sQLITE_OPEN_READONLY :: OpenFlags

SQLite flags for open operations.

• http://www.sqlite.org/c3ref/c_open_create.html

sQLITE_OPEN_READWRITE :: OpenFlags

sQLITE_OPEN_CREATE :: OpenFlags

sQLITE_OPEN_DELETEONCLOSE :: OpenFlags

sQLITE_OPEN_EXCLUSIVE :: OpenFlags

sQLITE_OPEN_MAIN_DB :: OpenFlags

sQLITE_OPEN_TEMP_DB :: OpenFlags

sQLITE_OPEN_TRANSIENT_DB :: OpenFlags

sQLITE_OPEN_MAIN_JOURNAL :: OpenFlags

sQLITE_OPEN_TEMP_JOURNAL :: OpenFlags

sQLITE_OPEN_SUBJOURNAL :: OpenFlags

sQLITE_OPEN_MASTER_JOURNAL :: OpenFlags

type IOCap = Word32

sQLITE_IOCAP_ATOMIC :: IOCap

Device characteristics

• http://www.sqlite.org/c3ref/c_iocap_atomic.html

sQLITE_IOCAP_ATOMIC512 :: IOCap

sQLITE_IOCAP_ATOMIC1K :: IOCap

sQLITE_IOCAP_ATOMIC2K :: IOCap

sQLITE_IOCAP_ATOMIC4K :: IOCap

sQLITE_IOCAP_ATOMIC8K :: IOCap

sQLITE_IOCAP_ATOMIC16K :: IOCap

sQLITE_IOCAP_ATOMIC32K :: IOCap

sQLITE_IOCAP_ATOMIC64K :: IOCap

sQLITE_IOCAP_SAFE_APPEND :: IOCap

sQLITE_IOCAP_SEQUENTIAL :: IOCap

type LockFlag = Word32

sQLITE_LOCK_NONE :: LockFlag

File locking levels

• http://www.sqlite.org/c3ref/c_lock_exclusive.html

sQLITE_LOCK_SHARED :: LockFlag

sQLITE_LOCK_RESERVED :: LockFlag

sQLITE_LOCK_PENDING :: LockFlag

sQLITE_LOCK_EXCLUSIVE :: LockFlag

type SyncFlag = Word32

sQLITE_SYNC_NORMAL :: SyncFlag

Synchronization flags

• http://www.sqlite.org/c3ref/c_sync_dataonly.html

sQLITE_SYNC_FULL :: SyncFlag

sQLITE_SYNC_DATAONLY :: SyncFlag

type AccessFlag = Word32

sQLITE_ACCESS_EXISTS :: AccessFlag

xAccess methods

• http://www.sqlite.org/c3ref/c_access_exists.html

sQLITE_ACCESS_READWRITE :: AccessFlag

sQLITE_ACCESS_READ :: AccessFlag

type AuthCode = Word32

sQLITE_COPY :: AuthCode

Authorizer Action Codes

• http://www.sqlite.org/c3ref/c_alter_table.html

sQLITE_CREATE_INDEX :: AuthCode

sQLITE_CREATE_TABLE :: AuthCode

sQLITE_CREATE_TEMP_INDEX :: AuthCode

sQLITE_CREATE_TEMP_TABLE :: AuthCode

sQLITE_CREATE_TEMP_TRIGGER :: AuthCode

sQLITE_CREATE_TEMP_VIEW :: AuthCode

sQLITE_CREATE_TRIGGER :: AuthCode

sQLITE_CREATE_VIEW :: AuthCode

sQLITE_DELETE :: AuthCode

sQLITE_DROP_INDEX :: AuthCode

sQLITE_DROP_TABLE :: AuthCode

sQLITE_DROP_TEMP_INDEX :: AuthCode

sQLITE_DROP_TEMP_TABLE :: AuthCode

sQLITE_DROP_TEMP_TRIGGER :: AuthCode

sQLITE_DROP_TEMP_VIEW :: AuthCode

sQLITE_DROP_TRIGGER :: AuthCode

sQLITE_DROP_VIEW :: AuthCode

sQLITE_INSERT :: AuthCode

sQLITE_PRAGMA :: AuthCode

sQLITE_READ :: AuthCode

sQLITE_SELECT :: AuthCode

sQLITE_TRANSACTION :: AuthCode

sQLITE_UPDATE :: AuthCode

sQLITE_ATTACH :: AuthCode

sQLITE_DETACH :: AuthCode

sQLITE_ALTER_TABLE :: AuthCode

sQLITE_REINDEX :: AuthCode

sQLITE_ANALYZE :: AuthCode

sQLITE_CREATE_VTABLE :: AuthCode

sQLITE_DROP_VTABLE :: AuthCode

sQLITE_FUNCTION :: AuthCode

type TextEncodeFlag = CInt

sQLITE_UTF8 :: TextEncodeFlag

Text encodings

• http://www.sqlite.org/c3ref/c_any.html

sQLITE_UTF16LE :: TextEncodeFlag

sQLITE_UTF16BE :: TextEncodeFlag

sQLITE_UTF16 :: TextEncodeFlag

sQLITE_ANY :: TextEncodeFlag

sQLITE_UTF16_ALIGNED :: TextEncodeFlag

type FundamentalDatatype = CInt

sQLITE_INTEGER :: FundamentalDatatype

Fundamental datatypes

• http://www.sqlite.org/c3ref/c_blob.html

sQLITE_FLOAT :: FundamentalDatatype

sQLITE_BLOB :: FundamentalDatatype

sQLITE_NULL :: FundamentalDatatype

sQLITE_TEXT :: FundamentalDatatype

isNullStmt :: SQLiteStmt -> Bool

noCallback :: SQLiteCallback a

freeCallback :: SQLiteCallback a -> IO ()