Database.SQLCipher

A Haskell binding to the SQLCipher database. See:

• https://www.zetetic.net/sqlcipher/

for more information.

The API is documented at:

• https://www.zetetic.net/sqlcipher/sqlcipher-api/
• http://www.sqlite.org/c3ref/funclist.html

Documentation

module Database.SQLCipher.Base

module Database.SQLCipher.Types

module Database.SQL.Types

Opening and closing a database

openConnection :: String -> IO SQLiteHandle

Open a new database connection, whose name is given by the dbName argument. A sqlite3 handle is returned.

An exception is thrown if the database could not be opened.

openReadonlyConnection :: String -> IO SQLiteHandle

Open a new database connection read-only, whose name is given by the dbName argument. A sqlite3 handle is returned.

An exception is thrown if the database does not exist, or could not be opened.

closeConnection :: SQLiteHandle -> IO ()

Close a database connection. Destroys the SQLite value associated with a database, closes all open files relating to the database, and releases all resources.

Executing SQL queries on the database

class SQLiteResultPrivate a => SQLiteResult a

Minimal complete definition

get_sqlite_val

Instances

SQLiteResult ()

Methods

get_sqlite_val :: SQLiteStmt -> CInt -> IO ()

SQLiteResult String

Methods

get_sqlite_val :: SQLiteStmt -> CInt -> IO String

SQLiteResult Value

Methods

get_sqlite_val :: SQLiteStmt -> CInt -> IO Value

execStatement :: SQLiteResult a => SQLiteHandle -> String -> IO (Either String [[Row a]])

Evaluate the SQL statement specified by sqlStmt

execStatement_ :: SQLiteHandle -> String -> IO (Maybe String)

Returns an error, or Nothing if everything was OK.

execParamStatement :: SQLiteResult a => SQLiteHandle -> String -> [(String, Value)] -> IO (Either String [[Row a]])

Prepare and execute a parameterized statment. Statement parameter names start with a colon (for example, :col_id). Note that for the moment, column names should not contain 0 characters because that part of the column name will be ignored.

execParamStatement_ :: SQLiteHandle -> String -> [(String, Value)] -> IO (Maybe String)

Prepare and execute a parameterized statment, ignoring the result. See also execParamStatement.

Basic insertion operations

insertRow :: SQLiteHandle -> TableName -> Row String -> IO (Maybe String)

Insert a row into the table tab.

defineTable :: SQLiteHandle -> SQLTable -> IO (Maybe String)

Define a new table, populated from tab in the database.

defineTableOpt :: SQLiteHandle -> Bool -> SQLTable -> IO (Maybe String)

getLastRowID :: SQLiteHandle -> IO Integer

Return the rowid (as an Integer) of the most recent successful INSERT into the database.

type Row a = [(ColumnName, a)]

data Value

Constructors

Double Double

Int Int64

Text String

Blob ByteString

Null

Instances

Data Value

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value

toConstr :: Value -> Constr

dataTypeOf :: Value -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Value)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value)

gmapT :: (forall b. Data b => b -> b) -> Value -> Value

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r

gmapQ :: (forall d. Data d => d -> u) -> Value -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value

Show Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

IsValue Value

Methods

fromSQLiteValue :: SQLiteValue -> IO Value

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

SQLiteResult Value

Methods

get_sqlite_val :: SQLiteStmt -> CInt -> IO Value

addRegexpSupport :: SQLiteHandle -> RegexpHandler -> IO ()

This function registers a RegexpHandler to be called when REGEXP(regexp,str) is used in an SQL query.

type RegexpHandler = ByteString -> ByteString -> IO Bool

This is the type of the function supported by the addRegexpSupport function. The first argument is the regular expression to match with and the second argument is the string to match. The result shall be True for successful match and False otherwise.

withPrim :: SQLiteHandle -> (SQLite -> IO a) -> IO a

data SQLiteHandle

newSQLiteHandle :: SQLite -> IO SQLiteHandle

User-defined callback functions

class IsValue a where

Minimal complete definition

fromSQLiteValue, returnSQLiteValue

Methods

fromSQLiteValue :: SQLiteValue -> IO a

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

Instances

IsValue Double

Methods

fromSQLiteValue :: SQLiteValue -> IO Double

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

IsValue Int

Methods

fromSQLiteValue :: SQLiteValue -> IO Int

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

IsValue Int64

Methods

fromSQLiteValue :: SQLiteValue -> IO Int64

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

IsValue ()

Methods

fromSQLiteValue :: SQLiteValue -> IO ()

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

