1065 lines
56 KiB
Forth
1065 lines
56 KiB
Forth
namespace BitBadger.Documents.Sqlite
|
|
|
|
open BitBadger.Documents
|
|
open Microsoft.Data.Sqlite
|
|
|
|
/// <summary>Configuration for document handling</summary>
|
|
module Configuration =
|
|
|
|
/// The connection string to use for query execution
|
|
let mutable internal connectionString: string option = None
|
|
|
|
/// <summary>Register a connection string to use for query execution</summary>
|
|
/// <param name="connStr">The connection string to use for connections from this library</param>
|
|
/// <remarks>This also enables foreign keys</remarks>
|
|
[<CompiledName "UseConnectionString">]
|
|
let useConnectionString connStr =
|
|
let builder = SqliteConnectionStringBuilder connStr
|
|
builder.ForeignKeys <- Option.toNullable (Some true)
|
|
connectionString <- Some (string builder)
|
|
|
|
/// <summary>Retrieve a new connection using currently configured connection string</summary>
|
|
/// <returns>A new database connection</returns>
|
|
/// <exception cref="T:System.InvalidOperationException">If no data source has been configured</exception>
|
|
/// <exception cref="SqliteException">If the connection cannot be opened</exception>
|
|
[<CompiledName "DbConn">]
|
|
let dbConn () =
|
|
match connectionString with
|
|
| Some connStr ->
|
|
let conn = new SqliteConnection(connStr)
|
|
conn.Open()
|
|
conn
|
|
| None -> invalidOp "Please provide a connection string before attempting data access"
|
|
|
|
|
|
/// <summary>Query definitions</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Query =
|
|
|
|
/// <summary>
|
|
/// Create a <tt>WHERE</tt> clause fragment to implement a comparison on fields in a JSON document
|
|
/// </summary>
|
|
/// <param name="howMatched">How the fields should be matched</param>
|
|
/// <param name="fields">The fields for the comparisons</param>
|
|
/// <returns>A <tt>WHERE</tt> clause implementing the comparisons for the given fields</returns>
|
|
[<CompiledName "WhereByFields">]
|
|
let whereByFields (howMatched: FieldMatch) fields =
|
|
let name = ParameterName()
|
|
fields
|
|
|> Seq.map (fun it ->
|
|
match it.Comparison with
|
|
| Exists | NotExists -> $"{it.Path SQLite AsSql} {it.Comparison.OpSql}"
|
|
| Between _ ->
|
|
let p = name.Derive it.ParameterName
|
|
$"{it.Path SQLite AsSql} {it.Comparison.OpSql} {p}min AND {p}max"
|
|
| In values ->
|
|
let p = name.Derive it.ParameterName
|
|
let paramNames = values |> Seq.mapi (fun idx _ -> $"{p}_{idx}") |> String.concat ", "
|
|
$"{it.Path SQLite AsSql} {it.Comparison.OpSql} ({paramNames})"
|
|
| InArray (table, values) ->
|
|
let p = name.Derive it.ParameterName
|
|
let paramNames = values |> Seq.mapi (fun idx _ -> $"{p}_{idx}") |> String.concat ", "
|
|
$"EXISTS (SELECT 1 FROM json_each({table}.data, '$.{it.Name}') WHERE value IN ({paramNames}))"
|
|
| _ -> $"{it.Path SQLite AsSql} {it.Comparison.OpSql} {name.Derive it.ParameterName}")
|
|
|> String.concat $" {howMatched} "
|
|
|
|
/// <summary>Create a <tt>WHERE</tt> clause fragment to implement an ID-based query</summary>
|
|
/// <param name="docId">The ID of the document</param>
|
|
/// <returns>A <tt>WHERE</tt> clause fragment identifying a document by its ID</returns>
|
|
[<CompiledName "WhereById">]
|
|
let whereById (docId: 'TKey) =
|
|
whereByFields Any [ { Field.Equal (Configuration.idField ()) docId with ParameterName = Some "@id" } ]
|
|
|
|
/// <summary>Create an <tt>UPDATE</tt> statement to patch documents</summary>
|
|
/// <param name="tableName">The table to be updated</param>
|
|
/// <returns>A query to patch documents</returns>
|
|
[<CompiledName "Patch">]
|
|
let patch tableName =
|
|
$"UPDATE %s{tableName} SET data = json_patch(data, json(@data))"
|
|
|
|
/// <summary>Create an <tt>UPDATE</tt> statement to remove fields from documents</summary>
|
|
/// <param name="tableName">The table to be updated</param>
|
|
/// <param name="parameters">The parameters with the field names to be removed</param>
|
|
/// <returns>A query to remove fields from documents</returns>
|
|
[<CompiledName "RemoveFields">]
|
|
let removeFields tableName (parameters: SqliteParameter seq) =
|
|
let paramNames = parameters |> Seq.map _.ParameterName |> String.concat ", "
|
|
$"UPDATE %s{tableName} SET data = json_remove(data, {paramNames})"
|
|
|
|
/// <summary>Create a query by a document's ID</summary>
|
|
/// <param name="statement">The SQL statement to be run against a document by its ID</param>
|
|
/// <param name="docId">The ID of the document targeted</param>
|
|
/// <returns>A query addressing a document by its ID</returns>
|
|
[<CompiledName "ById">]
|
|
let byId<'TKey> statement (docId: 'TKey) =
|
|
Query.statementWhere
|
|
statement
|
|
(whereByFields Any [ { Field.Equal (Configuration.idField ()) docId with ParameterName = Some "@id" } ])
|
|
|
|
/// <summary>Create a query on JSON fields</summary>
|
|
/// <param name="statement">The SQL statement to be run against matching fields</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to be matched</param>
|
|
/// <returns>A query addressing documents by field matching conditions</returns>
|
|
[<CompiledName "ByFields">]
|
|
let byFields statement howMatched fields =
|
|
Query.statementWhere statement (whereByFields howMatched fields)
|
|
|
|
/// <summary>Data definition</summary>
|
|
module Definition =
|
|
|
|
/// <summary>SQL statement to create a document table</summary>
|
|
/// <param name="name">The name of the table (may include schema)</param>
|
|
/// <returns>A query to create the table if it does not exist</returns>
|
|
[<CompiledName "EnsureTable">]
|
|
let ensureTable name =
|
|
Query.Definition.ensureTableFor name "TEXT"
|
|
|
|
|
|
/// <summary>Parameter handling helpers</summary>
|
|
[<AutoOpen>]
|
|
module Parameters =
|
|
|
|
/// <summary>Create an ID parameter (name "@id")</summary>
|
|
/// <param name="key">The key value for the ID parameter</param>
|
|
/// <returns>The name and parameter value for the ID</returns>
|
|
[<CompiledName "Id">]
|
|
let idParam (key: 'TKey) =
|
|
SqliteParameter("@id", string key)
|
|
|
|
/// <summary>Create a parameter with a JSON value</summary>
|
|
/// <param name="name">The name of the parameter to create</param>
|
|
/// <param name="it">The criteria to provide as JSON</param>
|
|
/// <returns>The name and parameter value for the JSON field</returns>
|
|
[<CompiledName "Json">]
|
|
let jsonParam name (it: 'TJson) =
|
|
SqliteParameter(name, Configuration.serializer().Serialize it)
|
|
|
|
/// <summary>Create JSON field parameters</summary>
|
|
/// <param name="fields">The <tt>Field</tt>s to convert to parameters</param>
|
|
/// <param name="parameters">The current parameters for the query</param>
|
|
/// <returns>A unified sequence of parameter names and values</returns>
|
|
[<CompiledName "AddFields">]
|
|
let addFieldParams fields parameters =
|
|
let name = ParameterName()
|
|
fields
|
|
|> Seq.map (fun it ->
|
|
seq {
|
|
match it.Comparison with
|
|
| Exists | NotExists -> ()
|
|
| Between (min, max) ->
|
|
let p = name.Derive it.ParameterName
|
|
yield! [ SqliteParameter($"{p}min", min); SqliteParameter($"{p}max", max) ]
|
|
| In values | InArray (_, values) ->
|
|
let p = name.Derive it.ParameterName
|
|
yield! values |> Seq.mapi (fun idx v -> SqliteParameter($"{p}_{idx}", v))
|
|
| Equal v | Greater v | GreaterOrEqual v | Less v | LessOrEqual v | NotEqual v ->
|
|
yield SqliteParameter(name.Derive it.ParameterName, v) })
|
|
|> Seq.collect id
|
|
|> Seq.append parameters
|
|
|> Seq.toList
|
|
|> Seq.ofList
|
|
|
|
/// Create a JSON field parameter (name "@field")
|
|
[<CompiledName "AddField">]
|
|
[<System.Obsolete "Use addFieldParams instead; will be removed in v4">]
|
|
let addFieldParam name field parameters =
|
|
addFieldParams [ { field with ParameterName = Some name } ] parameters
|
|
|
|
/// <summary>Append JSON field name parameters for the given field names to the given parameters</summary>
|
|
/// <param name="paramName">The name of the parameter to use for each field</param>
|
|
/// <param name="fieldNames">The names of fields to be addressed</param>
|
|
/// <returns>The name (<tt>@name</tt>) and parameter value for the field names</returns>
|
|
[<CompiledName "FieldNames">]
|
|
let fieldNameParams paramName fieldNames =
|
|
fieldNames
|
|
|> Seq.mapi (fun idx name -> SqliteParameter($"%s{paramName}{idx}", $"$.%s{name}"))
|
|
|> Seq.toList
|
|
|> Seq.ofList
|
|
|
|
/// <summary>An empty parameter sequence</summary>
|
|
[<CompiledName "None">]
|
|
let noParams =
|
|
Seq.empty<SqliteParameter>
|
|
|
|
|
|
/// <summary>Helper functions for handling results</summary>
|
|
[<AutoOpen>]
|
|
module Results =
|
|
|
|
/// <summary>Create a domain item from a document, specifying the field in which the document is found</summary>
|
|
/// <param name="field">The field name containing the JSON document</param>
|
|
/// <param name="rdr">A <tt>SqliteDataReader</tt> set to the row with the document to be constructed</param>
|
|
/// <returns>The constructed domain item</returns>
|
|
[<CompiledName "FromDocument">]
|
|
let fromDocument<'TDoc> field (rdr: SqliteDataReader) : 'TDoc =
|
|
Configuration.serializer().Deserialize<'TDoc>(rdr.GetString(rdr.GetOrdinal field))
|
|
|
|
/// <summary>Create a domain item from a document</summary>
|
|
/// <param name="rdr">A <tt>SqliteDataReader</tt> set to the row with the document to be constructed</param>
|
|
/// <returns>The constructed domain item</returns>
|
|
[<CompiledName "FromData">]
|
|
let fromData<'TDoc> rdr =
|
|
fromDocument<'TDoc> "data" rdr
|
|
|
|
/// <summary>
|
|
/// Create a list of items for the results of the given command, using the specified mapping function
|
|
/// </summary>
|
|
/// <param name="cmd">The command to execute</param>
|
|
/// <param name="mapFunc">The mapping function from data reader to domain class instance</param>
|
|
/// <returns>A list of items from the reader</returns>
|
|
[<CompiledName "FSharpToCustomList">]
|
|
let toCustomList<'TDoc> (cmd: SqliteCommand) (mapFunc: SqliteDataReader -> 'TDoc) = backgroundTask {
|
|
use! rdr = cmd.ExecuteReaderAsync()
|
|
let mutable it = Seq.empty<'TDoc>
|
|
while! rdr.ReadAsync() do
|
|
it <- Seq.append it (Seq.singleton (mapFunc rdr))
|
|
return List.ofSeq it
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create a list of items for the results of the given command, using the specified mapping function
|
|
/// </summary>
|
|
/// <param name="cmd">The command to execute</param>
|
|
/// <param name="mapFunc">The mapping function from data reader to domain class instance</param>
|
|
/// <returns>A list of items from the reader</returns>
|
|
let ToCustomList<'TDoc>(cmd: SqliteCommand, mapFunc: System.Func<SqliteDataReader, 'TDoc>) = backgroundTask {
|
|
use! rdr = cmd.ExecuteReaderAsync()
|
|
let it = ResizeArray<'TDoc>()
|
|
while! rdr.ReadAsync() do
|
|
it.Add(mapFunc.Invoke rdr)
|
|
return it
|
|
}
|
|
|
|
/// <summary>Extract a count from the first column</summary>
|
|
/// <param name="rdr">A <tt>SqliteDataReader</tt> set to the row with the count to retrieve</param>
|
|
/// <returns>The count from the row</returns>
|
|
[<CompiledName "ToCount">]
|
|
let toCount (rdr: SqliteDataReader) =
|
|
rdr.GetInt64 0
|
|
|
|
/// <summary>Extract a true/false value from the first column</summary>
|
|
/// <param name="rdr">A <tt>SqliteDataReader</tt> set to the row with the true/false value to retrieve</param>
|
|
/// <returns>The true/false value from the row</returns>
|
|
/// <remarks>SQLite implements boolean as 1 = true, 0 = false</remarks>
|
|
[<CompiledName "ToExists">]
|
|
let toExists rdr =
|
|
toCount rdr > 0L
|
|
|
|
|
|
[<AutoOpen>]
|
|
module internal Helpers =
|
|
|
|
/// <summary>Execute a non-query command</summary>
|
|
/// <param name="cmd">The command to be executed</param>
|
|
let internal write (cmd: SqliteCommand) = backgroundTask {
|
|
let! _ = cmd.ExecuteNonQueryAsync()
|
|
()
|
|
}
|
|
|
|
|
|
/// <summary>Versions of queries that accept a <tt>SqliteConnection</tt> as the last parameter</summary>
|
|
module WithConn =
|
|
|
|
/// <summary>Commands to execute custom SQL queries</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Custom =
|
|
|
|
/// <summary>Execute a query that returns a list of results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>A list of results for the given query</returns>
|
|
[<CompiledName "FSharpList">]
|
|
let list<'TDoc> query (parameters: SqliteParameter seq) (mapFunc: SqliteDataReader -> 'TDoc)
|
|
(conn: SqliteConnection) =
|
|
use cmd = conn.CreateCommand()
|
|
cmd.CommandText <- query
|
|
cmd.Parameters.AddRange parameters
|
|
toCustomList<'TDoc> cmd mapFunc
|
|
|
|
/// <summary>Execute a query that returns a list of results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>A list of results for the given query</returns>
|
|
let List<'TDoc>(
|
|
query, parameters: SqliteParameter seq, mapFunc: System.Func<SqliteDataReader, 'TDoc>,
|
|
conn: SqliteConnection
|
|
) =
|
|
use cmd = conn.CreateCommand()
|
|
cmd.CommandText <- query
|
|
cmd.Parameters.AddRange parameters
|
|
ToCustomList<'TDoc>(cmd, mapFunc)
|
|
|
|
/// <summary>Execute a query that returns one or no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns><tt>Some</tt> with the first matching result, or <tt>None</tt> if not found</returns>
|
|
[<CompiledName "FSharpSingle">]
|
|
let single<'TDoc> query parameters (mapFunc: SqliteDataReader -> 'TDoc) conn = backgroundTask {
|
|
let! results = list query parameters mapFunc conn
|
|
return FSharp.Collections.List.tryHead results
|
|
}
|
|
|
|
/// <summary>Execute a query that returns one or no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The first matching result, or <tt>null</tt> if not found</returns>
|
|
let Single<'TDoc when 'TDoc: null and 'TDoc: not struct>(
|
|
query, parameters, mapFunc: System.Func<SqliteDataReader, 'TDoc>, conn
|
|
) = backgroundTask {
|
|
let! result = single<'TDoc> query parameters mapFunc.Invoke conn
|
|
return Option.toObj result
|
|
}
|
|
|
|
/// <summary>Execute a query that returns no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "NonQuery">]
|
|
let nonQuery query (parameters: SqliteParameter seq) (conn: SqliteConnection) =
|
|
use cmd = conn.CreateCommand()
|
|
cmd.CommandText <- query
|
|
cmd.Parameters.AddRange parameters
|
|
write cmd
|
|
|
|
/// <summary>Execute a query that returns a scalar value</summary>
|
|
/// <param name="query">The query to retrieve the value</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function to obtain the value</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The scalar value for the query</returns>
|
|
[<CompiledName "FSharpScalar">]
|
|
let scalar<'T when 'T : struct> query (parameters: SqliteParameter seq) (mapFunc: SqliteDataReader -> 'T)
|
|
(conn: SqliteConnection) = backgroundTask {
|
|
use cmd = conn.CreateCommand()
|
|
cmd.CommandText <- query
|
|
cmd.Parameters.AddRange parameters
|
|
use! rdr = cmd.ExecuteReaderAsync()
|
|
let! isFound = rdr.ReadAsync()
|
|
return if isFound then mapFunc rdr else Unchecked.defaultof<'T>
|
|
}
|
|
|
|
/// <summary>Execute a query that returns a scalar value</summary>
|
|
/// <param name="query">The query to retrieve the value</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function to obtain the value</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The scalar value for the query</returns>
|
|
let Scalar<'T when 'T: struct>(query, parameters, mapFunc: System.Func<SqliteDataReader, 'T>, conn) =
|
|
scalar<'T> query parameters mapFunc.Invoke conn
|
|
|
|
/// <summary>Functions to create tables and indexes</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Definition =
|
|
|
|
/// <summary>Create a document table</summary>
|
|
/// <param name="name">The table whose existence should be ensured (may include schema)</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "EnsureTable">]
|
|
let ensureTable name conn = backgroundTask {
|
|
do! Custom.nonQuery (Query.Definition.ensureTable name) [] conn
|
|
do! Custom.nonQuery (Query.Definition.ensureKey name SQLite) [] conn
|
|
}
|
|
|
|
/// <summary>Create an index on field(s) within documents in the specified table</summary>
|
|
/// <param name="tableName">The table to be indexed (may include schema)</param>
|
|
/// <param name="indexName">The name of the index to create</param>
|
|
/// <param name="fields">One or more fields to be indexed</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "EnsureFieldIndex">]
|
|
let ensureFieldIndex tableName indexName fields conn =
|
|
Custom.nonQuery (Query.Definition.ensureIndexOn tableName indexName fields SQLite) [] conn
|
|
|
|
/// <summary>Commands to add documents</summary>
|
|
[<AutoOpen>]
|
|
module Document =
|
|
|
|
/// <summary>Insert a new document</summary>
|
|
/// <param name="tableName">The table into which the document should be inserted (may include schema)</param>
|
|
/// <param name="document">The document to be inserted</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "Insert">]
|
|
let insert<'TDoc> tableName (document: 'TDoc) conn =
|
|
let query =
|
|
match Configuration.autoIdStrategy () with
|
|
| Disabled -> Query.insert tableName
|
|
| strategy ->
|
|
let idField = Configuration.idField ()
|
|
let dataParam =
|
|
if AutoId.NeedsAutoId strategy document idField then
|
|
match strategy with
|
|
| Number -> $"(SELECT coalesce(max(data->>'{idField}'), 0) + 1 FROM {tableName})"
|
|
| Guid -> $"'{AutoId.GenerateGuid()}'"
|
|
| RandomString -> $"'{AutoId.GenerateRandomString(Configuration.idStringLength ())}'"
|
|
| Disabled -> "@data"
|
|
|> function it -> $"json_set(@data, '$.{idField}', {it})"
|
|
else "@data"
|
|
(Query.insert tableName).Replace("@data", dataParam)
|
|
Custom.nonQuery query [ jsonParam "@data" document ] conn
|
|
|
|
/// <summary>
|
|
/// Save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
|
|
/// </summary>
|
|
/// <param name="tableName">The table into which the document should be saved (may include schema)</param>
|
|
/// <param name="document">The document to be saved</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "Save">]
|
|
let save<'TDoc> tableName (document: 'TDoc) conn =
|
|
Custom.nonQuery (Query.save tableName) [ jsonParam "@data" document ] conn
|
|
|
|
/// <summary>Commands to count documents</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Count =
|
|
|
|
/// <summary>Count all documents in a table</summary>
|
|
/// <param name="tableName">The table in which documents should be counted (may include schema)</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The count of the documents in the table</returns>
|
|
[<CompiledName "All">]
|
|
let all tableName conn =
|
|
Custom.scalar (Query.count tableName) [] toCount conn
|
|
|
|
/// <summary>Count matching documents using JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table in which documents should be counted (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The count of matching documents in the table</returns>
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields conn =
|
|
Custom.scalar
|
|
(Query.byFields (Query.count tableName) howMatched fields) (addFieldParams fields []) toCount conn
|
|
|
|
/// <summary>Commands to determine if documents exist</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Exists =
|
|
|
|
/// <summary>Determine if a document exists for the given ID</summary>
|
|
/// <param name="tableName">The table in which existence should be checked (may include schema)</param>
|
|
/// <param name="docId">The ID of the document whose existence should be checked</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>True if a document exists, false if not</returns>
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) conn =
|
|
Custom.scalar (Query.exists tableName (Query.whereById docId)) [ idParam docId ] toExists conn
|
|
|
|
/// <summary>Determine if a document exists using JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table in which existence should be checked (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>True if any matching documents exist, false if not</returns>
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields conn =
|
|
Custom.scalar
|
|
(Query.exists tableName (Query.whereByFields howMatched fields))
|
|
(addFieldParams fields [])
|
|
toExists
|
|
conn
|
|
|
|
/// <summary>Commands to retrieve documents</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Find =
|
|
|
|
/// <summary>Retrieve all documents in the given table</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents from the given table</returns>
|
|
[<CompiledName "FSharpAll">]
|
|
let all<'TDoc> tableName conn =
|
|
Custom.list<'TDoc> (Query.find tableName) [] fromData<'TDoc> conn
|
|
|
|
/// <summary>Retrieve all documents in the given table</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents from the given table</returns>
|
|
let All<'TDoc>(tableName, conn) =
|
|
Custom.List(Query.find tableName, [], fromData<'TDoc>, conn)
|
|
|
|
/// <summary>Retrieve all documents in the given table ordered by the given fields in the document</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents from the given table, ordered by the given fields</returns>
|
|
[<CompiledName "FSharpAllOrdered">]
|
|
let allOrdered<'TDoc> tableName orderFields conn =
|
|
Custom.list<'TDoc> (Query.find tableName + Query.orderBy orderFields SQLite) [] fromData<'TDoc> conn
|
|
|
|
/// <summary>Retrieve all documents in the given table ordered by the given fields in the document</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents from the given table, ordered by the given fields</returns>
|
|
let AllOrdered<'TDoc>(tableName, orderFields, conn) =
|
|
Custom.List(Query.find tableName + Query.orderBy orderFields SQLite, [], fromData<'TDoc>, conn)
|
|
|
|
/// <summary>Retrieve a document by its ID</summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to retrieve</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns><tt>Some</tt> with the document if found, <tt>None</tt> otherwise</returns>
|
|
[<CompiledName "FSharpById">]
|
|
let byId<'TKey, 'TDoc> tableName (docId: 'TKey) conn =
|
|
Custom.single<'TDoc> (Query.byId (Query.find tableName) docId) [ idParam docId ] fromData<'TDoc> conn
|
|
|
|
/// <summary>Retrieve a document by its ID</summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to retrieve</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The document if found, <tt>null</tt> otherwise</returns>
|
|
let ById<'TKey, 'TDoc when 'TDoc: null and 'TDoc: not struct>(tableName, docId: 'TKey, conn) =
|
|
Custom.Single<'TDoc>(Query.byId (Query.find tableName) docId, [ idParam docId ], fromData<'TDoc>, conn)
|
|
|
|
/// <summary>Retrieve documents matching JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents matching the given fields</returns>
|
|
[<CompiledName "FSharpByFields">]
|
|
let byFields<'TDoc> tableName howMatched fields conn =
|
|
Custom.list<'TDoc>
|
|
(Query.byFields (Query.find tableName) howMatched fields)
|
|
(addFieldParams fields [])
|
|
fromData<'TDoc>
|
|
conn
|
|
|
|
/// <summary>Retrieve documents matching JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents matching the given fields</returns>
|
|
let ByFields<'TDoc>(tableName, howMatched, fields, conn) =
|
|
Custom.List<'TDoc>(
|
|
Query.byFields (Query.find tableName) howMatched fields,
|
|
addFieldParams fields [],
|
|
fromData<'TDoc>,
|
|
conn)
|
|
|
|
/// <summary>
|
|
/// Retrieve documents matching JSON field comparisons (<tt>->> =</tt>, etc.) ordered by the given fields
|
|
/// in the document
|
|
/// </summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="queryFields">The field conditions to match</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents matching the given fields, ordered by the other given fields</returns>
|
|
[<CompiledName "FSharpByFieldsOrdered">]
|
|
let byFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn =
|
|
Custom.list<'TDoc>
|
|
(Query.byFields (Query.find tableName) howMatched queryFields + Query.orderBy orderFields SQLite)
|
|
(addFieldParams queryFields [])
|
|
fromData<'TDoc>
|
|
conn
|
|
|
|
/// <summary>
|
|
/// Retrieve documents matching JSON field comparisons (<tt>->> =</tt>, etc.) ordered by the given fields
|
|
/// in the document
|
|
/// </summary>
|
|
/// <param name="tableName">The table from which documents should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="queryFields">The field conditions to match</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>All documents matching the given fields, ordered by the other given fields</returns>
|
|
let ByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields, conn) =
|
|
Custom.List<'TDoc>(
|
|
Query.byFields (Query.find tableName) howMatched queryFields + Query.orderBy orderFields SQLite,
|
|
addFieldParams queryFields [],
|
|
fromData<'TDoc>,
|
|
conn)
|
|
|
|
/// <summary>Retrieve the first document matching JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns><tt>Some</tt> with the first document, or <tt>None</tt> if not found</returns>
|
|
[<CompiledName "FSharpFirstByFields">]
|
|
let firstByFields<'TDoc> tableName howMatched fields conn =
|
|
Custom.single
|
|
$"{Query.byFields (Query.find tableName) howMatched fields} LIMIT 1"
|
|
(addFieldParams fields [])
|
|
fromData<'TDoc>
|
|
conn
|
|
|
|
/// <summary>Retrieve the first document matching JSON field comparisons (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The first document, or <tt>null</tt> if not found</returns>
|
|
let FirstByFields<'TDoc when 'TDoc: null and 'TDoc: not struct>(tableName, howMatched, fields, conn) =
|
|
Custom.Single(
|
|
$"{Query.byFields (Query.find tableName) howMatched fields} LIMIT 1",
|
|
addFieldParams fields [],
|
|
fromData<'TDoc>,
|
|
conn)
|
|
|
|
/// <summary>
|
|
/// Retrieve the first document matching JSON field comparisons (<tt>->> =</tt>, etc.) ordered by the
|
|
/// given fields in the document
|
|
/// </summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="queryFields">The field conditions to match</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>
|
|
/// <tt>Some</tt> with the first document ordered by the given fields, or <tt>None</tt> if not found
|
|
/// </returns>
|
|
[<CompiledName "FSharpFirstByFieldsOrdered">]
|
|
let firstByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn =
|
|
Custom.single
|
|
$"{Query.byFields (Query.find tableName) howMatched queryFields}{Query.orderBy orderFields SQLite} LIMIT 1"
|
|
(addFieldParams queryFields [])
|
|
fromData<'TDoc>
|
|
conn
|
|
|
|
/// <summary>
|
|
/// Retrieve the first document matching JSON field comparisons (<tt>->> =</tt>, etc.) ordered by the
|
|
/// given fields in the document
|
|
/// </summary>
|
|
/// <param name="tableName">The table from which a document should be retrieved (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="queryFields">The field conditions to match</param>
|
|
/// <param name="orderFields">Fields by which the results should be ordered</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
/// <returns>The first document ordered by the given fields, or <tt>null</tt> if not found</returns>
|
|
let FirstByFieldsOrdered<'TDoc when 'TDoc: null and 'TDoc: not struct>(
|
|
tableName, howMatched, queryFields, orderFields, conn) =
|
|
Custom.Single(
|
|
$"{Query.byFields (Query.find tableName) howMatched queryFields}{Query.orderBy orderFields SQLite} LIMIT 1",
|
|
addFieldParams queryFields [],
|
|
fromData<'TDoc>,
|
|
conn)
|
|
|
|
/// <summary>Commands to update documents</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Update =
|
|
|
|
/// <summary>Update (replace) an entire document by its ID</summary>
|
|
/// <param name="tableName">The table in which a document should be updated (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to be updated (replaced)</param>
|
|
/// <param name="document">The new document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) (document: 'TDoc) conn =
|
|
Custom.nonQuery
|
|
(Query.statementWhere (Query.update tableName) (Query.whereById docId))
|
|
[ idParam docId; jsonParam "@data" document ]
|
|
conn
|
|
|
|
/// <summary>
|
|
/// Update (replace) an entire document by its ID, using the provided function to obtain the ID from the
|
|
/// document
|
|
/// </summary>
|
|
/// <param name="tableName">The table in which a document should be updated (may include schema)</param>
|
|
/// <param name="idFunc">The function to obtain the ID of the document</param>
|
|
/// <param name="document">The new document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "FSharpByFunc">]
|
|
let byFunc tableName (idFunc: 'TDoc -> 'TKey) (document: 'TDoc) conn =
|
|
byId tableName (idFunc document) document conn
|
|
|
|
/// <summary>
|
|
/// Update (replace) an entire document by its ID, using the provided function to obtain the ID from the
|
|
/// document
|
|
/// </summary>
|
|
/// <param name="tableName">The table in which a document should be updated (may include schema)</param>
|
|
/// <param name="idFunc">The function to obtain the ID of the document</param>
|
|
/// <param name="document">The new document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
let ByFunc(tableName, idFunc: System.Func<'TDoc, 'TKey>, document: 'TDoc, conn) =
|
|
byFunc tableName idFunc.Invoke document conn
|
|
|
|
/// <summary>Commands to patch (partially update) documents</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Patch =
|
|
|
|
/// <summary>Patch a document by its ID</summary>
|
|
/// <param name="tableName">The table in which a document should be patched (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to patch</param>
|
|
/// <param name="patch">The partial document to patch the existing document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) (patch: 'TPatch) conn =
|
|
Custom.nonQuery
|
|
(Query.byId (Query.patch tableName) docId) [ idParam docId; jsonParam "@data" patch ] conn
|
|
|
|
/// <summary>
|
|
/// Patch documents using a JSON field comparison query in the <tt>WHERE</tt> clause (<tt>->> =</tt>,
|
|
/// etc.)
|
|
/// </summary>
|
|
/// <param name="tableName">The table in which documents should be patched (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="patch">The partial document to patch the existing document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields (patch: 'TPatch) conn =
|
|
Custom.nonQuery
|
|
(Query.byFields (Query.patch tableName) howMatched fields)
|
|
(addFieldParams fields [ jsonParam "@data" patch ])
|
|
conn
|
|
|
|
/// <summary>Commands to remove fields from documents</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module RemoveFields =
|
|
|
|
/// <summary>Remove fields from a document by the document's ID</summary>
|
|
/// <param name="tableName">The table in which a document should be modified (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to modify</param>
|
|
/// <param name="fieldNames">One or more field names to remove from the document</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) fieldNames conn =
|
|
let nameParams = fieldNameParams "@name" fieldNames
|
|
Custom.nonQuery
|
|
(Query.byId (Query.removeFields tableName nameParams) docId)
|
|
(idParam docId |> Seq.singleton |> Seq.append nameParams)
|
|
conn
|
|
|
|
/// <summary>Remove fields from documents via a comparison on JSON fields in the document</summary>
|
|
/// <param name="tableName">The table in which documents should be modified (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="fieldNames">One or more field names to remove from the matching documents</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields fieldNames conn =
|
|
let nameParams = fieldNameParams "@name" fieldNames
|
|
Custom.nonQuery
|
|
(Query.byFields (Query.removeFields tableName nameParams) howMatched fields)
|
|
(addFieldParams fields nameParams)
|
|
conn
|
|
|
|
/// Commands to delete documents
|
|
[<RequireQualifiedAccess>]
|
|
module Delete =
|
|
|
|
/// <summary>Delete a document by its ID</summary>
|
|
/// <param name="tableName">The table in which a document should be deleted (may include schema)</param>
|
|
/// <param name="docId">The ID of the document to delete</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) conn =
|
|
Custom.nonQuery (Query.byId (Query.delete tableName) docId) [ idParam docId ] conn
|
|
|
|
/// <summary>Delete documents by matching a JSON field comparison query (<tt>->> =</tt>, etc.)</summary>
|
|
/// <param name="tableName">The table in which documents should be deleted (may include schema)</param>
|
|
/// <param name="howMatched">Whether to match any or all of the field conditions</param>
|
|
/// <param name="fields">The field conditions to match</param>
|
|
/// <param name="conn">The <tt>SqliteConnection</tt> to use to execute the query</param>
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields conn =
|
|
Custom.nonQuery (Query.byFields (Query.delete tableName) howMatched fields) (addFieldParams fields []) conn
|
|
|
|
|
|
/// <summary>Commands to execute custom SQL queries</summary>
|
|
[<RequireQualifiedAccess>]
|
|
module Custom =
|
|
|
|
/// <summary>Execute a query that returns a list of results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <returns>A list of results for the given query</returns>
|
|
[<CompiledName "FSharpList">]
|
|
let list<'TDoc> query parameters (mapFunc: SqliteDataReader -> 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.list<'TDoc> query parameters mapFunc conn
|
|
|
|
/// <summary>Execute a query that returns a list of results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <returns>A list of results for the given query</returns>
|
|
let List<'TDoc>(query, parameters, mapFunc: System.Func<SqliteDataReader, 'TDoc>) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.List<'TDoc>(query, parameters, mapFunc, conn)
|
|
|
|
/// <summary>Execute a query that returns one or no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <returns><tt>Some</tt> with the first matching result, or <tt>None</tt> if not found</returns>
|
|
[<CompiledName "FSharpSingle">]
|
|
let single<'TDoc> query parameters (mapFunc: SqliteDataReader -> 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.single<'TDoc> query parameters mapFunc conn
|
|
|
|
/// <summary>Execute a query that returns one or no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function between the document and the domain item</param>
|
|
/// <returns>The first matching result, or <tt>null</tt> if not found</returns>
|
|
let Single<'TDoc when 'TDoc: null and 'TDoc: not struct>(
|
|
query, parameters, mapFunc: System.Func<SqliteDataReader, 'TDoc>) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.Single<'TDoc>(query, parameters, mapFunc, conn)
|
|
|
|
/// <summary>Execute a query that returns no results</summary>
|
|
/// <param name="query">The query to retrieve the results</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
[<CompiledName "NonQuery">]
|
|
let nonQuery query parameters =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.nonQuery query parameters conn
|
|
|
|
/// <summary>Execute a query that returns a scalar value</summary>
|
|
/// <param name="query">The query to retrieve the value</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function to obtain the value</param>
|
|
/// <returns>The scalar value for the query</returns>
|
|
[<CompiledName "FSharpScalar">]
|
|
let scalar<'T when 'T: struct> query parameters (mapFunc: SqliteDataReader -> 'T) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.scalar<'T> query parameters mapFunc conn
|
|
|
|
/// <summary>Execute a query that returns a scalar value</summary>
|
|
/// <param name="query">The query to retrieve the value</param>
|
|
/// <param name="parameters">Parameters to use for the query</param>
|
|
/// <param name="mapFunc">The mapping function to obtain the value</param>
|
|
/// <returns>The scalar value for the query</returns>
|
|
let Scalar<'T when 'T: struct>(query, parameters, mapFunc: System.Func<SqliteDataReader, 'T>) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Custom.Scalar<'T>(query, parameters, mapFunc, conn)
|
|
|
|
|
|
/// Functions to create tables and indexes
|
|
[<RequireQualifiedAccess>]
|
|
module Definition =
|
|
|
|
/// Create a document table
|
|
[<CompiledName "EnsureTable">]
|
|
let ensureTable name =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Definition.ensureTable name conn
|
|
|
|
/// Create an index on a document table
|
|
[<CompiledName "EnsureFieldIndex">]
|
|
let ensureFieldIndex tableName indexName fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Definition.ensureFieldIndex tableName indexName fields conn
|
|
|
|
|
|
/// Document insert/save functions
|
|
[<AutoOpen>]
|
|
module Document =
|
|
|
|
/// Insert a new document
|
|
[<CompiledName "Insert">]
|
|
let insert<'TDoc> tableName (document: 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Document.insert tableName document conn
|
|
|
|
/// Save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
|
|
[<CompiledName "Save">]
|
|
let save<'TDoc> tableName (document: 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Document.save tableName document conn
|
|
|
|
|
|
/// Commands to count documents
|
|
[<RequireQualifiedAccess>]
|
|
module Count =
|
|
|
|
/// Count all documents in a table
|
|
[<CompiledName "All">]
|
|
let all tableName =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Count.all tableName conn
|
|
|
|
/// Count matching documents using a comparison on JSON fields
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Count.byFields tableName howMatched fields conn
|
|
|
|
|
|
/// Commands to determine if documents exist
|
|
[<RequireQualifiedAccess>]
|
|
module Exists =
|
|
|
|
/// Determine if a document exists for the given ID
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Exists.byId tableName docId conn
|
|
|
|
/// Determine if a document exists using a comparison on JSON fields
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Exists.byFields tableName howMatched fields conn
|
|
|
|
|
|
/// Commands to determine if documents exist
|
|
[<RequireQualifiedAccess>]
|
|
module Find =
|
|
|
|
/// Retrieve all documents in the given table
|
|
[<CompiledName "FSharpAll">]
|
|
let all<'TDoc> tableName =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.all<'TDoc> tableName conn
|
|
|
|
/// Retrieve all documents in the given table
|
|
let All<'TDoc> tableName =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.All<'TDoc>(tableName, conn)
|
|
|
|
/// Retrieve all documents in the given table ordered by the given fields in the document
|
|
[<CompiledName "FSharpAllOrdered">]
|
|
let allOrdered<'TDoc> tableName orderFields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.allOrdered<'TDoc> tableName orderFields conn
|
|
|
|
/// Retrieve all documents in the given table ordered by the given fields in the document
|
|
let AllOrdered<'TDoc> tableName orderFields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.AllOrdered<'TDoc>(tableName, orderFields, conn)
|
|
|
|
/// Retrieve a document by its ID (returns None if not found)
|
|
[<CompiledName "FSharpById">]
|
|
let byId<'TKey, 'TDoc> tableName docId =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.byId<'TKey, 'TDoc> tableName docId conn
|
|
|
|
/// Retrieve a document by its ID (returns null if not found)
|
|
let ById<'TKey, 'TDoc when 'TDoc: null and 'TDoc: not struct>(tableName, docId) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.ById<'TKey, 'TDoc>(tableName, docId, conn)
|
|
|
|
/// Retrieve documents via a comparison on JSON fields
|
|
[<CompiledName "FSharpByFields">]
|
|
let byFields<'TDoc> tableName howMatched fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.byFields<'TDoc> tableName howMatched fields conn
|
|
|
|
/// Retrieve documents via a comparison on JSON fields
|
|
let ByFields<'TDoc>(tableName, howMatched, fields) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.ByFields<'TDoc>(tableName, howMatched, fields, conn)
|
|
|
|
/// Retrieve documents via a comparison on JSON fields ordered by the given fields in the document
|
|
[<CompiledName "FSharpByFieldsOrdered">]
|
|
let byFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.byFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn
|
|
|
|
/// Retrieve documents via a comparison on JSON fields ordered by the given fields in the document
|
|
let ByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.ByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields, conn)
|
|
|
|
/// Retrieve documents via a comparison on JSON fields, returning only the first result
|
|
[<CompiledName "FSharpFirstByFields">]
|
|
let firstByFields<'TDoc> tableName howMatched fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.firstByFields<'TDoc> tableName howMatched fields conn
|
|
|
|
/// Retrieve documents via a comparison on JSON fields, returning only the first result
|
|
let FirstByFields<'TDoc when 'TDoc: null and 'TDoc: not struct>(tableName, howMatched, fields) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.FirstByFields<'TDoc>(tableName, howMatched, fields, conn)
|
|
|
|
/// Retrieve documents via a comparison on JSON fields ordered by the given fields in the document, returning only
|
|
/// the first result
|
|
[<CompiledName "FSharpFirstByFieldsOrdered">]
|
|
let firstByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.firstByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn
|
|
|
|
/// Retrieve documents via a comparison on JSON fields ordered by the given fields in the document, returning only
|
|
/// the first result
|
|
let FirstByFieldsOrdered<'TDoc when 'TDoc: null and 'TDoc: not struct>(
|
|
tableName, howMatched, queryFields, orderFields) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Find.FirstByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields, conn)
|
|
|
|
|
|
/// Commands to update documents
|
|
[<RequireQualifiedAccess>]
|
|
module Update =
|
|
|
|
/// Update an entire document by its ID
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) (document: 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Update.byId tableName docId document conn
|
|
|
|
/// Update an entire document by its ID, using the provided function to obtain the ID from the document
|
|
[<CompiledName "FSharpByFunc">]
|
|
let byFunc tableName (idFunc: 'TDoc -> 'TKey) (document: 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Update.byFunc tableName idFunc document conn
|
|
|
|
/// Update an entire document by its ID, using the provided function to obtain the ID from the document
|
|
let ByFunc(tableName, idFunc: System.Func<'TDoc, 'TKey>, document: 'TDoc) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Update.ByFunc(tableName, idFunc, document, conn)
|
|
|
|
|
|
/// Commands to patch (partially update) documents
|
|
[<RequireQualifiedAccess>]
|
|
module Patch =
|
|
|
|
/// Patch a document by its ID
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) (patch: 'TPatch) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Patch.byId tableName docId patch conn
|
|
|
|
/// Patch documents using a comparison on JSON fields in the WHERE clause
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields (patch: 'TPatch) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Patch.byFields tableName howMatched fields patch conn
|
|
|
|
|
|
/// Commands to remove fields from documents
|
|
[<RequireQualifiedAccess>]
|
|
module RemoveFields =
|
|
|
|
/// Remove fields from a document by the document's ID
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) fieldNames =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.RemoveFields.byId tableName docId fieldNames conn
|
|
|
|
/// Remove field from documents via a comparison on JSON fields in the document
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields fieldNames =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.RemoveFields.byFields tableName howMatched fields fieldNames conn
|
|
|
|
|
|
/// Commands to delete documents
|
|
[<RequireQualifiedAccess>]
|
|
module Delete =
|
|
|
|
/// Delete a document by its ID
|
|
[<CompiledName "ById">]
|
|
let byId tableName (docId: 'TKey) =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Delete.byId tableName docId conn
|
|
|
|
/// Delete documents by matching a comparison on JSON fields
|
|
[<CompiledName "ByFields">]
|
|
let byFields tableName howMatched fields =
|
|
use conn = Configuration.dbConn ()
|
|
WithConn.Delete.byFields tableName howMatched fields conn
|