namespace BitBadger.Documents.Sqlite
open Microsoft.Data.Sqlite
open WithConn
/// F# extensions for the SqliteConnection type
[]
module Extensions =
type SqliteConnection with
/// Execute a query that returns a list of results
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function between the document and the domain item
/// A list of results for the given query
member conn.customList<'TDoc> query parameters mapFunc =
Custom.list<'TDoc> query parameters mapFunc conn
/// Execute a query that returns a JSON array of results
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function to extract the document
/// A JSON array of results for the given query
member conn.customJsonArray query parameters mapFunc =
Custom.jsonArray query parameters mapFunc conn
/// Execute a query, writing its results to the given PipeWriter
/// The query to retrieve the results
/// Parameters to use for the query
/// The PipeWriter to which the results should be written
/// The mapping function to extract the document
member conn.writeCustomJsonArray query parameters writer mapFunc =
Custom.writeJsonArray query parameters writer mapFunc conn
/// Execute a query that returns one or no results
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function between the document and the domain item
/// Some with the first matching result, or None if not found
member conn.customSingle<'TDoc> query parameters mapFunc =
Custom.single<'TDoc> query parameters mapFunc conn
/// Execute a query that returns one or no JSON documents
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function to extract the document
/// The JSON document with the first matching result, or an empty document if not found
member conn.customJsonSingle query parameters mapFunc =
Custom.jsonSingle query parameters mapFunc conn
/// Execute a query that returns no results
/// The query to retrieve the results
/// Parameters to use for the query
member conn.customNonQuery query parameters =
Custom.nonQuery query parameters conn
/// Execute a query that returns a scalar value
/// The query to retrieve the value
/// Parameters to use for the query
/// The mapping function to obtain the value
/// The scalar value for the query
member conn.customScalar<'T when 'T: struct> query parameters mapFunc =
Custom.scalar<'T> query parameters mapFunc conn
/// Create a document table
/// The table whose existence should be ensured (may include schema)
member conn.ensureTable name =
Definition.ensureTable name conn
/// Create an index on field(s) within documents in the specified table
/// The table to be indexed (may include schema)
/// The name of the index to create
/// One or more fields to be indexed
member conn.ensureFieldIndex tableName indexName fields =
Definition.ensureFieldIndex tableName indexName fields conn
/// Insert a new document
/// The table into which the document should be inserted (may include schema)
/// The document to be inserted
member conn.insert<'TDoc> tableName (document: 'TDoc) =
insert<'TDoc> tableName document conn
///
/// Save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
///
/// The table into which the document should be saved (may include schema)
/// The document to be saved
member conn.save<'TDoc> tableName (document: 'TDoc) =
save tableName document conn
/// Count all documents in a table
/// The table in which documents should be counted (may include schema)
/// The count of the documents in the table
member conn.countAll tableName =
Count.all tableName conn
/// Count matching documents using JSON field comparisons (->> =, etc.)
/// The table in which documents should be counted (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The count of matching documents in the table
member conn.countByFields tableName howMatched fields =
Count.byFields tableName howMatched fields conn
/// Determine if a document exists for the given ID
/// The table in which existence should be checked (may include schema)
/// The ID of the document whose existence should be checked
/// True if a document exists, false if not
member conn.existsById tableName (docId: 'TKey) =
Exists.byId tableName docId conn
/// Determine if a document exists using JSON field comparisons (->> =, etc.)
/// The table in which existence should be checked (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// True if any matching documents exist, false if not
member conn.existsByFields tableName howMatched fields =
Exists.byFields tableName howMatched fields conn
/// Retrieve all documents in the given table
/// The table from which documents should be retrieved (may include schema)
/// All documents from the given table
member conn.findAll<'TDoc> tableName =
Find.all<'TDoc> tableName conn
/// Retrieve all documents in the given table ordered by the given fields in the document
/// The table from which documents should be retrieved (may include schema)
/// Fields by which the results should be ordered
/// All documents from the given table, ordered by the given fields
member conn.findAllOrdered<'TDoc> tableName orderFields =
Find.allOrdered<'TDoc> tableName orderFields conn
/// Retrieve a document by its ID
/// The table from which a document should be retrieved (may include schema)
/// The ID of the document to retrieve
/// Some with the document if found, None otherwise
member conn.findById<'TKey, 'TDoc> tableName (docId: 'TKey) =
Find.byId<'TKey, 'TDoc> tableName docId conn
/// Retrieve documents matching JSON field comparisons (->> =, etc.)
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// All documents matching the given fields
member conn.findByFields<'TDoc> tableName howMatched fields =
Find.byFields<'TDoc> tableName howMatched fields conn
///
/// Retrieve documents matching JSON field comparisons (->> =, etc.) ordered by the given fields in
/// the document
///
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// All documents matching the given fields, ordered by the other given fields
member conn.findByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields =
Find.byFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn
/// Retrieve the first document matching JSON field comparisons (->> =, etc.)
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Some with the first document, or None if not found
member conn.findFirstByFields<'TDoc> tableName howMatched fields =
Find.firstByFields<'TDoc> tableName howMatched fields conn
///
/// Retrieve the first document matching JSON field comparisons (->> =, etc.) ordered by the
/// given fields in the document
///
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
///
/// Some with the first document ordered by the given fields, or None if not found
///
member conn.findFirstByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields =
Find.firstByFieldsOrdered<'TDoc> tableName howMatched queryFields orderFields conn
/// Retrieve all JSON documents in the given table
/// The table from which documents should be retrieved (may include schema)
/// All JSON documents from the given table
member conn.jsonAll tableName =
Json.all tableName conn
/// Retrieve all JSON documents in the given table ordered by the given fields in the document
/// The table from which documents should be retrieved (may include schema)
/// Fields by which the results should be ordered
/// All JSON documents from the given table, ordered by the given fields
member conn.jsonAllOrdered tableName orderFields =
Json.allOrdered tableName orderFields conn
/// Retrieve a JSON document by its ID
/// The table from which a document should be retrieved (may include schema)
/// The ID of the document to retrieve
/// The JSON document if found, an empty JSON document otherwise
member conn.jsonById<'TKey> tableName (docId: 'TKey) =
Json.byId tableName docId conn
/// Retrieve JSON documents matching JSON field comparisons (->> =, etc.)
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// All JSON documents matching the given fields
member conn.jsonByFields tableName howMatched fields =
Json.byFields tableName howMatched fields conn
///
/// Retrieve JSON documents matching JSON field comparisons (->> =, etc.) ordered by the given
/// fields in the document
///
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// All JSON documents matching the given fields, ordered by the other given fields
member conn.jsonByFieldsOrdered tableName howMatched queryFields orderFields =
Json.byFieldsOrdered tableName howMatched queryFields orderFields conn
///
/// Retrieve the first JSON document matching JSON field comparisons (->> =, etc.)
///
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The first JSON document if found, an empty JSON document otherwise
member conn.jsonFirstByFields tableName howMatched fields =
Json.firstByFields tableName howMatched fields conn
///
/// Retrieve the first JSON document matching JSON field comparisons (->> =, etc.) ordered by the
/// given fields in the document
///
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// The first JSON document (in order) if found, an empty JSON document otherwise
member conn.jsonFirstByFieldsOrdered tableName howMatched queryFields orderFields =
Json.firstByFieldsOrdered tableName howMatched queryFields orderFields conn
/// Write all JSON documents in the given table to the given PipeWriter
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
member conn.writeJsonAll tableName writer =
Json.writeAll tableName writer conn
///
/// Write all JSON all documents in the given table to the given PipeWriter, ordered by the given fields
/// in the document
///
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Fields by which the results should be ordered
member conn.writeJsonAllOrdered tableName writer orderFields =
Json.writeAllOrdered tableName writer orderFields conn
/// Write a JSON document to the given PipeWriter by its ID
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// The ID of the document to retrieve
member conn.writeJsonById<'TKey> tableName writer (docId: 'TKey) =
Json.writeById tableName writer docId conn
///
/// Write JSON documents to the given PipeWriter matching JSON field comparisons (->> =,
/// etc.)
///
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
member conn.writeJsonByFields tableName writer howMatched fields =
Json.writeByFields tableName writer howMatched fields conn
///
/// Write JSON documents to the given PipeWriter matching JSON field comparisons (->> =,
/// etc.) ordered by the given fields in the document
///
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
member conn.writeJsonByFieldsOrdered tableName writer howMatched queryFields orderFields =
Json.writeByFieldsOrdered tableName writer howMatched queryFields orderFields conn
///
/// Write the first JSON document to the given PipeWriter matching JSON field comparisons
/// (->> =, etc.)
///
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
member conn.writeJsonFirstByFields tableName writer howMatched fields =
Json.writeFirstByFields tableName writer howMatched fields conn
///
/// Write the first JSON document to the given PipeWriter matching JSON field comparisons
/// (->> =, etc.) ordered by the given fields in the document
///
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
member conn.writeJsonFirstByFieldsOrdered tableName writer howMatched queryFields orderFields =
Json.writeFirstByFieldsOrdered tableName writer howMatched queryFields orderFields conn
/// Update (replace) an entire document by its ID
/// The table in which a document should be updated (may include schema)
/// The ID of the document to be updated (replaced)
/// The new document
member conn.updateById tableName (docId: 'TKey) (document: 'TDoc) =
Update.byId tableName docId document conn
///
/// Update (replace) an entire document by its ID, using the provided function to obtain the ID from the
/// document
///
/// The table in which a document should be updated (may include schema)
/// The function to obtain the ID of the document
/// The new document
member conn.updateByFunc tableName (idFunc: 'TDoc -> 'TKey) (document: 'TDoc) =
Update.byFunc tableName idFunc document conn
/// Patch a document by its ID
/// The table in which a document should be patched (may include schema)
/// The ID of the document to patch
/// The partial document to patch the existing document
member conn.patchById tableName (docId: 'TKey) (patch: 'TPatch) =
Patch.byId tableName docId patch conn
///
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =, etc.)
///
/// The table in which documents should be patched (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The partial document to patch the existing document
member conn.patchByFields tableName howMatched fields (patch: 'TPatch) =
Patch.byFields tableName howMatched fields patch conn
/// Remove fields from a document by the document's ID
/// The table in which a document should be modified (may include schema)
/// The ID of the document to modify
/// One or more field names to remove from the document
member conn.removeFieldsById tableName (docId: 'TKey) fieldNames =
RemoveFields.byId tableName docId fieldNames conn
/// Remove fields from documents via a comparison on JSON fields in the document
/// The table in which documents should be modified (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// One or more field names to remove from the matching documents
member conn.removeFieldsByFields tableName howMatched fields fieldNames =
RemoveFields.byFields tableName howMatched fields fieldNames conn
/// Delete a document by its ID
/// The table in which a document should be deleted (may include schema)
/// The ID of the document to delete
member conn.deleteById tableName (docId: 'TKey) =
Delete.byId tableName docId conn
/// Delete documents by matching a JSON field comparison query (->> =, etc.)
/// The table in which documents should be deleted (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
member conn.deleteByFields tableName howMatched fields =
Delete.byFields tableName howMatched fields conn
open System.Runtime.CompilerServices
/// C# extensions on the SqliteConnection type
type SqliteConnectionCSharpExtensions =
/// Execute a query that returns a list of results
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function between the document and the domain item
/// A list of results for the given query
[]
static member inline CustomList<'TDoc>(conn, query, parameters, mapFunc: System.Func) =
Custom.List<'TDoc>(query, parameters, mapFunc, conn)
/// Execute a query that returns a JSON array of results
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function to extract the document
/// A JSON array of results for the given query
[]
static member inline CustomJsonArray(conn, query, parameters, mapFunc) =
Custom.JsonArray(query, parameters, mapFunc, conn)
/// Execute a query, writing its results to the given PipeWriter
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
/// The PipeWriter to which the results should be written
/// The mapping function to extract the document
[]
static member inline WriteCustomJsonArray(conn, query, parameters, writer, mapFunc) =
Custom.WriteJsonArray(query, parameters, writer, mapFunc, conn)
/// Execute a query that returns one or no results
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function between the document and the domain item
/// The first matching result, or null if not found
[]
static member inline CustomSingle<'TDoc when 'TDoc: null and 'TDoc: not struct>(
conn, query, parameters, mapFunc: System.Func) =
Custom.Single<'TDoc>(query, parameters, mapFunc, conn)
/// Execute a query that returns one or no JSON documents
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
/// The mapping function to extract the document
/// The JSON document with the first matching result, or an empty document if not found
[]
static member inline CustomJsonSingle(conn, query, parameters, mapFunc) =
Custom.JsonSingle(query, parameters, mapFunc, conn)
/// Execute a query that returns no results
/// The SqliteConnection on which to run the query
/// The query to retrieve the results
/// Parameters to use for the query
[]
static member inline CustomNonQuery(conn, query, parameters) =
Custom.nonQuery query parameters conn
/// Execute a query that returns a scalar value
/// The SqliteConnection on which to run the query
/// The query to retrieve the value
/// Parameters to use for the query
/// The mapping function to obtain the value
/// The scalar value for the query
[]
static member inline CustomScalar<'T when 'T: struct>(
conn, query, parameters, mapFunc: System.Func) =
Custom.Scalar<'T>(query, parameters, mapFunc, conn)
/// Create a document table
/// The SqliteConnection on which to run the query
/// The table whose existence should be ensured (may include schema)
[]
static member inline EnsureTable(conn, name) =
Definition.ensureTable name conn
/// Create an index on field(s) within documents in the specified table
/// The SqliteConnection on which to run the query
/// The table to be indexed (may include schema)
/// The name of the index to create
/// One or more fields to be indexed
[]
static member inline EnsureFieldIndex(conn, tableName, indexName, fields) =
Definition.ensureFieldIndex tableName indexName fields conn
/// Insert a new document
/// The SqliteConnection on which to run the query
/// The table into which the document should be inserted (may include schema)
/// The document to be inserted
[]
static member inline Insert<'TDoc>(conn, tableName, document: 'TDoc) =
insert<'TDoc> tableName document conn
/// Save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
/// The SqliteConnection on which to run the query
/// The table into which the document should be saved (may include schema)
/// The document to be saved
[]
static member inline Save<'TDoc>(conn, tableName, document: 'TDoc) =
save<'TDoc> tableName document conn
/// Count all documents in a table
/// The SqliteConnection on which to run the query
/// The table in which documents should be counted (may include schema)
/// The count of the documents in the table
[]
static member inline CountAll(conn, tableName) =
Count.all tableName conn
/// Count matching documents using JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table in which documents should be counted (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The count of matching documents in the table
[]
static member inline CountByFields(conn, tableName, howMatched, fields) =
Count.byFields tableName howMatched fields conn
/// Determine if a document exists for the given ID
/// The SqliteConnection on which to run the query
/// The table in which existence should be checked (may include schema)
/// The ID of the document whose existence should be checked
/// True if a document exists, false if not
[]
static member inline ExistsById<'TKey>(conn, tableName, docId: 'TKey) =
Exists.byId tableName docId conn
/// Determine if a document exists using JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table in which existence should be checked (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// True if any matching documents exist, false if not
[]
static member inline ExistsByFields(conn, tableName, howMatched, fields) =
Exists.byFields tableName howMatched fields conn
/// Retrieve all documents in the given table
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// All documents from the given table
[]
static member inline FindAll<'TDoc>(conn, tableName) =
Find.All<'TDoc>(tableName, conn)
/// Retrieve all documents in the given table ordered by the given fields in the document
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Fields by which the results should be ordered
/// All documents from the given table, ordered by the given fields
[]
static member inline FindAllOrdered<'TDoc>(conn, tableName, orderFields) =
Find.AllOrdered<'TDoc>(tableName, orderFields, conn)
/// Retrieve a document by its ID
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// The ID of the document to retrieve
/// The document if found, null otherwise
[]
static member inline FindById<'TKey, 'TDoc when 'TDoc: null and 'TDoc: not struct>(conn, tableName, docId: 'TKey) =
Find.ById<'TKey, 'TDoc>(tableName, docId, conn)
/// Retrieve documents matching JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// All documents matching the given fields
[]
static member inline FindByFields<'TDoc>(conn, tableName, howMatched, fields) =
Find.ByFields<'TDoc>(tableName, howMatched, fields, conn)
///
/// Retrieve documents matching JSON field comparisons (->> =, etc.) ordered by the given fields in
/// the document
///
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// All documents matching the given fields, ordered by the other given fields
[]
static member inline FindByFieldsOrdered<'TDoc>(conn, tableName, howMatched, queryFields, orderFields) =
Find.ByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields, conn)
/// Retrieve the first document matching JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The first document, or null if not found
[]
static member inline FindFirstByFields<'TDoc when 'TDoc: null and 'TDoc: not struct>(
conn, tableName, howMatched, fields) =
Find.FirstByFields<'TDoc>(tableName, howMatched, fields, conn)
///
/// Retrieve the first document matching JSON field comparisons (->> =, etc.) ordered by the given
/// fields in the document
///
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// The first document ordered by the given fields, or null if not found
[]
static member inline FindFirstByFieldsOrdered<'TDoc when 'TDoc: null and 'TDoc: not struct>(
conn, tableName, howMatched, queryFields, orderFields) =
Find.FirstByFieldsOrdered<'TDoc>(tableName, howMatched, queryFields, orderFields, conn)
/// Retrieve all JSON documents in the given table
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// All JSON documents from the given table
[]
static member inline JsonAll(conn, tableName) =
Json.all tableName conn
/// Retrieve all JSON documents in the given table ordered by the given fields in the document
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Fields by which the results should be ordered
/// All JSON documents from the given table, ordered by the given fields
[]
static member inline JsonAllOrdered(conn, tableName, orderFields) =
Json.allOrdered tableName orderFields conn
/// Retrieve a JSON document by its ID
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// The ID of the document to retrieve
/// The JSON document if found, an empty JSON document otherwise
[]
static member inline JsonById<'TKey>(conn, tableName, docId: 'TKey) =
Json.byId tableName docId conn
/// Retrieve JSON documents matching JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// All JSON documents matching the given fields
[]
static member inline JsonByFields(conn, tableName, howMatched, fields) =
Json.byFields tableName howMatched fields conn
///
/// Retrieve JSON documents matching JSON field comparisons (->> =, etc.) ordered by the given fields
/// in the document
///
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// All JSON documents matching the given fields, ordered by the other given fields
[]
static member inline JsonByFieldsOrdered(conn, tableName, howMatched, queryFields, orderFields) =
Json.byFieldsOrdered tableName howMatched queryFields orderFields conn
/// Retrieve the first JSON document matching JSON field comparisons (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The first JSON document if found, an empty JSON document otherwise
[]
static member inline JsonFirstByFields(conn, tableName, howMatched, fields) =
Json.firstByFields tableName howMatched fields conn
///
/// Retrieve the first JSON document matching JSON field comparisons (->> =, etc.) ordered by the given
/// fields in the document
///
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
/// The first JSON document (in order) if found, an empty JSON document otherwise
[]
static member inline JsonFirstByFieldsOrdered(conn, tableName, howMatched, queryFields, orderFields) =
Json.firstByFieldsOrdered tableName howMatched queryFields orderFields conn
/// Write all JSON documents in the given table to the given PipeWriter
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
[]
static member inline WriteJsonAll(conn, tableName, writer) =
Json.writeAll tableName writer conn
///
/// Write all JSON all documents in the given table to the given PipeWriter, ordered by the given fields in
/// the document
///
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Fields by which the results should be ordered
[]
static member inline WriteJsonAllOrdered(conn, tableName, writer, orderFields) =
Json.writeAllOrdered tableName writer orderFields conn
/// Write a JSON document to the given PipeWriter by its ID
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// The ID of the document to retrieve
[]
static member inline WriteJsonById<'TKey>(conn, tableName, writer, docId: 'TKey) =
Json.writeById tableName writer docId conn
///
/// Write JSON documents to the given PipeWriter matching JSON field comparisons (->> =, etc.)
///
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
[]
static member inline WriteJsonByFields(conn, tableName, writer, howMatched, fields) =
Json.writeByFields tableName writer howMatched fields conn
///
/// Write JSON documents to the given PipeWriter matching JSON field comparisons (->> =, etc.)
/// ordered by the given fields in the document
///
/// The SqliteConnection on which to run the query
/// The table from which documents should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
[]
static member inline WriteJsonByFieldsOrdered(conn, tableName, writer, howMatched, queryFields, orderFields) =
Json.writeByFieldsOrdered tableName writer howMatched queryFields orderFields conn
///
/// Write the first JSON document to the given PipeWriter matching JSON field comparisons
/// (->> =, etc.)
///
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
[]
static member inline WriteJsonFirstByFields(conn, tableName, writer, howMatched, fields) =
Json.writeFirstByFields tableName writer howMatched fields conn
///
/// Write the first JSON document to the given PipeWriter matching JSON field comparisons
/// (->> =, etc.) ordered by the given fields in the document
///
/// The SqliteConnection on which to run the query
/// The table from which a document should be retrieved (may include schema)
/// The PipeWriter to which the results should be written
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// Fields by which the results should be ordered
[]
static member inline WriteJsonFirstByFieldsOrdered(conn, tableName, writer, howMatched, queryFields, orderFields) =
Json.writeFirstByFieldsOrdered tableName writer howMatched queryFields orderFields conn
/// Update (replace) an entire document by its ID
/// The SqliteConnection on which to run the query
/// The table in which a document should be updated (may include schema)
/// The ID of the document to be updated (replaced)
/// The new document
[]
static member inline UpdateById<'TKey, 'TDoc>(conn, tableName, docId: 'TKey, document: 'TDoc) =
Update.byId tableName docId document conn
///
/// Update (replace) an entire document by its ID, using the provided function to obtain the ID from the document
///
/// The SqliteConnection on which to run the query
/// The table in which a document should be updated (may include schema)
/// The function to obtain the ID of the document
/// The new document
[]
static member inline UpdateByFunc<'TKey, 'TDoc>(
conn, tableName, idFunc: System.Func<'TDoc, 'TKey>, document: 'TDoc) =
Update.ByFunc(tableName, idFunc, document, conn)
/// Patch a document by its ID
/// The SqliteConnection on which to run the query
/// The table in which a document should be patched (may include schema)
/// The ID of the document to patch
/// The partial document to patch the existing document
[]
static member inline PatchById<'TKey, 'TPatch>(conn, tableName, docId: 'TKey, patch: 'TPatch) =
Patch.byId tableName docId patch conn
///
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =, etc.)
///
/// The SqliteConnection on which to run the query
/// The table in which documents should be patched (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// The partial document to patch the existing document
[]
static member inline PatchByFields<'TPatch>(conn, tableName, howMatched, fields, patch: 'TPatch) =
Patch.byFields tableName howMatched fields patch conn
/// Remove fields from a document by the document's ID
/// The SqliteConnection on which to run the query
/// The table in which a document should be modified (may include schema)
/// The ID of the document to modify
/// One or more field names to remove from the document
[]
static member inline RemoveFieldsById<'TKey>(conn, tableName, docId: 'TKey, fieldNames) =
RemoveFields.byId tableName docId fieldNames conn
/// Remove fields from documents via a comparison on JSON fields in the document
/// The SqliteConnection on which to run the query
/// The table in which documents should be modified (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
/// One or more field names to remove from the matching documents
[]
static member inline RemoveFieldsByFields(conn, tableName, howMatched, fields, fieldNames) =
RemoveFields.byFields tableName howMatched fields fieldNames conn
/// Delete a document by its ID
/// The SqliteConnection on which to run the query
/// The table in which a document should be deleted (may include schema)
/// The ID of the document to delete
[]
static member inline DeleteById<'TKey>(conn, tableName, docId: 'TKey) =
Delete.byId tableName docId conn
/// Delete documents by matching a JSON field comparison query (->> =, etc.)
/// The SqliteConnection on which to run the query
/// The table in which documents should be deleted (may include schema)
/// Whether to match any or all of the field conditions
/// The field conditions to match
[]
static member inline DeleteByFields(conn, tableName, howMatched, fields) =
Delete.byFields tableName howMatched fields conn