package sqlite3_utils

Exception raised by most of the functions below when a Sqlite failure occurs, with the corresponding error code.

Exception raised when the declared Ty.t does not match the actual result returned by Sqlite.

Alias for the DB connection

Check return code.

• returns

  Error rc if the code is not Sqlite3.Rc.t.DONE or Sqlite3.Rc.t.OK.

Check return code.

• raises RcError

  if the code is not Sqlite3.Rc.t.DONE or Sqlite3.Rc.t.OK.

Turn the error into a string using Rc.to_string

on "busy", wait ms milliseconds before failing.

Temporarily open a DB connection. Parameters follow Sqlite3.db_open.

• parameter timeout

  if provided, timeout in milliseconds before a query fails with "BUSY".

• parameter wal

  if true, use "pragma journal_mode=WAL" to use a write ahead log (since 0.5)

Values representing types to pass to a statement, or to extract from a row

Locally make a statement out of the given string, then cleanup when f returns.

Run the query purely for its side effects, without any parameter. If you need to parametrize this with user inputs, use exec_raw or exec_raw_args or exec_no_cursor to use a safe parametrized statement instead of builtin a string that is vulnerable to SQL injections.

Run the query purely for its side effects, like exec0.

• raises RcError

  if the query failed.

Wrapper around Sqlite3's prepare statement, returning Data.t.

• parameter f

  is given the cursor over results, and can use Cursor to turn it into a list, only keep a few values, or aggregate results.

Same as exec_raw but uses check_ret_exn to unwrap errors.

• raises RcError

  in case of error.

Similar to exec_raw but also takes an array of parameters that will fill the ? placeholders of the prepare statement.

Same as exec_raw_args but uses check_ret_exn to unwrap errors.

• raises RcError

  in case of error.

Typesafe alternative to exec_raw_args.

• parameter ty

  describes the type of paramaters and of the returned values.

• parameter f

  is given the cursor over decoded values

  Example:

   # with_db ":memory:" (fun db ->
       exec0_exn db "create table person (name text, age int);";
       exec0_exn db "insert into person values ('alice', 20), ('bob', 25) ;";
       exec db "select age from person where name=? ;"
        ~ty:Ty.(p1 text, p1 int, (fun (x:int) -> x))
        "alice"
         ~f:Cursor.to_list);;
  - : (int list, Rc.t) result = Ok [20]

Same as exec but uses check_ret_exn to unwrap the result.

• raises RcError

  in case of error.

Same as exec but without parameters. ty only takes two arguments: the type description for result rows, and a function to map rows to 'c

Same as exec_no_params_exn but uses check_ret_exn to unwrap the result.

• raises RcError

  in case of error.

Perform a query that doesn't return any result.

• parameter ty

  the description of the type parameters.

Same as exec_no_cursor_exn but uses check_ret_exn to unwrap the result.

• raises RcError

  in case of error.

exec_get_column_names db query is the list of names of columns that would be returned by exec db query.

• since 0.5

transact db f runs f db within a transaction (begin/commit/rollback). Useful to perform a batch of insertions or updates, as Sqlite doesn't write very fast.

Same as transact but uses Sqlite's savepoint/release/rollback mechanism. instead of begin/commit/rolllback