V3 rc2 (#2)

- Implements `Field` type for by-field actions (**BREAKING**)
- Adds `RemoveFields*` functions/methods for removing fields from documents

Author: danieljsummers

src/Common/BitBadger.Documents.Common.fsproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <PackageReleaseNotes>Initial release (RC 1)</PackageReleaseNotes>
+    <PackageReleaseNotes>Added Field type for by-field operations</PackageReleaseNotes>
     <PackageTags>JSON Document SQL</PackageTags>
   </PropertyGroup>
 

src/Common/Library.fs

@@ -32,6 +32,51 @@ type Op =
         | NEX -> "IS NULL"
 
 
+/// Criteria for a field WHERE clause
+type Field = {
+    /// The name of the field
+    Name: string
+    
+    /// The operation by which the field will be compared
+    Op: Op
+    
+    /// The value of the field
+    Value: obj
+} with
+    
+    /// Create an equals (=) field criterion
+    static member EQ name (value: obj) =
+        { Name = name; Op = EQ; Value = value }
+    
+    /// Create a greater than (>) field criterion
+    static member GT name (value: obj) =
+        { Name = name; Op = GT; Value = value }
+    
+    /// Create a greater than or equal to (>=) field criterion
+    static member GE name (value: obj) =
+        { Name = name; Op = GE; Value = value }
+    
+    /// Create a less than (<) field criterion
+    static member LT name (value: obj) =
+        { Name = name; Op = LT; Value = value }
+    
+    /// Create a less than or equal to (<=) field criterion
+    static member LE name (value: obj) =
+        { Name = name; Op = LE; Value = value }
+    
+    /// Create a not equals (<>) field criterion
+    static member NE name (value: obj) =
+        { Name = name; Op = NE; Value = value }
+    
+    /// Create an exists (IS NOT NULL) field criterion
+    static member EX name =
+        { Name = name; Op = EX; Value = obj () }
+    
+    /// Create an not exists (IS NULL) field criterion
+    static member NEX name =
+        { Name = name; Op = NEX; Value = obj () }
+
+
 /// The required document serialization implementation
 type IDocumentSerializer =
 
@@ -107,17 +152,14 @@ module Query =
 
     /// Create a WHERE clause fragment to implement a comparison on a field in a JSON document
     [<CompiledName "WhereByField">]
-    let whereByField fieldName op paramName =
-        let theRest =
-            match op with
-            | EX | NEX -> string op
-            | _ -> $"{op} %s{paramName}"
-        $"data ->> '%s{fieldName}' {theRest}"
+    let whereByField field paramName =
+        let theRest = match field.Op with EX | NEX -> string field.Op | _ -> $"{field.Op} %s{paramName}"
+        $"data ->> '%s{field.Name}' {theRest}"
 
     /// Create a WHERE clause fragment to implement an ID-based query
     [<CompiledName "WhereById">]
     let whereById paramName =
-        whereByField (Configuration.idField ()) EQ paramName
+        whereByField (Field.EQ (Configuration.idField ()) 0) paramName
 
     /// Queries to define tables and indexes
     module Definition =
@@ -178,8 +220,8 @@ module Query =
 
         /// Query to count matching documents using a text comparison on a JSON field
         [<CompiledName "ByField">]
-        let byField tableName fieldName op =
-            $"""SELECT COUNT(*) AS it FROM %s{tableName} WHERE {whereByField fieldName op "@field"}"""
+        let byField tableName field =
+            $"""SELECT COUNT(*) AS it FROM %s{tableName} WHERE {whereByField field "@field"}"""
 
     /// Queries for determining document existence
     module Exists =
@@ -191,8 +233,8 @@ module Query =
 
         /// Query to determine if documents exist using a comparison on a JSON field
         [<CompiledName "ByField">]
-        let byField tableName fieldName op =
-            $"""SELECT EXISTS (SELECT 1 FROM %s{tableName} WHERE {whereByField fieldName op "@field"}) AS it"""
+        let byField tableName field =
+            $"""SELECT EXISTS (SELECT 1 FROM %s{tableName} WHERE {whereByField field "@field"}) AS it"""
 
     /// Queries for retrieving documents
     module Find =
@@ -204,8 +246,8 @@ module Query =
 
         /// Query to retrieve documents using a comparison on a JSON field
         [<CompiledName "ByField">]
-        let byField tableName fieldName op =
-            $"""{selectFromTable tableName} WHERE {whereByField fieldName op "@field"}"""
+        let byField tableName field =
+            $"""{selectFromTable tableName} WHERE {whereByField field "@field"}"""
 
     /// Queries to delete documents
     module Delete =
@@ -217,5 +259,5 @@ module Query =
 
         /// Query to delete documents using a comparison on a JSON field
         [<CompiledName "ByField">]
-        let byField tableName fieldName op =
-            $"""DELETE FROM %s{tableName} WHERE {whereByField fieldName op "@field"}"""
+        let byField tableName field =
+            $"""DELETE FROM %s{tableName} WHERE {whereByField field "@field"}"""

src/Directory.Build.props

@@ -6,7 +6,7 @@
     <AssemblyVersion>3.0.0.0</AssemblyVersion>
     <FileVersion>3.0.0.0</FileVersion>
     <VersionPrefix>3.0.0</VersionPrefix>
-    <VersionSuffix>rc-1</VersionSuffix>
+    <VersionSuffix>rc-2</VersionSuffix>
     <Authors>danieljsummers</Authors>
     <Company>Bit Badger Solutions</Company>
     <PackageReadmeFile>README.md</PackageReadmeFile>

src/Postgres/BitBadger.Documents.Postgres.fsproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <PackageReleaseNotes>Initial release; migrated from BitBadger.Npgsql.Documents, with field and extension additions (RC 1)</PackageReleaseNotes>
+    <PackageReleaseNotes>Adds Field type for by-field operations (BREAKING from rc-1); adds RemoveFields* functions</PackageReleaseNotes>
     <PackageTags>JSON Document PostgreSQL Npgsql</PackageTags>
   </PropertyGroup>
 

src/Postgres/Extensions.fs

@@ -50,8 +50,8 @@ module Extensions =
             WithProps.Count.all tableName (Sql.existingConnection conn)
 
         /// Count matching documents using a JSON field comparison query (->> =)
-        member conn.countByField tableName fieldName op (value: obj) =
-            WithProps.Count.byField tableName fieldName op value (Sql.existingConnection conn)
+        member conn.countByField tableName field =
+            WithProps.Count.byField tableName field (Sql.existingConnection conn)
 
         /// Count matching documents using a JSON containment query (@>)
         member conn.countByContains tableName criteria =
@@ -66,8 +66,8 @@ module Extensions =
             WithProps.Exists.byId tableName docId (Sql.existingConnection conn)
 
         /// Determine if documents exist using a JSON field comparison query (->> =)
-        member conn.existsByField tableName fieldName op (value: obj) =
-            WithProps.Exists.byField tableName fieldName op value (Sql.existingConnection conn)
+        member conn.existsByField tableName field =
+            WithProps.Exists.byField tableName field (Sql.existingConnection conn)
 
         /// Determine if documents exist using a JSON containment query (@>)
         member conn.existsByContains tableName criteria =
@@ -86,8 +86,8 @@ module Extensions =
             WithProps.Find.byId<'TKey, 'TDoc> tableName docId (Sql.existingConnection conn)
 
         /// Retrieve documents matching a JSON field comparison query (->> =)
-        member conn.findByField<'TDoc> tableName fieldName op (value: obj) =
-            WithProps.Find.byField<'TDoc> tableName fieldName op value (Sql.existingConnection conn)
+        member conn.findByField<'TDoc> tableName field =
+            WithProps.Find.byField<'TDoc> tableName field (Sql.existingConnection conn)
 
         /// Retrieve documents matching a JSON containment query (@>)
         member conn.findByContains<'TDoc> tableName (criteria: obj) =
@@ -98,8 +98,8 @@ module Extensions =
             WithProps.Find.byJsonPath<'TDoc> tableName jsonPath (Sql.existingConnection conn)
 
         /// Retrieve the first document matching a JSON field comparison query (->> =); returns None if not found
-        member conn.findFirstByField<'TDoc> tableName fieldName op (value: obj) =
-            WithProps.Find.firstByField<'TDoc> tableName fieldName op value (Sql.existingConnection conn)
+        member conn.findFirstByField<'TDoc> tableName field =
+            WithProps.Find.firstByField<'TDoc> tableName field (Sql.existingConnection conn)
 
         /// Retrieve the first document matching a JSON containment query (@>); returns None if not found
         member conn.findFirstByContains<'TDoc> tableName (criteria: obj) =
@@ -122,8 +122,8 @@ module Extensions =
             WithProps.Patch.byId tableName docId patch (Sql.existingConnection conn)
 
         /// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
-        member conn.patchByField tableName fieldName op (value: obj) (patch: 'TPatch) =
-            WithProps.Patch.byField tableName fieldName op value patch (Sql.existingConnection conn)
+        member conn.patchByField tableName field (patch: 'TPatch) =
+            WithProps.Patch.byField tableName field patch (Sql.existingConnection conn)
 
         /// Patch documents using a JSON containment query in the WHERE clause (@>)
         member conn.patchByContains tableName (criteria: 'TCriteria) (patch: 'TPatch) =
@@ -133,13 +133,29 @@ module Extensions =
         member conn.patchByJsonPath tableName jsonPath (patch: 'TPatch) =
             WithProps.Patch.byJsonPath tableName jsonPath patch (Sql.existingConnection conn)
 
+        /// Remove fields from a document by the document's ID
+        member conn.removeFieldsById tableName (docId: 'TKey) fieldNames =
+            WithProps.RemoveFields.byId tableName docId fieldNames (Sql.existingConnection conn)
+        
+        /// Remove fields from documents via a comparison on a JSON field in the document
+        member conn.removeFieldsByField tableName field fieldNames =
+            WithProps.RemoveFields.byField tableName field fieldNames (Sql.existingConnection conn)
+        
+        /// Remove fields from documents via a JSON containment query (@>)
+        member conn.removeFieldsByContains tableName (criteria: 'TContains) fieldNames =
+            WithProps.RemoveFields.byContains tableName criteria fieldNames (Sql.existingConnection conn)
+        
+        /// Remove fields from documents via a JSON Path match query (@?)
+        member conn.removeFieldsByJsonPath tableName jsonPath fieldNames =
+            WithProps.RemoveFields.byJsonPath tableName jsonPath fieldNames (Sql.existingConnection conn)
+        
         /// Delete a document by its ID
         member conn.deleteById tableName (docId: 'TKey) =
             WithProps.Delete.byId tableName docId (Sql.existingConnection conn)
 
         /// Delete documents by matching a JSON field comparison query (->> =)
-        member conn.deleteByField tableName fieldName op (value: obj) =
-            WithProps.Delete.byField tableName fieldName op value (Sql.existingConnection conn)
+        member conn.deleteByField tableName field =
+            WithProps.Delete.byField tableName field (Sql.existingConnection conn)
 
         /// Delete documents by matching a JSON containment query (@>)
         member conn.deleteByContains tableName (criteria: 'TContains) =
@@ -209,8 +225,8 @@ type NpgsqlConnectionCSharpExtensions =
 
     /// Count matching documents using a JSON field comparison query (->> =)
     [<Extension>]
-    static member inline CountByField(conn, tableName, fieldName, op, value: obj) =
-        WithProps.Count.byField tableName fieldName op value (Sql.existingConnection conn)
+    static member inline CountByField(conn, tableName, field) =
+        WithProps.Count.byField tableName field (Sql.existingConnection conn)
 
     /// Count matching documents using a JSON containment query (@>)
     [<Extension>]
@@ -229,8 +245,8 @@ type NpgsqlConnectionCSharpExtensions =
 
     /// Determine if documents exist using a JSON field comparison query (->> =)
     [<Extension>]
-    static member inline ExistsByField(conn, tableName, fieldName, op, value: obj) =
-        WithProps.Exists.byField tableName fieldName op value (Sql.existingConnection conn)
+    static member inline ExistsByField(conn, tableName, field) =
+        WithProps.Exists.byField tableName field (Sql.existingConnection conn)
 
     /// Determine if documents exist using a JSON containment query (@>)
     [<Extension>]
@@ -254,8 +270,8 @@ type NpgsqlConnectionCSharpExtensions =
 
     /// Retrieve documents matching a JSON field comparison query (->> =)
     [<Extension>]
-    static member inline FindByField<'TDoc>(conn, tableName, fieldName, op, value: obj) =
-        WithProps.Find.ByField<'TDoc>(tableName, fieldName, op, value, Sql.existingConnection conn)
+    static member inline FindByField<'TDoc>(conn, tableName, field) =
+        WithProps.Find.ByField<'TDoc>(tableName, field, Sql.existingConnection conn)
 
     /// Retrieve documents matching a JSON containment query (@>)
     [<Extension>]
@@ -269,8 +285,8 @@ type NpgsqlConnectionCSharpExtensions =
 
     /// Retrieve the first document matching a JSON field comparison query (->> =); returns None if not found
     [<Extension>]
-    static member inline FindFirstByField<'TDoc when 'TDoc: null>(conn, tableName, fieldName, op, value: obj) =
-        WithProps.Find.FirstByField<'TDoc>(tableName, fieldName, op, value, Sql.existingConnection conn)
+    static member inline FindFirstByField<'TDoc when 'TDoc: null>(conn, tableName, field) =
+        WithProps.Find.FirstByField<'TDoc>(tableName, field, Sql.existingConnection conn)
 
     /// Retrieve the first document matching a JSON containment query (@>); returns None if not found
     [<Extension>]
@@ -299,8 +315,8 @@ type NpgsqlConnectionCSharpExtensions =
 
     /// Patch documents using a JSON field comparison query in the WHERE clause (->> =)
     [<Extension>]
-    static member inline PatchByField(conn, tableName, fieldName, op, value: obj, patch: 'TPatch) =
-        WithProps.Patch.byField tableName fieldName op value patch (Sql.existingConnection conn)
+    static member inline PatchByField(conn, tableName, field, patch: 'TPatch) =
+        WithProps.Patch.byField tableName field patch (Sql.existingConnection conn)
 
     /// Patch documents using a JSON containment query in the WHERE clause (@>)
     [<Extension>]
@@ -312,15 +328,35 @@ type NpgsqlConnectionCSharpExtensions =
     static member inline PatchByJsonPath(conn, tableName, jsonPath, patch: 'TPatch) =
         WithProps.Patch.byJsonPath tableName jsonPath patch (Sql.existingConnection conn)
 
+    /// Remove fields from a document by the document's ID
+    [<Extension>]
+    static member inline RemoveFieldsById(conn, tableName, docId: 'TKey, fieldNames) =
+        WithProps.RemoveFields.ById(tableName, docId, fieldNames, Sql.existingConnection conn)
+        
+    /// Remove fields from documents via a comparison on a JSON field in the document
+    [<Extension>]
+    static member inline RemoveFieldsByField(conn, tableName, field, fieldNames) =
+        WithProps.RemoveFields.ByField(tableName, field, fieldNames, Sql.existingConnection conn)
+        
+    /// Remove fields from documents via a JSON containment query (@>)
+    [<Extension>]
+    static member inline RemoveFieldsByContains(conn, tableName, criteria: 'TContains, fieldNames) =
+        WithProps.RemoveFields.ByContains(tableName, criteria, fieldNames, Sql.existingConnection conn)
+        
+    /// Remove fields from documents via a JSON Path match query (@?)
+    [<Extension>]
+    static member inline RemoveFieldsByJsonPath(conn, tableName, jsonPath, fieldNames) =
+        WithProps.RemoveFields.ByJsonPath(tableName, jsonPath, fieldNames, Sql.existingConnection conn)
+    
     /// Delete a document by its ID
     [<Extension>]
     static member inline DeleteById(conn, tableName, docId: 'TKey) =
         WithProps.Delete.byId tableName docId (Sql.existingConnection conn)
 
     /// Delete documents by matching a JSON field comparison query (->> =)
     [<Extension>]
-    static member inline DeleteByField(conn, tableName, fieldName, op, value: obj) =
-        WithProps.Delete.byField tableName fieldName op value (Sql.existingConnection conn)
+    static member inline DeleteByField(conn, tableName, field) =
+        WithProps.Delete.byField tableName field (Sql.existingConnection conn)
 
     /// Delete documents by matching a JSON containment query (@>)
     [<Extension>]