Database.SQLite

A Haskell binding to the sqlite3 database. See:

• http://www.sqlite.org/

for more information.

The api is documented at:

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

Documentation

module Database.SQLite.Base

module Database.SQLite.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 String

SQLiteResult ()

SQLiteResult 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

Show Value

IsValue Value

SQLiteResult 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

Methods

fromSQLiteValue :: SQLiteValue -> IO a

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

Instances

IsValue Double

IsValue Int

IsValue Int64

IsValue String

IsValue ()

IsValue CStringLen

IsValue CInt

IsValue ByteString

IsValue SQLiteValue

IsValue Value

IsValue a => IsValue (Maybe a)

class IsFunctionHandler a where

Methods

funcArity :: a -> Arity

funcHandler :: a -> FunctionHandler

Instances

IsValue r => IsFunctionHandler r

IsValue r => IsFunctionHandler (IO r)

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

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

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

IsValue r => IsFunctionHandler (String -> r)

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

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

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

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

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

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

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

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

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 ()