diff options
Diffstat (limited to 'lib/sql/db.mli')
| -rw-r--r-- | lib/sql/db.mli | 41 |
1 files changed, 19 insertions, 22 deletions
diff --git a/lib/sql/db.mli b/lib/sql/db.mli index 465b159..478d762 100644 --- a/lib/sql/db.mli +++ b/lib/sql/db.mli @@ -6,22 +6,21 @@ type 'a result = ('a, exn) Result.t val with_db : string -> ('a t -> unit result) -> unit result val check_table_schema : 'a t -> ImportAnalyser.Dependency.t -> bool result -(** Check if a table with the same structure already exists in the database. +(** Check if a table with the same structure already exists in the database. This query allow to reuse the same data without reloading the file if nothing changed. *) val create_table : 'a t -> ImportAnalyser.Dependency.t -> unit result -(** [create_table db name] will create a new table in the - db with the given name, and the columns from the configuration (see +(** [create_table db name] will create a new table in the db with the given + name, and the columns from the configuration (see [ImportAnalyser.Query.create_table]) Any previous table with the same name will be deleted. *) val prepare_insert : 'a t -> ImportAnalyser.Dependency.t -> Sqlite3.stmt result -(** Create a statement to use in an insert. - [prepare_insert db table] will prepare a statement for inserting - the columns at the given index. *) +(** Create a statement to use in an insert. [prepare_insert db table] will + prepare a statement for inserting the columns at the given index. *) val finalize : Sqlite3.stmt -> unit result (** Finalize the statement. The function shall be called once each insert are @@ -35,7 +34,7 @@ val eval_key : ImportAnalyser.Dependency.key list -> (int * ImportCSV.DataType.t) list -> (Sqlite3.stmt option * Sqlite3.Data.t list) result -(** Evaluate the keys in sqlite and get the results. +(** Evaluate the keys in sqlite and get the results. The function is intended to check if the values are null before inserting them in a batch *) @@ -46,17 +45,17 @@ val insert : id:int -> (int * ImportCSV.DataType.t) list -> unit result -(** Insert a new row in the database. +(** Insert a new row in the database. - [insert db ~id statement values] will add a new row in the given table with - [id]. The columns are identified with their index number (there is a - difference by one with the column number) + [insert db ~id statement values] will add a new row in the given table with + [id]. The columns are identified with their index number (there is a + difference by one with the column number) - Thanks to SQLite Flexible Typing (https://www.sqlite.org/flextypegood.html) - each column can contain values typed differently which is how the spreadsheet - also works. + Thanks to SQLite Flexible Typing (https://www.sqlite.org/flextypegood.html) + each column can contain values typed differently which is how the + spreadsheet also works. - This function is expected to be run inside a transaction. *) + This function is expected to be run inside a transaction. *) val begin_transaction : 'a t -> unit result val commit : 'a t -> unit result @@ -69,13 +68,11 @@ val query : 'a t -> Syntax.t -> unit result -(** This one the most important function from the application. The function - will transform the configuration into an sql query and will fetch the - result from the sqlite engine. +(** This one the most important function from the application. The function will + transform the configuration into an sql query and will fetch the result from + the sqlite engine. - The function [f] given in argument will be called for each line - - *) + The function [f] given in argument will be called for each line *) val create_view : 'a t -> Syntax.t -> unit result (** Create a view which represent the result *) @@ -84,7 +81,7 @@ val check_foreign : f:((string * ImportCSV.DataType.t) array -> unit) -> 'a t -> Syntax.t -> - Syntax.extern -> + Syntax.Extern.t -> unit result val clear_duplicates : |