Added support for in-memory databases and URI filenames

Author: cyberhuman

src/sqlite3.ml

@@ -156,14 +156,14 @@ module Cache = struct
 end
 
 external db_open :
-  mode : Mode.t -> mutex : Mut.t -> cache : Cache.t ->
-  ?vfs : string -> string -> db = "caml_sqlite3_open"
+  mode : Mode.t -> uri : bool -> memory : bool -> mutex : Mut.t -> cache : Cache.t ->
+  ?vfs : string -> string -> db = "caml_sqlite3_open_bytecode" "caml_sqlite3_open_native"
 
-let db_open ?mode ?mutex ?cache ?vfs name =
+let db_open ?mode ?(uri=false) ?(memory=false) ?mutex ?cache ?vfs name =
   let mode = Mode.lift mode in
   let mutex = Mut.lift mutex in
   let cache = Cache.lift cache in
-  db_open ~mode ~mutex ~cache ?vfs name
+  db_open ~mode ~uri ~memory ~mutex ~cache ?vfs name
 
 external db_close : db -> bool = "caml_sqlite3_close"
 

src/sqlite3.mli

@@ -159,6 +159,8 @@ end
 
 val db_open :
   ?mode : [ `READONLY | `NO_CREATE ] ->
+  ?uri : bool ->
+  ?memory : bool ->
   ?mutex : [ `NO | `FULL ] ->
   ?cache : [ `SHARED | `PRIVATE ] ->
   ?vfs : string ->
@@ -171,18 +173,24 @@ val db_open :
     database respectively.
     Behaviour explained here: https://www.sqlite.org/inmemorydb.html
 
-    The optional arguments [mode] and [mutex] are only meaningful with SQLite
-    versions >= 3.5, [cache] only for versions >= 3.6.18.  For older versions an
-    exception will be raised if any of them is set to a non-default value.  The
-    database is opened read-only if [`READONLY] is passed as mode.  The database
-    file will not be created if it is missing and [`NO_CREATE] is set.  [mutex]
-    determines how the database is accessed.  The mutex parameters [`NO] and
-    [`FULL] correspond to [SQLITE_OPEN_NOMUTEX] and [SQLITE_OPEN_FULLMUTEX] in
-    the SQLite3 API respectively.  The cache parameters [`SHARED] and [`PRIVATE]
-    correspond to [SQLITE_OPEN_SHAREDCACHE] and [SQLITE_OPEN_PRIVATECACHE] in
-    the SQLite3 API respectively.
+    The optional arguments [mode], [uri], [memory] and [mutex] are only
+    meaningful with SQLite versions >= 3.5, [cache] only for versions >= 3.6.18.
+    For older versions an exception will be raised if any of them is set to a
+    non-default value.  The database is opened read-only if [`READONLY] is
+    passed as mode.  The database file will not be created if it is missing and
+    [`NO_CREATE] is set.  The [uri] parameter enables URI filename
+    interepretation and corresponds to [SQLITE_OPEN_URI] in the SQLite3 API.
+    The [memory] parameter opens an in-memory database and corresponds to
+    [SQLITE_OPEN_MEMORY] in the SQLite3 API.   [mutex] determines how the
+    database is accessed.  The mutex parameters [`NO] and [`FULL] correspond to
+    [SQLITE_OPEN_NOMUTEX] and [SQLITE_OPEN_FULLMUTEX] in the SQLite3 API
+    respectively.  The cache parameters [`SHARED] and [`PRIVATE] correspond to
+    [SQLITE_OPEN_SHAREDCACHE] and [SQLITE_OPEN_PRIVATECACHE] in the SQLite3 API
+    respectively.
 
     @param mode default = read-write, create
+    @param uri default = false
+    @param memory default = false
     @param mutex default = nothing
     @param cache default = nothing
     @param vfs default = nothing

src/sqlite3_stubs.c

@@ -374,14 +374,20 @@ static struct custom_operations db_wrap_ops = {
 };
 
 #ifdef SQLITE_HAS_OPEN_V2
-static inline int get_open_flags(value v_mode, value v_mutex, value v_cache)
+static inline int get_open_flags(value v_mode, value v_uri, value v_memory, value v_mutex, value v_cache)
 {
   int flags;
   switch (Int_val(v_mode)) {
     case 0 : flags = (SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE); break;
     case 1 : flags = SQLITE_OPEN_READWRITE; break;
     default : flags = SQLITE_OPEN_READONLY; break;
   }
+  if (Bool_val(v_uri)) {
+    flags |= SQLITE_OPEN_URI;
+  }
+  if (Bool_val(v_memory)) {
+    flags |= SQLITE_OPEN_MEMORY;
+  }
   switch (Int_val(v_mutex)) {
     case 0 : break;
     case 1 : flags |= SQLITE_OPEN_NOMUTEX; break;
@@ -402,13 +408,13 @@ static inline int get_open_flags(value v_mode, value v_mutex, value v_cache)
 }
 #endif
 
-CAMLprim value caml_sqlite3_open(
-  value v_mode, value v_mutex, value v_cache, value v_vfs_opt, value v_file)
+CAMLprim value caml_sqlite3_open_native(
+  value v_mode, value v_uri, value v_memory, value v_mutex, value v_cache, value v_vfs_opt, value v_file)
 {
   sqlite3 *db;
   int res;
 #ifdef SQLITE_HAS_OPEN_V2
-  int flags = get_open_flags(v_mode, v_mutex, v_cache);
+  int flags = get_open_flags(v_mode, v_uri, v_memory, v_mutex, v_cache);
   char *vfs;
 #endif
   int file_len = caml_string_length(v_file) + 1;
@@ -423,7 +429,7 @@ CAMLprim value caml_sqlite3_open(
     memcpy(vfs, String_val(v_vfs), vfs_len);
   }
 #else
-  if (Int_val(v_mode) || Int_val(v_mutex) || Int_val(v_cache))
+  if (Int_val(v_mode) || Bool_val(v_uri) || Bool_val(v_memory) || Int_val(v_mutex) || Int_val(v_cache))
     caml_failwith("SQLite3 version < 3.5 does not support open flags");
   if (v_vfs_opt != Val_None)
     caml_failwith("SQLite3 version < 3.5 does not support VFS modules");
@@ -466,6 +472,11 @@ CAMLprim value caml_sqlite3_open(
   }
 }
 
+CAMLprim value caml_sqlite3_open_bytecode(value *argv, int argn)
+{
+  return caml_sqlite3_open_native(argv[0], argv[1], argv[2], argv[3], argv[4], argv[5], argv[6]);
+}
+
 CAMLprim value caml_sqlite3_close(value v_db)
 {
   int ret, not_busy;