IsValue CStringLen

Methods

fromSQLiteValue :: SQLiteValue -> IO CStringLen

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

IsValue CInt

Methods

fromSQLiteValue :: SQLiteValue -> IO CInt

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

IsValue String

Methods

fromSQLiteValue :: SQLiteValue -> IO String

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

IsValue ByteString

Methods

fromSQLiteValue :: SQLiteValue -> IO ByteString

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

IsValue SQLiteValue

Methods

fromSQLiteValue :: SQLiteValue -> IO SQLiteValue

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

IsValue Value

Methods

fromSQLiteValue :: SQLiteValue -> IO Value

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

IsValue a => IsValue (Maybe a)

Methods

fromSQLiteValue :: SQLiteValue -> IO (Maybe a)

returnSQLiteValue :: SQLiteContext -> Maybe a -> IO ()

class IsFunctionHandler a where

Minimal complete definition

funcArity, funcHandler

Methods

funcArity :: a -> Arity

funcHandler :: a -> FunctionHandler

Instances

IsValue r => IsFunctionHandler r

Methods

funcArity :: r -> Arity

funcHandler :: r -> FunctionHandler

IsValue r => IsFunctionHandler (IO r)

Methods

funcArity :: IO r -> Arity

funcHandler :: IO r -> FunctionHandler

(IsValue a, IsValue r) => IsFunctionHandler ([a] -> IO r)

Methods

funcArity :: ([a] -> IO r) -> Arity

funcHandler :: ([a] -> IO r) -> FunctionHandler

(IsValue a, IsValue r) => IsFunctionHandler ([a] -> r)

Methods

funcArity :: ([a] -> r) -> Arity

funcHandler :: ([a] -> r) -> FunctionHandler

(IsValue a, IsValue b, IsValue c, IsValue d, IsValue r) => IsFunctionHandler (a -> b -> c -> d -> IO r)

Methods

funcArity :: (a -> b -> c -> d -> IO r) -> Arity

funcHandler :: (a -> b -> c -> d -> IO r) -> FunctionHandler

(IsValue a, IsValue b, IsValue c, IsValue r) => IsFunctionHandler (a -> b -> c -> IO r)

Methods

funcArity :: (a -> b -> c -> IO r) -> Arity

funcHandler :: (a -> b -> c -> IO r) -> FunctionHandler

(IsValue a, IsValue b, IsValue r) => IsFunctionHandler (a -> b -> IO r)

Methods

funcArity :: (a -> b -> IO r) -> Arity

funcHandler :: (a -> b -> IO r) -> FunctionHandler

(IsValue a, IsValue r) => IsFunctionHandler (a -> IO r)

Methods

funcArity :: (a -> IO r) -> Arity

funcHandler :: (a -> IO r) -> FunctionHandler

(IsValue a, IsValue b, IsValue c, IsValue d, IsValue r) => IsFunctionHandler (a -> b -> c -> d -> r)

Methods

funcArity :: (a -> b -> c -> d -> r) -> Arity

funcHandler :: (a -> b -> c -> d -> r) -> FunctionHandler

(IsValue a, IsValue b, IsValue c, IsValue r) => IsFunctionHandler (a -> b -> c -> r)

Methods

funcArity :: (a -> b -> c -> r) -> Arity

funcHandler :: (a -> b -> c -> r) -> FunctionHandler

(IsValue a, IsValue b, IsValue r) => IsFunctionHandler (a -> b -> r)

Methods

funcArity :: (a -> b -> r) -> Arity

funcHandler :: (a -> b -> r) -> FunctionHandler

(IsValue a, IsValue r) => IsFunctionHandler (a -> r)

Methods

funcArity :: (a -> r) -> Arity

funcHandler :: (a -> r) -> FunctionHandler

IsValue r => IsFunctionHandler (String -> IO r)

Methods

funcArity :: (String -> IO r) -> Arity

funcHandler :: (String -> IO r) -> FunctionHandler

IsValue r => IsFunctionHandler (String -> r)

Methods

funcArity :: (String -> r) -> Arity

funcHandler :: (String -> r) -> FunctionHandler

createFunction :: IsFunctionHandler a => SQLiteHandle -> FunctionName -> a -> IO ()

createFunctionPrim :: SQLiteHandle -> FunctionName -> Arity -> FunctionHandler -> IO ()

createAggregatePrim :: (IsValue i, IsValue o) => SQLiteHandle -> FunctionName -> Arity -> (a -> [i] -> IO a) -> a -> (a -> IO o) -> IO ()