Daniel J. Summers
2c24e2e912
Changes in this version: - **BREAKING CHANGE**: All `*byField`/`*ByField` functions are now `*byFields`/`*ByFields`, and take a `FieldMatch` case before the list of fields. The `Compat` namespace in both libraries will assist in this transition. In support of this change, the `Field` parameter name is optional; the library will generate parameter names for it if they are not specified. - **BREAKING CHANGE**: The `Query` namespaces have had some significant work, particularly from the full-query perspective. Most have been broken up into the base query and modifiers `by*` that will combine the base query with the `WHERE` clause needed to satisfy the criteria. - **FEATURE / BREAKING CHANGE**: PostgreSQL document fields will now be cast to numeric if the parameter value passed to the query is numeric. This drove the `Query` breaking changes, as the fields need to have their intended value for the library to generate the appropriate SQL. Additionally, if code assumes the library can be given something like `8` and transform it to `"8"`, this is no longer the case. - **FEATURE**: All `Find` queries (except `byId`/`ById`) now have a version with the `Ordered` suffix. These take a list of fields by which the query should be ordered. A new `Field` method called `Named` can assist with creating these fields. Prefixing the field name with `n:` will cast the field to numeric in PostgreSQL (and will be ignored by SQLite); adding " DESC" to the field name will sort it descending (Z-A, high to low) instead of ascending (A-Z, low to high). - **BREAKING CHANGE** (PostgreSQL only): `fieldNameParam`/`Parameters.FieldName` are now plural. The function still only generates one parameter, but the name is now the same between PostgreSQL and SQLite. The goal of this library is to abstract the differences away as much as practical, and this furthers that end. There are functions with these names in the `Compat` namespace. - **FEATURE**: In the F# v3 library, lists of parameters were expected to be F#'s `List` type, and the C# version took either `List<T>` or `IEnumerable<T>`. In this version, these all expect `seq`/`IEnumerable<T>`. F#'s `List` satisfies the `seq` constraints, so this should not be a breaking change. - **FEATURE**: `Field`s now may have qualifiers; this allows tables to be aliased when joining multiple tables (as all have the same `data` column). F# users can use `with` to specify this at creation, and both F# and C# can use the `WithQualifier` method to create a field with the qualifier specified. Parameter names for fields may be specified in a similar way, substituting `ParameterName` for `Qualifier`. Reviewed-on: #6
271 lines
12 KiB
Forth
271 lines
12 KiB
Forth
namespace BitBadger.Documents.Postgres.Compat
|
|
|
|
open BitBadger.Documents
|
|
open BitBadger.Documents.Postgres
|
|
|
|
[<AutoOpen>]
|
|
module Parameters =
|
|
|
|
/// Create a JSON field parameter
|
|
[<CompiledName "AddField">]
|
|
[<System.Obsolete "Use addFieldParams (F#) / AddFields (C#) instead ~ will be removed in v4.1">]
|
|
let addFieldParam name field parameters =
|
|
addFieldParams [ { field with ParameterName = Some name } ] parameters
|
|
|
|
/// Append JSON field name parameters for the given field names to the given parameters
|
|
[<CompiledName "FieldName">]
|
|
[<System.Obsolete "Use fieldNameParams (F#) / FieldNames (C#) instead ~ will be removed in v4.1">]
|
|
let fieldNameParam fieldNames =
|
|
fieldNameParams fieldNames
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Query =
|
|
|
|
/// Create a WHERE clause fragment to implement a comparison on a field in a JSON document
|
|
[<CompiledName "WhereByField">]
|
|
[<System.Obsolete "Use WhereByFields instead ~ will be removed in v4.1">]
|
|
let whereByField field paramName =
|
|
Query.whereByFields Any [ { field with ParameterName = Some paramName } ]
|
|
|
|
|
|
module WithProps =
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Count =
|
|
|
|
/// Count matching documents using a JSON field comparison (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field sqlProps =
|
|
WithProps.Count.byFields tableName Any [ field ] sqlProps
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Exists =
|
|
|
|
/// Determine if a document exists using a JSON field comparison (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field sqlProps =
|
|
WithProps.Exists.byFields tableName Any [ field ] sqlProps
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Find =
|
|
|
|
/// Retrieve documents matching a JSON field comparison (->> =)
|
|
[<CompiledName "FSharpByField">]
|
|
[<System.Obsolete "Use byFields instead ~ will be removed in v4.1">]
|
|
let byField<'TDoc> tableName field sqlProps =
|
|
WithProps.Find.byFields<'TDoc> tableName Any [ field ] sqlProps
|
|
|
|
/// Retrieve documents matching a JSON field comparison (->> =)
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let ByField<'TDoc>(tableName, field, sqlProps) =
|
|
WithProps.Find.ByFields<'TDoc>(tableName, Any, Seq.singleton field, sqlProps)
|
|
|
|
/// Retrieve the first document matching a JSON field comparison (->> =); returns None if not found
|
|
[<CompiledName "FSharpFirstByField">]
|
|
[<System.Obsolete "Use firstByFields instead ~ will be removed in v4.1">]
|
|
let firstByField<'TDoc> tableName field sqlProps =
|
|
WithProps.Find.firstByFields<'TDoc> tableName Any [ field ] sqlProps
|
|
|
|
/// Retrieve the first document matching a JSON field comparison (->> =); returns null if not found
|
|
[<System.Obsolete "Use FirstByFields instead ~ will be removed in v4.1">]
|
|
let FirstByField<'TDoc when 'TDoc: null>(tableName, field, sqlProps) =
|
|
WithProps.Find.FirstByFields<'TDoc>(tableName, Any, Seq.singleton field, sqlProps)
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Patch =
|
|
|
|
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field (patch: 'TPatch) sqlProps =
|
|
WithProps.Patch.byFields tableName Any [ field ] patch sqlProps
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module RemoveFields =
|
|
|
|
/// Remove fields from documents via a comparison on a JSON field in the document
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field fieldNames sqlProps =
|
|
WithProps.RemoveFields.byFields tableName Any [ field ] fieldNames sqlProps
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Delete =
|
|
|
|
/// Delete documents by matching a JSON field comparison query (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field sqlProps =
|
|
WithProps.Delete.byFields tableName Any [ field ] sqlProps
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Count =
|
|
|
|
/// Count matching documents using a JSON field comparison (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field =
|
|
Count.byFields tableName Any [ field ]
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Exists =
|
|
|
|
/// Determine if a document exists using a JSON field comparison (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field =
|
|
Exists.byFields tableName Any [ field ]
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Find =
|
|
|
|
/// Retrieve documents matching a JSON field comparison (->> =)
|
|
[<CompiledName "FSharpByField">]
|
|
[<System.Obsolete "Use byFields instead ~ will be removed in v4.1">]
|
|
let byField<'TDoc> tableName field =
|
|
Find.byFields<'TDoc> tableName Any [ field ]
|
|
|
|
/// Retrieve documents matching a JSON field comparison (->> =)
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let ByField<'TDoc>(tableName, field) =
|
|
Find.ByFields<'TDoc>(tableName, Any, Seq.singleton field)
|
|
|
|
/// Retrieve the first document matching a JSON field comparison (->> =); returns None if not found
|
|
[<CompiledName "FSharpFirstByField">]
|
|
[<System.Obsolete "Use firstByFields instead ~ will be removed in v4.1">]
|
|
let firstByField<'TDoc> tableName field =
|
|
Find.firstByFields<'TDoc> tableName Any [ field ]
|
|
|
|
/// Retrieve the first document matching a JSON field comparison (->> =); returns null if not found
|
|
[<System.Obsolete "Use FirstByFields instead ~ will be removed in v4.1">]
|
|
let FirstByField<'TDoc when 'TDoc: null>(tableName, field) =
|
|
Find.FirstByFields<'TDoc>(tableName, Any, Seq.singleton field)
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Patch =
|
|
|
|
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field (patch: 'TPatch) =
|
|
Patch.byFields tableName Any [ field ] patch
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module RemoveFields =
|
|
|
|
/// Remove fields from documents via a comparison on a JSON field in the document
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field fieldNames =
|
|
RemoveFields.byFields tableName Any [ field ] fieldNames
|
|
|
|
|
|
[<RequireQualifiedAccess>]
|
|
module Delete =
|
|
|
|
/// Delete documents by matching a JSON field comparison query (->> =)
|
|
[<CompiledName "ByField">]
|
|
[<System.Obsolete "Use ByFields instead ~ will be removed in v4.1">]
|
|
let byField tableName field =
|
|
Delete.byFields tableName Any [ field ]
|
|
|
|
|
|
open Npgsql
|
|
|
|
/// F# Extensions for the NpgsqlConnection type
|
|
[<AutoOpen>]
|
|
module Extensions =
|
|
|
|
type NpgsqlConnection with
|
|
|
|
/// Count matching documents using a JSON field comparison query (->> =)
|
|
[<System.Obsolete "Use countByFields instead ~ will be removed in v4.1">]
|
|
member conn.countByField tableName field =
|
|
conn.countByFields tableName Any [ field ]
|
|
|
|
/// Determine if documents exist using a JSON field comparison query (->> =)
|
|
[<System.Obsolete "Use existsByFields instead ~ will be removed in v4.1">]
|
|
member conn.existsByField tableName field =
|
|
conn.existsByFields tableName Any [ field ]
|
|
|
|
/// Retrieve documents matching a JSON field comparison query (->> =)
|
|
[<System.Obsolete "Use findByFields instead ~ will be removed in v4.1">]
|
|
member conn.findByField<'TDoc> tableName field =
|
|
conn.findByFields<'TDoc> tableName Any [ field ]
|
|
|
|
/// Retrieve the first document matching a JSON field comparison query (->> =); returns None if not found
|
|
[<System.Obsolete "Use findFirstByFields instead ~ will be removed in v4.1">]
|
|
member conn.findFirstByField<'TDoc> tableName field =
|
|
conn.findFirstByFields<'TDoc> tableName Any [ field ]
|
|
|
|
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
|
|
[<System.Obsolete "Use patchByFields instead ~ will be removed in v4.1">]
|
|
member conn.patchByField tableName field (patch: 'TPatch) =
|
|
conn.patchByFields tableName Any [ field ] patch
|
|
|
|
/// Remove fields from documents via a comparison on a JSON field in the document
|
|
[<System.Obsolete "Use removeFieldsByFields instead ~ will be removed in v4.1">]
|
|
member conn.removeFieldsByField tableName field fieldNames =
|
|
conn.removeFieldsByFields tableName Any [ field ] fieldNames
|
|
|
|
/// Delete documents by matching a JSON field comparison query (->> =)
|
|
[<System.Obsolete "Use deleteByFields instead ~ will be removed in v4.1">]
|
|
member conn.deleteByField tableName field =
|
|
conn.deleteByFields tableName Any [ field ]
|
|
|
|
|
|
open System.Runtime.CompilerServices
|
|
open Npgsql.FSharp
|
|
|
|
type NpgsqlConnectionCSharpCompatExtensions =
|
|
|
|
/// Count matching documents using a JSON field comparison query (->> =)
|
|
[<Extension>]
|
|
[<System.Obsolete "Use CountByFields instead ~ will be removed in v4.1">]
|
|
static member inline CountByField(conn, tableName, field) =
|
|
WithProps.Count.byFields tableName Any [ field ] (Sql.existingConnection conn)
|
|
|
|
/// Determine if documents exist using a JSON field comparison query (->> =)
|
|
[<Extension>]
|
|
[<System.Obsolete "Use ExistsByFields instead ~ will be removed in v4.1">]
|
|
static member inline ExistsByField(conn, tableName, field) =
|
|
WithProps.Exists.byFields tableName Any [ field ] (Sql.existingConnection conn)
|
|
|
|
/// Retrieve documents matching a JSON field comparison query (->> =)
|
|
[<Extension>]
|
|
[<System.Obsolete "Use FindByFields instead ~ will be removed in v4.1">]
|
|
static member inline FindByField<'TDoc>(conn, tableName, field) =
|
|
WithProps.Find.ByFields<'TDoc>(tableName, Any, [ field ], Sql.existingConnection conn)
|
|
|
|
/// Retrieve the first document matching a JSON field comparison query (->> =); returns null if not found
|
|
[<Extension>]
|
|
[<System.Obsolete "Use FindFirstByFields instead ~ will be removed in v4.1">]
|
|
static member inline FindFirstByField<'TDoc when 'TDoc: null>(conn, tableName, field) =
|
|
WithProps.Find.FirstByFields<'TDoc>(tableName, Any, [ field ], Sql.existingConnection conn)
|
|
|
|
/// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
|
|
[<Extension>]
|
|
[<System.Obsolete "Use PatchByFields instead ~ will be removed in v4.1">]
|
|
static member inline PatchByField(conn, tableName, field, patch: 'TPatch) =
|
|
WithProps.Patch.byFields tableName Any [ field ] patch (Sql.existingConnection conn)
|
|
|
|
/// Remove fields from documents via a comparison on a JSON field in the document
|
|
[<Extension>]
|
|
[<System.Obsolete "Use RemoveFieldsByFields instead ~ will be removed in v4.1">]
|
|
static member inline RemoveFieldsByField(conn, tableName, field, fieldNames) =
|
|
WithProps.RemoveFields.byFields tableName Any [ field ] fieldNames (Sql.existingConnection conn)
|
|
|
|
/// Delete documents by matching a JSON field comparison query (->> =)
|
|
[<Extension>]
|
|
[<System.Obsolete "Use DeleteByFields instead ~ will be removed in v4.1">]
|
|
static member inline DeleteByField(conn, tableName, field) =
|
|
WithProps.Delete.byFields tableName Any [ field ] (Sql.existingConnection conn)
|