unikernel/duniverse/ocaml-caqti/caqti-driver-sqlite3/lib/caqti_driver_sqlite3.mli

@@ -0,0 +1,49 @@
+(* Copyright (C) 2017--2024  Petter A. Urkedal <paurkedal@gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or (at your
+ * option) any later version, with the LGPL-3.0 Linking Exception.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * and the LGPL-3.0 Linking Exception along with this library.  If not, see
+ * <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.
+ *)
+
+(** Sqlite3 driver for Caqti (bindings).
+
+    This driver is implemented in terms of the sqlite3 OPAM package, which
+    provides bindings for libsqlite3.  It handles URIs of the form
+    {[
+      sqlite3://<path>?create=<bool>&write=<bool>
+    ]}
+    where [<path>] is passed to {!Sqlite3.db_open} and the query string is used
+    to determine its [mode] parameter.  The [<bool>] parameters take the values
+    [true] and [false], and default to [true].
+
+    The interface provided by this module {e should normally not be used by
+    applications}, but provides access to some Sqlite3 specifics in case they
+    are needed. *)
+
+(** {1 Error Details}
+
+    The following provides access to diagnostics collected from the Sqlite3
+    connection. *)
+
+type Caqti_error.msg += Error_msg of {
+  errcode: Sqlite3.Rc.t;
+    (** The OCaml encoding of the error code reported by [sqlite3_errcode]. *)
+  extended_errcode: int option;
+    (** The extended result code, if available. *)
+  errmsg: string option;
+    (** The error message reportedy by [sqlite3_errmsg]. *)
+}
+
+(** {1 Access to Raw Connection Handle} *)
+
+type Caqti_connection_sig.driver_connection += Driver_connection of Sqlite3.db