Add PostgreSQL Support (#3)

Reviewed-on: #3

.gitignore

@@ -1,2 +1,3 @@
 .idea
 vendor
+*-tests.txt

README.md

@@ -1,10 +1,10 @@
 # PDODocument
 
-This library allows SQLite (and, by v1.0.0-beta1, PostgreSQL) to be treated as a document database. It is a PHP implementation of the .NET [BitBadger.Documents](https://git.bitbadger.solutions/bit-badger/BitBadger.Documents) library.
+This library allows SQLite and PostgreSQL to be treated as document databases. It is a PHP implementation of the .NET [BitBadger.Documents](https://git.bitbadger.solutions/bit-badger/BitBadger.Documents) library.
 
 ## Add via Composer
 
-![Packagist Version](https://img.shields.io/packagist/v/bit-badger/pdo-document)
+[![Packagist Version](https://img.shields.io/packagist/v/bit-badger/pdo-document)](https://packagist.org/packages/bit-badger/pdo-document)
 
 `composer require bit-badger/pdo-document`
 
@@ -29,4 +29,4 @@ In all generated scenarios, if the ID value is not 0 or blank, that ID will be u
 
 ## Usage
 
-Documentation for this library is not complete; however, its structure is very similar to the .NET version, so [its documentation will help](https://bitbadger.solutions/open-source/relational-documents/basic-usage.html) until its project specific documentation is developed. Things like `Count.All()` become `Count::all`, and all the `byField` operations are named `byFields` and take an array of fields.
+Documentation for this library is not complete (writing it is one of the goals before the “beta” tag is dropped); however, its structure is very similar to the .NET version, so [its documentation will help](https://bitbadger.solutions/open-source/relational-documents/basic-usage.html) until its project specific documentation is developed. Things like `Count.All()` become `Count::all`, and all the `byField` operations are named `byFields` and take an array of fields.

composer.json

@@ -35,6 +35,7 @@
     "psr-4": {
       "Test\\Unit\\": "./tests/unit",
       "Test\\Integration\\": "./tests/integration",
+      "Test\\Integration\\PostgreSQL\\": "./tests/integration/postgresql",
       "Test\\Integration\\SQLite\\": "./tests/integration/sqlite"
     }
   },

composer.lock

@@ -619,16 +619,16 @@
         },
         {
             "name": "phpunit/phpunit",
-            "version": "11.2.0",
+            "version": "11.2.1",
             "source": {
                 "type": "git",
                 "url": "https://github.com/sebastianbergmann/phpunit.git",
-                "reference": "705eba0190afe04bc057f565ad843267717cf109"
+                "reference": "1b8775732e9c401bda32df3ffbdf90dec7533ceb"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/705eba0190afe04bc057f565ad843267717cf109",
+                "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/1b8775732e9c401bda32df3ffbdf90dec7533ceb",
-                "reference": "705eba0190afe04bc057f565ad843267717cf109",
+                "reference": "1b8775732e9c401bda32df3ffbdf90dec7533ceb",
                 "shasum": ""
             },
             "require": {
@@ -699,7 +699,7 @@
             "support": {
                 "issues": "https://github.com/sebastianbergmann/phpunit/issues",
                 "security": "https://github.com/sebastianbergmann/phpunit/security/policy",
-                "source": "https://github.com/sebastianbergmann/phpunit/tree/11.2.0"
+                "source": "https://github.com/sebastianbergmann/phpunit/tree/11.2.1"
             },
             "funding": [
                 {
@@ -715,7 +715,7 @@
                     "type": "tidelift"
                 }
             ],
-            "time": "2024-06-07T04:48:50+00:00"
+            "time": "2024-06-11T07:30:35+00:00"
         },
         {
             "name": "sebastian/cli-parser",

src/AutoId.php

@@ -41,11 +41,12 @@ enum AutoId
     /**
      * Generate a random string ID
      *
+     * @param int|null $length The length of string to generate (optional; defaults to configured ID string length)
      * @return string A string filled with the hexadecimal representation of random bytes
      * @throws RandomException If an appropriate source of randomness cannot be found
      */
-    public static function generateRandom(): string
+    public static function generateRandom(?int $length = null): string
     {
-        return bin2hex(random_bytes(Configuration::$idStringLength / 2));
+        return bin2hex(random_bytes(($length ?? Configuration::$idStringLength) / 2));
     }
 }

src/Count.php

@@ -36,4 +36,31 @@ class Count
         return Custom::scalar(Query\Count::byFields($tableName, $namedFields, $match),
             Parameters::addFields($namedFields, []), new CountMapper());
     }
+
+    /**
+     * Count matching documents using a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be counted
+     * @param array|object $criteria The criteria for the JSON containment query
+     * @return int The number of documents matching the JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria): int
+    {
+        return Custom::scalar(Query\Count::byContains($tableName), Parameters::json(':criteria', $criteria),
+            new CountMapper());
+    }
+
+    /**
+     * Count matching documents using a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be counted
+     * @param string $path The JSON Path match string
+     * @return int The number of documents matching the given JSON Path criteria
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path): int
+    {
+        return Custom::scalar(Query\Count::byJsonPath($tableName), [':path' => $path], new CountMapper());
+    }
 }

src/Definition.php

@@ -31,4 +31,16 @@ class Definition
     {
         Custom::nonQuery(Query\Definition::ensureIndexOn($tableName, $indexName, $fields), []);
     }
+
+    /**
+     * Create a full-document index on a table (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table on which the document index should be created
+     * @param DocumentIndex $indexType The type of document index to create
+     * @throws DocumentException If the database mode is not PostgreSQL or if an error occurs creating the index
+     */
+    public static function ensureDocumentIndex(string $tableName, DocumentIndex $indexType): void
+    {
+        Custom::nonQuery(Query\Definition::ensureDocumentIndexOn($tableName, $indexType), []);
+    }
 }

src/Delete.php

@@ -16,7 +16,7 @@ class Delete
      */
     public static function byId(string $tableName, mixed $docId): void
     {
-        Custom::nonQuery(Query\Delete::byId($tableName), Parameters::id($docId));
+        Custom::nonQuery(Query\Delete::byId($tableName, $docId), Parameters::id($docId));
     }
 
     /**
@@ -33,4 +33,28 @@ class Delete
         Custom::nonQuery(Query\Delete::byFields($tableName, $namedFields, $match),
             Parameters::addFields($namedFields, []));
     }
+
+    /**
+     * Delete documents matching a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @param string $tableName The table from which documents should be deleted
+     * @param array|object $criteria The JSON containment query values
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria): void
+    {
+        Custom::nonQuery(Query\Delete::byContains($tableName), Parameters::json(':criteria', $criteria));
+    }
+
+    /**
+     * Delete documents matching a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @param string $tableName The table from which documents should be deleted
+     * @param string $path The JSON Path match string
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path): void
+    {
+        Custom::nonQuery(Query\Delete::byJsonPath($tableName), [':path' => $path]);
+    }
 }

src/DocumentIndex.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace BitBadger\PDODocument;
+
+/**
+ * The type of index to generate for the document
+ */
+enum DocumentIndex
+{
+    /** A GIN index with standard operations (all operators supported) */
+    case Full;
+
+    /** A GIN index with JSONPath operations (optimized for @>, @?, @@ operators) */
+    case Optimized;
+}

src/Exists.php

@@ -19,7 +19,7 @@ class Exists
      */
     public static function byId(string $tableName, mixed $docId): bool
     {
-        return Custom::scalar(Query\Exists::byId($tableName), Parameters::id($docId), new ExistsMapper());
+        return Custom::scalar(Query\Exists::byId($tableName, $docId), Parameters::id($docId), new ExistsMapper());
     }
 
     /**
@@ -37,4 +37,31 @@ class Exists
         return Custom::scalar(Query\Exists::byFields($tableName, $namedFields, $match),
             Parameters::addFields($namedFields, []), new ExistsMapper());
     }
+
+    /**
+     * Determine if documents exist by a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which document existence should be determined
+     * @param array|object $criteria The criteria for the JSON containment query
+     * @return bool True if any documents match the JSON containment query, false if not
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria): bool
+    {
+        return Custom::scalar(Query\Exists::byContains($tableName), Parameters::json(':criteria', $criteria),
+            new ExistsMapper());
+    }
+
+    /**
+     * Determine if documents exist by a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which document existence should be determined
+     * @param string $path The JSON Path match string
+     * @return bool True if any documents match the JSON Path string, false if not
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path): bool
+    {
+        return Custom::scalar(Query\Exists::byJsonPath($tableName), [':path' => $path], new ExistsMapper());
+    }
 }

src/Field.php

@@ -52,23 +52,25 @@ class Field
      */
     public function toWhere(): string
     {
+        $fieldName = ($this->qualifier == '' ? '' : "$this->qualifier.") . 'data' . match (true) {
+            !str_contains($this->fieldName, '.') => "->>'$this->fieldName'",
+            Configuration::$mode == Mode::PgSQL  => "#>>'{" . implode(',', explode('.', $this->fieldName)) . "}'",
+            Configuration::$mode == Mode::SQLite => "->>'" . implode("'->>'", explode('.', $this->fieldName)) . "'",
+            default => throw new DocumentException('Database mode not set; cannot make field WHERE clause')
+        };
+        $fieldPath = match (Configuration::$mode) {
+            Mode::PgSQL => match (true) {
+                $this->op == Op::BT      => is_numeric($this->value[0]) ? "($fieldName)::numeric" : $fieldName,
+                is_numeric($this->value) => "($fieldName)::numeric",
+                default                  => $fieldName
+            },
+            default => $fieldName
+        };
         $criteria = match ($this->op) {
             Op::EX, Op::NEX => '',
             Op::BT          => " {$this->paramName}min AND {$this->paramName}max",
             default         => " $this->paramName"
         };
-        $prefix = $this->qualifier == '' ? '' : "$this->qualifier.";
-        $fieldPath = match (Configuration::$mode) {
-            Mode::SQLite => "{$prefix}data->>'"
-                . (str_contains($this->fieldName, '.')
-                    ? implode("'->>'", explode('.', $this->fieldName))
-                    : $this->fieldName)
-                . "'",
-            Mode::PgSQL => $this->op == Op::BT && is_numeric($this->value[0])
-                ? "({$prefix}data->>'$this->fieldName')::numeric"
-                : "{$prefix}data->>'$this->fieldName'",
-            default => throw new DocumentException('Database mode not set; cannot make field WHERE clause')
-        };
         return $fieldPath . ' ' . $this->op->toString() . $criteria;
     }
 

src/Find.php

@@ -35,7 +35,8 @@ class Find
      */
     public static function byId(string $tableName, mixed $docId, string $className): mixed
     {
-        return Custom::single(Query\Find::byId($tableName), Parameters::id($docId), new DocumentMapper($className));
+        return Custom::single(Query\Find::byId($tableName, $docId), Parameters::id($docId),
+            new DocumentMapper($className));
     }
 
     /**
@@ -57,6 +58,37 @@ class Find
             Parameters::addFields($namedFields, []), new DocumentMapper($className));
     }
 
+    /**
+     * Retrieve documents via a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @template TDoc The type of document to be retrieved
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @param array|object $criteria The criteria for the JSON containment query
+     * @param class-string<TDoc> $className The name of the class to be retrieved
+     * @return DocumentList<TDoc> A list of documents matching the JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria, string $className): DocumentList
+    {
+        return Custom::list(Query\Find::byContains($tableName), Parameters::json(':criteria', $criteria),
+            new DocumentMapper($className));
+    }
+
+    /**
+     * Retrieve documents via a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @template TDoc The type of document to be retrieved
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @param string $path The JSON Path match string
+     * @param class-string<TDoc> $className The name of the class to be retrieved
+     * @return DocumentList<TDoc> A list of documents matching the JSON Path
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path, string $className): DocumentList
+    {
+        return Custom::list(Query\Find::byJsonPath($tableName), [':path' => $path], new DocumentMapper($className));
+    }
+
     /**
      * Retrieve documents via a comparison on JSON fields, returning only the first result
      *
@@ -75,4 +107,35 @@ class Find
         return Custom::single(Query\Find::byFields($tableName, $namedFields, $match),
             Parameters::addFields($namedFields, []), new DocumentMapper($className));
     }
+
+    /**
+     * Retrieve documents via a JSON containment query (`@>`), returning only the first result (PostgreSQL only)
+     *
+     * @template TDoc The type of document to be retrieved
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @param array|object $criteria The criteria for the JSON containment query
+     * @param class-string<TDoc> $className The name of the class to be retrieved
+     * @return false|TDoc The first document matching the JSON containment query if any is found, false otherwise
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function firstByContains(string $tableName, array|object $criteria, string $className): mixed
+    {
+        return Custom::single(Query\Find::byContains($tableName), Parameters::json(':criteria', $criteria),
+            new DocumentMapper($className));
+    }
+
+    /**
+     * Retrieve documents via a JSON Path match query (`@?`), returning only the first result (PostgreSQL only)
+     *
+     * @template TDoc The type of document to be retrieved
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @param string $path The JSON Path match string
+     * @param class-string<TDoc> $className The name of the class to be retrieved
+     * @return false|TDoc The first document matching the JSON Path if any is found, false otherwise
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function firstByJsonPath(string $tableName, string $path, string $className): mixed
+    {
+        return Custom::single(Query\Find::byJsonPath($tableName), [':path' => $path], new DocumentMapper($className));
+    }
 }

src/Parameters.php

@@ -68,7 +68,7 @@ class Parameters
     {
         switch (Configuration::$mode) {
             case Mode::PgSQL:
-                return [$paramName => "ARRAY['" . implode("','", $fieldNames) . "']"];
+                return [$paramName => "{" . implode(",", $fieldNames) . "}"];
             case Mode::SQLite:
                 $it = [];
                 $idx = 0;

src/Patch.php

@@ -17,7 +17,7 @@ class Patch
      */
     public static function byId(string $tableName, mixed $docId, array|object $patch): void
     {
-        Custom::nonQuery(Query\Patch::byId($tableName),
+        Custom::nonQuery(Query\Patch::byId($tableName, $docId),
             array_merge(Parameters::id($docId), Parameters::json(':data', $patch)));
     }
 
@@ -37,4 +37,32 @@ class Patch
         Custom::nonQuery(Query\Patch::byFields($tableName, $namedFields, $match),
             Parameters::addFields($namedFields, Parameters::json(':data', $patch)));
     }
+
+    /**
+     * Patch documents using a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @param string $tableName The table in which documents should be patched
+     * @param array|object $criteria The JSON containment query values to match
+     * @param array|object $patch The object with which the documents should be patched (will be JSON-encoded)
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria, array|object $patch): void
+    {
+        Custom::nonQuery(Query\Patch::byContains($tableName),
+            array_merge(Parameters::json(':criteria', $criteria), Parameters::json(':data', $patch)));
+    }
+
+    /**
+     * Patch documents using a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @param string $tableName The table in which documents should be patched
+     * @param string $path The JSON Path match string
+     * @param array|object $patch The object with which the documents should be patched (will be JSON-encoded)
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path, array|object $patch): void
+    {
+        Custom::nonQuery(Query\Patch::byJsonPath($tableName),
+            array_merge([':path' => $path], Parameters::json(':data', $patch)));
+    }
 }

src/Query.php

@@ -38,12 +38,44 @@ class Query
      * Create a WHERE clause fragment to implement an ID-based query
      *
      * @param string $paramName The parameter name where the value of the ID will be provided (optional; default @id)
+     * @param mixed $docId The ID of the document to be retrieved; used to determine type for potential JSON field
+     *     casts (optional; string ID assumed if no value is provided)
      * @return string The WHERE clause fragment to match by ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function whereById(string $paramName = ':id'): string
+    public static function whereById(string $paramName = ':id', mixed $docId = null): string
     {
-        return self::whereByFields([Field::EQ(Configuration::$idField, 0, $paramName)]);
+        return self::whereByFields([Field::EQ(Configuration::$idField, $docId ?? '', $paramName)]);
+    }
+
+    /**
+     * Create a WHERE clause fragment to implement a JSON containment query (PostgreSQL only)
+     *
+     * @param string $paramName The name of the parameter (optional; defaults to `:criteria`)
+     * @return string The WHERE clause fragment for a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function whereDataContains(string $paramName = ':criteria'): string
+    {
+        if (Configuration::$mode <> Mode::PgSQL) {
+            throw new DocumentException('JSON containment is only supported on PostgreSQL');
+        }
+        return "data @> $paramName";
+    }
+
+    /**
+     * Create a WHERE clause fragment to implement a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $paramName The name of the parameter (optional; defaults to `:path`)
+     * @return string The WHERE clause fragment for a JSON Path match query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function whereJsonPathMatches(string $paramName = ':path'): string
+    {
+        if (Configuration::$mode <> Mode::PgSQL) {
+            throw new DocumentException('JSON Path matching is only supported on PostgreSQL');
+        }
+        return "jsonb_path_exists(data, $paramName::jsonpath)";
     }
 
     /**
@@ -68,10 +100,11 @@ class Query
                 },
                 Mode::PgSQL => match ($autoId ?? AutoId::None) {
                     AutoId::None         => ':data',
-                    AutoId::Number       => ":data || ('{\"$id\":' || "
+                    AutoId::Number       => ":data::jsonb || ('{\"$id\":' || "
-                                                . "(SELECT COALESCE(MAX(data->>'$id'), 0) + 1 FROM $tableName) || '}')",
+                                                . "(SELECT COALESCE(MAX((data->>'$id')::numeric), 0) + 1 "
-                    AutoId::UUID         => ":data || '{\"$id\":\"" . AutoId::generateUUID() . "\"}'",
+                                                    . "FROM $tableName) || '}')::jsonb",
-                    AutoId::RandomString => ":data || '{\"$id\":\"" . AutoId::generateRandom() . "\"}'",
+                    AutoId::UUID         => ":data::jsonb || '{\"$id\":\"" . AutoId::generateUUID() . "\"}'",
+                    AutoId::RandomString => ":data::jsonb || '{\"$id\":\"" . AutoId::generateRandom() . "\"}'",
                 },
                 default =>
                     throw new DocumentException('Database mode not set; cannot generate auto-ID INSERT statement'),

src/Query/Count.php

@@ -33,4 +33,28 @@ class Count
     {
         return self::all($tableName) . ' WHERE ' . Query::whereByFields($fields, $match);
     }
+
+    /**
+     * Query to count matching documents using a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be counted
+     * @return string The query to count documents using a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName): string
+    {
+        return self::all($tableName) . ' WHERE ' . Query::whereDataContains();
+    }
+
+    /**
+     * Query to count matching documents using a JSON Path match (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be counted
+     * @return string The query to count documents using a JSON Path match
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byJsonPath(string $tableName): string
+    {
+        return self::all($tableName) . ' WHERE ' . Query::whereJsonPathMatches();
+    }
 }

src/Query/Definition.php

@@ -2,7 +2,7 @@
 
 namespace BitBadger\PDODocument\Query;
 
-use BitBadger\PDODocument\{Configuration, DocumentException, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, DocumentIndex, Mode};
 
 /**
  * Queries to define tables and indexes
@@ -68,4 +68,25 @@ class Definition
     {
         return str_replace('INDEX', 'UNIQUE INDEX', self::ensureIndexOn($tableName, 'key', [Configuration::$idField]));
     }
+
+    /**
+     * Create a document-wide index on a table (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table on which the document index should be created
+     * @param DocumentIndex $indexType The type of index to be created
+     * @return string The SQL statement to create an index on JSON documents in the specified table
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function ensureDocumentIndexOn(string $tableName, DocumentIndex $indexType): string
+    {
+        if (Configuration::$mode <> Mode::PgSQL) {
+            throw new DocumentException('Document indexes are only supported on PostgreSQL');
+        }
+        [, $tbl]  = self::splitSchemaAndTable($tableName);
+        $extraOps = match ($indexType) {
+            DocumentIndex::Full => '',
+            DocumentIndex::Optimized => ' jsonb_path_ops'
+        };
+        return "CREATE INDEX IF NOT EXISTS idx_{$tbl}_document ON $tableName USING GIN (data$extraOps)";
+    }
 }

src/Query/Delete.php

@@ -13,12 +13,13 @@ class Delete
      * Query to delete a document by its ID
      *
      * @param string $tableName The name of the table from which a document should be deleted
+     * @param mixed $docId The ID of the document to be deleted (optional; string ID assumed)
      * @return string The DELETE statement to delete a document by its ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function byId(string $tableName): string
+    public static function byId(string $tableName, mixed $docId = null): string
     {
-        return "DELETE FROM $tableName WHERE " . Query::whereById();
+        return "DELETE FROM $tableName WHERE " . Query::whereById(docId: $docId);
     }
 
     /**
@@ -34,4 +35,28 @@ class Delete
     {
         return "DELETE FROM $tableName WHERE " . Query::whereByFields($fields, $match);
     }
+
+    /**
+     * Query to delete documents using a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table from which documents should be deleted
+     * @return string The DELETE statement to delete documents via a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName): string
+    {
+        return "DELETE FROM $tableName WHERE " . Query::whereDataContains();
+    }
+
+    /**
+     * Query to delete documents using a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table from which documents should be deleted
+     * @return string The DELETE statement to delete documents via a JSON Path match
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byJsonPath(string $tableName): string
+    {
+        return "DELETE FROM $tableName WHERE " . Query::whereJsonPathMatches();
+    }
 }

src/Query/Exists.php

@@ -25,12 +25,13 @@ class Exists
      * Query to determine if a document exists for the given ID
      *
      * @param string $tableName The name of the table in which document existence should be checked
+     * @param mixed $docId The ID of the document whose existence should be checked (optional; string ID assumed)
      * @return string The query to determine document existence by ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function byId(string $tableName): string
+    public static function byId(string $tableName, mixed $docId = null): string
     {
-        return self::query($tableName, Query::whereById());
+        return self::query($tableName, Query::whereById(docId: $docId));
     }
 
     /**
@@ -46,4 +47,28 @@ class Exists
     {
         return self::query($tableName, Query::whereByFields($fields, $match));
     }
+
+    /**
+     * Query to determine if documents exist using a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which document existence should be checked
+     * @return string The query to determine document existence by a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName): string
+    {
+        return self::query($tableName, Query::whereDataContains());
+    }
+
+    /**
+     * Query to determine if documents exist using a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which document existence should be checked
+     * @return string The query to determine document existence by a JSON Path match
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byJsonPath(string $tableName): string
+    {
+        return self::query($tableName, Query::whereJsonPathMatches());
+    }
 }

src/Query/Find.php

@@ -13,12 +13,13 @@ class Find
      * Query to retrieve a document by its ID
      *
      * @param string $tableName The name of the table from which a document should be retrieved
+     * @param mixed $docId The ID of the document to be retrieved (optional; string ID assumed)
      * @return string The SELECT statement to retrieve a document by its ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function byId(string $tableName): string
+    public static function byId(string $tableName, mixed $docId = null): string
     {
-        return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereById();
+        return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereById(docId: $docId);
     }
 
     /**
@@ -34,4 +35,28 @@ class Find
     {
         return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereByFields($fields, $match);
     }
+
+    /**
+     * Query to retrieve documents using a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @return string The SELECT statement to retrieve documents by a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName): string
+    {
+        return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereDataContains();
+    }
+
+    /**
+     * Query to retrieve documents using a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table from which documents should be retrieved
+     * @return string The SELECT statement to retrieve documents by a JSON Path match
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byJsonPath(string $tableName): string
+    {
+        return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereJsonPathMatches();
+    }
 }

src/Query/Patch.php

@@ -31,12 +31,13 @@ class Patch
      * Query to patch (partially update) a document by its ID
      *
      * @param string $tableName The name of the table in which a document should be patched
+     * @param mixed $docId The ID of the document to be patched (optional; string ID assumed)
      * @return string The query to patch a document by its ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function byId(string $tableName): string
+    public static function byId(string $tableName, mixed $docId = null): string
     {
-        return self::update($tableName, Query::whereById());
+        return self::update($tableName, Query::whereById(docId: $docId));
     }
 
     /**
@@ -52,4 +53,28 @@ class Patch
     {
         return self::update($tableName, Query::whereByFields($field, $match));
     }
+
+    /**
+     * Query to patch (partially update) a document via a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be patched
+     * @return string The query to patch documents via a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName): string
+    {
+        return self::update($tableName, Query::whereDataContains());
+    }
+
+    /**
+     * Query to patch (partially update) a document via a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be patched
+     * @return string The query to patch documents via a JSON Path match
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byJsonPath(string $tableName): string
+    {
+        return self::update($tableName, Query::whereJsonPathMatches());
+    }
 }

src/Query/RemoveFields.php

@@ -26,7 +26,8 @@ class RemoveFields
     {
         switch (Configuration::$mode) {
             case Mode::PgSQL:
-                return "UPDATE $tableName SET data = data - " . array_keys($parameters)[0] . " WHERE $whereClause";
+                return "UPDATE $tableName SET data = data - " . array_keys($parameters)[0]
+                    . "::text[] WHERE $whereClause";
             case Mode::SQLite:
                 $paramNames = implode(', ', array_keys($parameters));
                 return "UPDATE $tableName SET data = json_remove(data, $paramNames) WHERE $whereClause";
@@ -40,12 +41,13 @@ class RemoveFields
      *
      * @param string $tableName The name of the table in which the document should be manipulated
      * @param array $parameters The parameter list for the query
+     * @param mixed $docId The ID of the document from which fields should be removed (optional; string ID assumed)
      * @return string The UPDATE statement to remove fields from a document by its ID
      * @throws DocumentException If the database mode has not been set
      */
-    public static function byId(string $tableName, array $parameters): string
+    public static function byId(string $tableName, array $parameters, mixed $docId = null): string
     {
-        return self::update($tableName, $parameters, Query::whereById());
+        return self::update($tableName, $parameters, Query::whereById(docId: $docId));
     }
 
     /**
@@ -63,4 +65,30 @@ class RemoveFields
     {
         return self::update($tableName, $parameters, Query::whereByFields($fields, $match));
     }
+
+    /**
+     * Query to remove fields from documents via a JSON containment query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be manipulated
+     * @param array $parameters The parameter list for the query
+     * @return string The UPDATE statement to remove fields from documents via a JSON containment query
+     * @throws DocumentException If the database mode is not PostgreSQL
+     */
+    public static function byContains(string $tableName, array $parameters): string
+    {
+        return self::update($tableName, $parameters, Query::whereDataContains());
+    }
+
+    /**
+     * Query to remove fields from documents via a JSON Path match query (PostgreSQL only)
+     *
+     * @param string $tableName The name of the table in which documents should be manipulated
+     * @param array $parameters The parameter list for the query
+     * @return string The UPDATE statement to remove fields from documents via a JSON Path match
+     * @throws DocumentException
+     */
+    public static function byJsonPath(string $tableName, array $parameters): string
+    {
+        return self::update($tableName, $parameters, Query::whereJsonPathMatches());
+    }
 }

src/RemoveFields.php

@@ -18,7 +18,7 @@ class RemoveFields
     public static function byId(string $tableName, mixed $docId, array $fieldNames): void
     {
         $nameParams = Parameters::fieldNames(':name', $fieldNames);
-        Custom::nonQuery(Query\RemoveFields::byId($tableName, $nameParams),
+        Custom::nonQuery(Query\RemoveFields::byId($tableName, $nameParams, $docId),
             array_merge(Parameters::id($docId), $nameParams));
     }
 
@@ -39,4 +39,34 @@ class RemoveFields
         Custom::nonQuery(Query\RemoveFields::byFields($tableName, $namedFields, $nameParams, $match),
             Parameters::addFields($namedFields, $nameParams));
     }
+
+    /**
+     * Remove fields from documents via a JSON containment query (`@>`; PostgreSQL only)
+     *
+     * @param string $tableName The table in which documents should have fields removed
+     * @param array|object $criteria The JSON containment query values
+     * @param array|string[] $fieldNames The names of the fields to be removed
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byContains(string $tableName, array|object $criteria, array $fieldNames): void
+    {
+        $nameParams = Parameters::fieldNames(':name', $fieldNames);
+        Custom::nonQuery(Query\RemoveFields::byContains($tableName, $nameParams),
+            array_merge(Parameters::json(':criteria', $criteria), $nameParams));
+    }
+
+    /**
+     * Remove fields from documents via a JSON Path match query (`@?`; PostgreSQL only)
+     *
+     * @param string $tableName The table in which documents should have fields removed
+     * @param string $path The JSON Path match string
+     * @param array|string[] $fieldNames The names of the fields to be removed
+     * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
+     */
+    public static function byJsonPath(string $tableName, string $path, array $fieldNames): void
+    {
+        $nameParams = Parameters::fieldNames(':name', $fieldNames);
+        Custom::nonQuery(Query\RemoveFields::byJsonPath($tableName, $nameParams),
+            array_merge([':path' => $path], $nameParams));
+    }
 }

tests/integration/postgresql/CountTest.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Count, Field};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * PostgreSQL integration tests for the Count class
+ */
+#[TestDox('Count (PostgreSQL integration)')]
+class CountTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    public function testAllSucceeds(): void
+    {
+        $count = Count::all(ThrowawayDb::TABLE);
+        $this->assertEquals(5, $count, 'There should have been 5 matching documents');
+    }
+
+    public function testByFieldsSucceedsForANumericRange(): void
+    {
+        $count = Count::byFields(ThrowawayDb::TABLE, [Field::BT('num_value', 10, 20)]);
+        $this->assertEquals(3, $count, 'There should have been 3 matching documents');
+    }
+
+    public function testByFieldsSucceedsForANonNumericRange(): void
+    {
+        $count = Count::byFields(ThrowawayDb::TABLE, [Field::BT('value', 'aardvark', 'apple')]);
+        $this->assertEquals(1, $count, 'There should have been 1 matching document');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsMatch(): void
+    {
+        $this->assertEquals(2, Count::byContains(ThrowawayDb::TABLE, ['value' => 'purple']),
+            'There should have been 2 matching documents');
+    }
+
+    public function testByContainsSucceedsWhenNoDocumentsMatch(): void
+    {
+        $this->assertEquals(0, Count::byContains(ThrowawayDb::TABLE, ['value' => 'magenta']),
+            'There should have been no matching documents');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents match')]
+    public function testByJsonPathSucceedsWhenDocumentsMatch(): void
+    {
+        $this->assertEquals(2, Count::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ < 5)'),
+            'There should have been 2 matching documents');
+    }
+
+    #[TestDox('By JSON Path succeeds when no documents match')]
+    public function testByJsonPathSucceedsWhenNoDocumentsMatch(): void
+    {
+        $this->assertEquals(0, Count::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)'),
+            'There should have been no matching documents');
+    }
+}

tests/integration/postgresql/CustomTest.php

@@ -0,0 +1,121 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Count, Custom, DocumentException, Query};
+use BitBadger\PDODocument\Mapper\{CountMapper, DocumentMapper};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\TestDocument;
+
+/**
+ * PostgreSQL integration tests for the Custom class
+ */
+#[TestDox('Custom (PostgreSQL integration)')]
+class CustomTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    public function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+    }
+
+    public function testRunQuerySucceedsWithAValidQuery()
+    {
+        $stmt = &Custom::runQuery('SELECT data FROM ' . ThrowawayDb::TABLE . ' LIMIT 1', []);
+        try {
+            $this->assertNotNull($stmt, 'The statement should not have been null');
+        } finally {
+            $stmt = null;
+        }
+    }
+
+    public function testRunQueryFailsWithAnInvalidQuery()
+    {
+        $this->expectException(DocumentException::class);
+        $stmt = &Custom::runQuery('GRAB stuff FROM over_there UNTIL done', []);
+        try {
+            $this->assertTrue(false, 'This code should not be reached');
+        } finally {
+            $stmt = null;
+        }
+    }
+
+    public function testListSucceedsWhenDataIsFound()
+    {
+        $list = Custom::list(Query::selectFromTable(ThrowawayDb::TABLE), [], new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'The document list should not be null');
+        $count = 0;
+        foreach ($list->items() as $ignored) $count++;
+        $this->assertEquals(5, $count, 'There should have been 5 documents in the list');
+    }
+
+    public function testListSucceedsWhenNoDataIsFound()
+    {
+        $list = Custom::list(
+            Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE (data->>'num_value')::numeric > :value",
+            [':value' => 100], new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'The document list should not be null');
+        $this->assertFalse($list->hasItems(), 'There should have been no documents in the list');
+    }
+
+    public function testArraySucceedsWhenDataIsFound()
+    {
+        $array = Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'sub' IS NOT NULL", [],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($array, 'The document array should not be null');
+        $this->assertCount(2, $array, 'There should have been 2 documents in the array');
+    }
+
+    public function testArraySucceedsWhenNoDataIsFound()
+    {
+        $array = Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'value' = :value",
+            [':value' => 'not there'], new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($array, 'The document array should not be null');
+        $this->assertCount(0, $array, 'There should have been no documents in the array');
+    }
+
+    public function testSingleSucceedsWhenARowIsFound(): void
+    {
+        $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($doc, 'There should have been a document returned');
+        $this->assertEquals('one', $doc->id, 'The incorrect document was returned');
+    }
+
+    public function testSingleSucceedsWhenARowIsNotFound(): void
+    {
+        $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id",
+            [':id' => 'eighty'], new DocumentMapper(TestDocument::class));
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+
+    public function testNonQuerySucceedsWhenOperatingOnData()
+    {
+        Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+        $remaining = Count::all(ThrowawayDb::TABLE);
+        $this->assertEquals(0, $remaining, 'There should be no documents remaining in the table');
+    }
+
+    public function testNonQuerySucceedsWhenNoDataMatchesWhereClause()
+    {
+        Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE . " WHERE (data->>'num_value')::numeric > :value",
+            [':value' => 100]);
+        $remaining = Count::all(ThrowawayDb::TABLE);
+        $this->assertEquals(5, $remaining, 'There should be 5 documents remaining in the table');
+    }
+
+    public function testScalarSucceeds()
+    {
+        $value = Custom::scalar("SELECT 5 AS it", [], new CountMapper());
+        $this->assertEquals(5, $value, 'The scalar value was not returned correctly');
+    }
+}

tests/integration/postgresql/DefinitionTest.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Custom, Definition, DocumentException, DocumentIndex};
+use BitBadger\PDODocument\Mapper\ExistsMapper;
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * PostgreSQL integration tests for the Definition class
+ */
+#[TestDox('Definition (PostgreSQL integration)')]
+class DefinitionTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create(withData: false);
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    /**
+     * Does the given named object exist in the database?
+     *
+     * @param string $name The name of the object whose existence should be verified
+     * @return bool True if the object exists, false if not
+     * @throws DocumentException If any is encountered
+     */
+    private function itExists(string $name): bool
+    {
+        return Custom::scalar('SELECT EXISTS (SELECT 1 FROM pg_class WHERE relname = :name)',
+            [':name' => $name], new ExistsMapper());
+    }
+
+    public function testEnsureTableSucceeds(): void
+    {
+        $this->assertFalse($this->itExists('ensured'), 'The table should not exist already');
+        $this->assertFalse($this->itExists('idx_ensured_key'), 'The key index should not exist already');
+        Definition::ensureTable('ensured');
+        $this->assertTrue($this->itExists('ensured'), 'The table should now exist');
+        $this->assertTrue($this->itExists('idx_ensured_key'), 'The key index should now exist');
+    }
+
+    public function testEnsureFieldIndexSucceeds(): void
+    {
+        $this->assertFalse($this->itExists('idx_ensured_test'), 'The index should not exist already');
+        Definition::ensureTable('ensured');
+        Definition::ensureFieldIndex('ensured', 'test', ['name', 'age']);
+        $this->assertTrue($this->itExists('idx_ensured_test'), 'The index should now exist');
+    }
+
+    public function testEnsureDocumentIndexSucceedsForFull(): void
+    {
+        $docIdx = 'idx_' . ThrowawayDb::TABLE . '_document';
+        Definition::ensureTable(ThrowawayDb::TABLE);
+        $this->assertFalse($this->itExists($docIdx), 'The document index should not exist');
+        Definition::ensureDocumentIndex(ThrowawayDb::TABLE, DocumentIndex::Full);
+        $this->assertTrue($this->itExists($docIdx), 'The document index should now exist');
+    }
+
+    public function testEnsureDocumentIndexSucceedsForOptimized(): void
+    {
+        $docIdx = 'idx_' . ThrowawayDb::TABLE . '_document';
+        Definition::ensureTable(ThrowawayDb::TABLE);
+        $this->assertFalse($this->itExists($docIdx), 'The document index should not exist');
+        Definition::ensureDocumentIndex(ThrowawayDb::TABLE, DocumentIndex::Optimized);
+        $this->assertTrue($this->itExists($docIdx), 'The document index should now exist');
+    }
+}

tests/integration/postgresql/DeleteTest.php

@@ -0,0 +1,89 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Count, Delete, Field};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * PostgreSQL integration tests for the Delete class
+ */
+#[TestDox('Delete (PostgreSQL integration)')]
+class DeleteTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    #[TestDox('By ID succeeds when a document is deleted')]
+    public function testByIdSucceedsWhenADocumentIsDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byId(ThrowawayDb::TABLE, 'four');
+        $this->assertEquals(4, Count::all(ThrowawayDb::TABLE), 'There should have been 4 documents remaining');
+    }
+
+    #[TestDox('By ID succeeds when a document is not deleted')]
+    public function testByIdSucceedsWhenADocumentIsNotDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byId(ThrowawayDb::TABLE, 'negative four');
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
+    }
+
+    public function testByFieldsSucceedsWhenDocumentsAreDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byFields(ThrowawayDb::TABLE, [Field::NE('value', 'purple')]);
+        $this->assertEquals(2, Count::all(ThrowawayDb::TABLE), 'There should have been 2 documents remaining');
+    }
+
+    public function testByFieldsSucceedsWhenDocumentsAreNotDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'crimson')]);
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsAreDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byContains(ThrowawayDb::TABLE, ['value' => 'purple']);
+        $this->assertEquals(3, Count::all(ThrowawayDb::TABLE), 'There should have been 3 documents remaining');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsAreNotDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byContains(ThrowawayDb::TABLE, ['target' => 'acquired']);
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents are deleted')]
+    public function testByJsonPathSucceedsWhenDocumentsAreDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ <> 0)');
+        $this->assertEquals(1, Count::all(ThrowawayDb::TABLE), 'There should have been 1 document remaining');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents are not deleted')]
+    public function testByJsonPathSucceedsWhenDocumentsAreNotDeleted(): void
+    {
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
+        Delete::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ < 0)');
+        $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
+    }
+}

tests/integration/postgresql/DocumentListTest.php

@@ -0,0 +1,74 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{DocumentList, Query};
+use BitBadger\PDODocument\Mapper\DocumentMapper;
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\TestDocument;
+
+/**
+ * PostgreSQL integration tests for the DocumentList class
+ */
+#[TestDox('DocumentList (PostgreSQL integration)')]
+class DocumentListTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    public function testCreateSucceeds(): void
+    {
+        $list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'There should have been a document list created');
+        $list = null;
+    }
+
+    public function testItems(): void
+    {
+        $list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'There should have been a document list created');
+        $count = 0;
+        foreach ($list->items() as $item) {
+            $this->assertContains($item->id, ['one', 'two', 'three', 'four', 'five'],
+                'An unexpected document ID was returned');
+            $count++;
+        }
+        $this->assertEquals(5, $count, 'There should have been 5 documents returned');
+    }
+
+    public function testHasItemsSucceedsWithEmptyResults(): void
+    {
+        $list = DocumentList::create(
+            Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE (data->>'num_value')::numeric < 0", [],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'There should have been a document list created');
+        $this->assertFalse($list->hasItems(), 'There should be no items in the list');
+    }
+
+    public function testHasItemsSucceedsWithNonEmptyResults(): void
+    {
+        $list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
+            new DocumentMapper(TestDocument::class));
+        $this->assertNotNull($list, 'There should have been a document list created');
+        $this->assertTrue($list->hasItems(), 'There should be items in the list');
+        foreach ($list->items() as $ignored) {
+            $this->assertTrue($list->hasItems(), 'There should be items remaining in the list');
+        }
+        $this->assertFalse($list->hasItems(), 'There should be no remaining items in the list');
+    }
+}

tests/integration/postgresql/DocumentTest.php

@@ -0,0 +1,302 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{AutoId, Configuration, Custom, Document, DocumentException, Field, Find, Query};
+use BitBadger\PDODocument\Mapper\ArrayMapper;
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\{NumDocument, SubDocument, TestDocument};
+
+/**
+ * PostgreSQL integration tests for the Document class
+ */
+#[TestDox('Document (PostgreSQL integration)')]
+class DocumentTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    #[TestDox('Insert succeeds for array no auto ID')]
+    public function testInsertSucceedsForArrayNoAutoId(): void
+    {
+        Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]);
+        $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document inserted');
+        $this->assertEquals('turkey', $doc->id, 'The ID was incorrect');
+        $this->assertEquals('', $doc->value, 'The value was incorrect');
+        $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect');
+        $this->assertNotNull($doc->sub, 'The sub-document should not have been null');
+        $this->assertEquals('gobble', $doc->sub->foo, 'The sub-document foo property was incorrect');
+        $this->assertEquals('gobble', $doc->sub->bar, 'The sub-document bar property was incorrect');
+    }
+
+    #[TestDox('Insert succeeds for array with auto number ID not provided')]
+    public function testInsertSucceedsForArrayWithAutoNumberIdNotProvided(): void
+    {
+        Configuration::$autoId = AutoId::Number;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+
+            Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'new', 'num_value' => 8]);
+            $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper());
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $obj = json_decode($doc['data']);
+            $this->assertEquals(1, $obj->id, 'The ID 1 should have been auto-generated');
+
+            Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'again', 'num_value' => 7]);
+            $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE " . Query::whereById(docId: 2),
+                [':id' => 2], new ArrayMapper());
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $obj = json_decode($doc['data']);
+            $this->assertEquals(2, $obj->id, 'The ID 2 should have been auto-generated');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for array with auto number ID with ID provided')]
+    public function testInsertSucceedsForArrayWithAutoNumberIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::Number;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, ['id' => 7, 'value' => 'new', 'num_value' => 8]);
+            $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper());
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $obj = json_decode($doc['data']);
+            $this->assertEquals(7, $obj->id, 'The ID 7 should have been stored');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for array with auto UUID ID not provided')]
+    public function testInsertSucceedsForArrayWithAutoUuidIdNotProvided(): void
+    {
+        Configuration::$autoId = AutoId::UUID;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, ['id' => '', 'num_value' => 5]);
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 5)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for array with auto UUID ID with ID provided')]
+    public function testInsertSucceedsForArrayWithAutoUuidIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::UUID;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            $uuid = AutoId::generateUUID();
+            Document::insert(ThrowawayDb::TABLE, ['id' => $uuid, 'value' => 'uuid', 'num_value' => 12]);
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 12)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for array with auto string ID not provided')]
+    public function testInsertSucceedsForArrayWithAutoStringIdNotProvided(): void
+    {
+        Configuration::$autoId         = AutoId::RandomString;
+        Configuration::$idStringLength = 6;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, ['id' => '', 'value' => 'new', 'num_value' => 8]);
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 8)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals(6, strlen($doc->id), 'The ID should have been auto-generated and had 6 characters');
+        } finally {
+            Configuration::$autoId         = AutoId::None;
+            Configuration::$idStringLength = 16;
+        }
+    }
+
+    #[TestDox('Insert succeeds for array with auto string ID with ID provided')]
+    public function testInsertSucceedsForArrayWithAutoStringIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::RandomString;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, ['id' => 'my-key', 'value' => 'old', 'num_value' => 3]);
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object no auto ID')]
+    public function testInsertSucceedsForObjectNoAutoId(): void
+    {
+        Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble')));
+        $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document inserted');
+        $this->assertEquals('turkey', $doc->id, 'The ID was incorrect');
+        $this->assertEquals('', $doc->value, 'The value was incorrect');
+        $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect');
+        $this->assertNotNull($doc->sub, 'The sub-document should not have been null');
+        $this->assertEquals('gobble', $doc->sub->foo, 'The sub-document foo property was incorrect');
+        $this->assertEquals('gobble', $doc->sub->bar, 'The sub-document bar property was incorrect');
+    }
+
+    #[TestDox('Insert succeeds for object with auto number ID not provided')]
+    public function testInsertSucceedsForObjectWithAutoNumberIdNotProvided(): void
+    {
+        Configuration::$autoId = AutoId::Number;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+
+            Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco'));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'taco')], NumDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals(1, $doc->id, 'The ID 1 should have been auto-generated');
+
+            Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'burrito'));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'burrito')], NumDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals(2, $doc->id, 'The ID 2 should have been auto-generated');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object with auto number ID with ID provided')]
+    public function testInsertSucceedsForObjectWithAutoNumberIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::Number;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, new NumDocument(64, 'large'));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'large')], NumDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals(64, $doc->id, 'The ID 64 should have been stored');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object with auto UUID ID not provided')]
+    public function testInsertSucceedsForObjectWithAutoUuidIdNotProvided(): void
+    {
+        Configuration::$autoId = AutoId::UUID;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, new TestDocument(value: 'something', num_value: 9));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EX('value')], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object with auto UUID ID with ID provided')]
+    public function testInsertSucceedsForObjectWithAutoUuidIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::UUID;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            $uuid = AutoId::generateUUID();
+            Document::insert(ThrowawayDb::TABLE, new TestDocument($uuid, num_value: 14));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 14)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object with auto string ID not provided')]
+    public function testInsertSucceedsForObjectWithAutoStringIdNotProvided(): void
+    {
+        Configuration::$autoId         = AutoId::RandomString;
+        Configuration::$idStringLength = 40;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, new TestDocument(num_value: 55));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 55)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals(40, strlen($doc->id), 'The ID should have been auto-generated and had 40 characters');
+        } finally {
+            Configuration::$autoId         = AutoId::None;
+            Configuration::$idStringLength = 16;
+        }
+    }
+
+    #[TestDox('Insert succeeds for object with auto string ID with ID provided')]
+    public function testInsertSucceedsForObjectWithAutoStringIdWithIdProvided(): void
+    {
+        Configuration::$autoId = AutoId::RandomString;
+        try {
+            Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+            Document::insert(ThrowawayDb::TABLE, new TestDocument('my-key', num_value: 3));
+            $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class);
+            $this->assertNotFalse($doc, 'There should have been a document returned');
+            $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed');
+        } finally {
+            Configuration::$autoId = AutoId::None;
+        }
+    }
+
+    public function testInsertFailsForDuplicateKey(): void
+    {
+        $this->expectException(DocumentException::class);
+        Document::insert(ThrowawayDb::TABLE, new TestDocument('one'));
+    }
+
+    public function testSaveSucceedsWhenADocumentIsInserted(): void
+    {
+        Document::save(ThrowawayDb::TABLE, new TestDocument('test', sub: new SubDocument('a', 'b')));
+        $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+    }
+
+    public function testSaveSucceedsWhenADocumentIsUpdated(): void
+    {
+        Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44));
+        $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals(44, $doc->num_value, 'The numeric value was not updated');
+        $this->assertNull($doc->sub, 'The sub-document should have been null');
+    }
+
+    public function testUpdateSucceedsWhenReplacingADocument(): void
+    {
+        Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z')));
+        $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('howdy', $doc->value, 'The value was incorrect');
+        $this->assertEquals(8, $doc->num_value, 'The numeric value was incorrect');
+        $this->assertNotNull($doc->sub, 'The sub-document should not have been null');
+        $this->assertEquals('y', $doc->sub->foo, 'The sub-document foo property was incorrect');
+        $this->assertEquals('z', $doc->sub->bar, 'The sub-document bar property was incorrect');
+    }
+
+    public function testUpdateSucceedsWhenNoDocumentIsReplaced(): void
+    {
+        Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200'));
+        $doc = Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class);
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+}

tests/integration/postgresql/ExistsTest.php

@@ -0,0 +1,80 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Exists, Field};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * PostgreSQL integration tests for the Exists class
+ */
+#[TestDox('Exists (PostgreSQL integration)')]
+class ExistsTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    #[TestDox('By ID succeeds when a document exists')]
+    public function testByIdSucceedsWhenADocumentExists(): void
+    {
+        $this->assertTrue(Exists::byId(ThrowawayDb::TABLE, 'three'), 'There should have been an existing document');
+    }
+
+    #[TestDox('By ID succeeds when a document does not exist')]
+    public function testByIdSucceedsWhenADocumentDoesNotExist(): void
+    {
+        $this->assertFalse(Exists::byId(ThrowawayDb::TABLE, 'seven'),
+            'There should not have been an existing document');
+    }
+
+    public function testByFieldsSucceedsWhenDocumentsExist(): void
+    {
+        $this->assertTrue(Exists::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 10)]),
+            'There should have been existing documents');
+    }
+
+    public function testByFieldsSucceedsWhenNoMatchingDocumentsExist(): void
+    {
+        $this->assertFalse(Exists::byFields(ThrowawayDb::TABLE, [Field::LT('nothing', 'none')]),
+            'There should not have been any existing documents');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsExist(): void
+    {
+        $this->assertTrue(Exists::byContains(ThrowawayDb::TABLE, ['value' => 'purple']),
+            'There should have been existing documents');
+    }
+
+    public function testByContainsSucceedsWhenNoMatchingDocumentsExist(): void
+    {
+        $this->assertFalse(Exists::byContains(ThrowawayDb::TABLE, ['value' => 'violet']),
+            'There should not have been existing documents');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents exist')]
+    public function testByJsonPathSucceedsWhenDocumentsExist(): void
+    {
+        $this->assertTrue(Exists::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10)'),
+            'There should have been existing documents');
+    }
+
+    #[TestDox('By JSON Path succeeds when no matching documents exist')]
+    public function testByJsonPathSucceedsWhenNoMatchingDocumentsExist(): void
+    {
+        $this->assertFalse(Exists::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10.1)'),
+            'There should have been existing documents');
+    }
+}

tests/integration/postgresql/FindTest.php

@@ -0,0 +1,184 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Custom, Delete, Document, Field, Find};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\{NumDocument, TestDocument};
+
+/**
+ * PostgreSQL integration tests for the Find class
+ */
+#[TestDox('Find (PostgreSQL integration)')]
+class FindTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    public function testAllSucceedsWhenThereIsData(): void
+    {
+        $docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $count = 0;
+        foreach ($docs->items() as $ignored) $count++;
+        $this->assertEquals(5, $count, 'There should have been 5 documents in the list');
+    }
+
+    public function testAllSucceedsWhenThereIsNoData(): void
+    {
+        Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
+        $docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertFalse($docs->hasItems(), 'There should have been no documents in the list');
+    }
+
+    #[TestDox('By ID succeeds when a document is found')]
+    public function testByIdSucceedsWhenADocumentIsFound(): void
+    {
+        $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('two', $doc->id, 'An incorrect document was returned');
+    }
+
+    #[TestDox('By ID succeeds when a document is found with numeric ID')]
+    public function testByIdSucceedsWhenADocumentIsFoundWithNumericId(): void
+    {
+        Delete::byFields(ThrowawayDb::TABLE, [Field::NEX('absent')]);
+        Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']);
+        $doc = Find::byId(ThrowawayDb::TABLE, 18, NumDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals(18, $doc->id, 'An incorrect document was returned');
+    }
+
+    #[TestDox('By ID succeeds when a document is not found')]
+    public function testByIdSucceedsWhenADocumentIsNotFound(): void
+    {
+        $doc = Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class);
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+
+    public function testByFieldsSucceedsWhenDocumentsAreFound(): void
+    {
+        $docs = Find::byFields(ThrowawayDb::TABLE, [Field::GT('num_value', 15)], TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $count = 0;
+        foreach ($docs->items() as $ignored) $count++;
+        $this->assertEquals(2, $count, 'There should have been 2 documents in the list');
+    }
+
+    public function testByFieldsSucceedsWhenNoDocumentsAreFound(): void
+    {
+        $docs = Find::byFields(ThrowawayDb::TABLE, [Field::GT('num_value', 100)], TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertFalse($docs->hasItems(), 'There should have been no documents in the list');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsAreFound(): void
+    {
+        $docs = Find::byContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $count = 0;
+        foreach ($docs->items() as $ignored) $count++;
+        $this->assertEquals(2, $count, 'There should have been 2 documents in the list');
+    }
+
+    public function testByContainsSucceedsWhenNoDocumentsAreFound(): void
+    {
+        $docs = Find::byContains(ThrowawayDb::TABLE, ['value' => 'indigo'], TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertFalse($docs->hasItems(), 'The document list should be empty');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents are found')]
+    public function testByJsonPathSucceedsWhenDocumentsAreFound(): void
+    {
+        $docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $count = 0;
+        foreach ($docs->items() as $ignored) $count++;
+        $this->assertEquals(2, $count, 'There should have been 2 documents in the list');
+    }
+
+    #[TestDox('By JSON Path succeeds when no documents are found')]
+    public function testByJsonPathSucceedsWhenNoDocumentsAreFound(): void
+    {
+        $docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertFalse($docs->hasItems(), 'The document list should be empty');
+    }
+
+    public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void
+    {
+        $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('two', $doc->id, 'The incorrect document was returned');
+    }
+
+    public function testFirstByFieldsSucceedsWhenMultipleDocumentsAreFound(): void
+    {
+        $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('sub.foo', 'green')], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertContains($doc->id, ['two', 'four'], 'An incorrect document was returned');
+    }
+
+    public function testFirstByFieldsSucceedsWhenADocumentIsNotFound(): void
+    {
+        $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'absent')], TestDocument::class);
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+
+    public function testFirstByContainsSucceedsWhenADocumentIsFound(): void
+    {
+        $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'FIRST!'], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('one', $doc->id, 'The incorrect document was returned');
+    }
+
+    public function testFirstByContainsSucceedsWhenMultipleDocumentsAreFound(): void
+    {
+        $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertContains($doc->id, ['four', 'five'], 'An incorrect document was returned');
+    }
+
+    public function testFirstByContainsSucceedsWhenADocumentIsNotFound(): void
+    {
+        $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'indigo'], TestDocument::class);
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+
+    #[TestDox('First by JSON Path succeeds when a document is found')]
+    public function testFirstByJsonPathSucceedsWhenADocumentIsFound(): void
+    {
+        $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10)', TestDocument::class);
+        $this->assertEquals('two', $doc->id, 'The incorrect document was returned');
+    }
+
+    #[TestDox('First by JSON Path succeeds when multiple documents are found')]
+    public function testFirstByJsonPathSucceedsWhenMultipleDocumentsAreFound(): void
+    {
+        $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertContains($doc->id, ['four', 'five'], 'An incorrect document was returned');
+    }
+
+    #[TestDox('First by JSON Path succeeds when a document is not found')]
+    public function testFirstByJsonPathSucceedsWhenADocumentIsNotFound(): void
+    {
+        $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class);
+        $this->assertFalse($doc, 'There should not have been a document returned');
+    }
+}

tests/integration/postgresql/PatchTest.php

@@ -0,0 +1,104 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Count, Exists, Field, Find, Patch};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\TestDocument;
+
+/**
+ * PostgreSQL integration tests for the Patch class
+ */
+#[TestDox('Patch (PostgreSQL integration)')]
+class PatchTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    #[TestDox('By ID succeeds when a document is updated')]
+    public function testByIdSucceedsWhenADocumentIsUpdated(): void
+    {
+        Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]);
+        $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals(44, $doc->num_value, 'The updated document is not correct');
+    }
+
+    #[TestDox('By ID succeeds when no document is updated')]
+    public function testByIdSucceedsWhenNoDocumentIsUpdated(): void
+    {
+        $id = 'forty-seven';
+        $this->assertFalse(Exists::byId(ThrowawayDb::TABLE, $id), 'The document should not exist');
+        Patch::byId(ThrowawayDb::TABLE, $id, ['foo' => 'green']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByFieldsSucceedsWhenADocumentIsUpdated(): void
+    {
+        Patch::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'purple')], ['num_value' => 77]);
+        $after = Count::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 77)]);
+        $this->assertEquals(2, $after, 'There should have been 2 documents updated');
+    }
+
+    public function testByFieldsSucceedsWhenNoDocumentIsUpdated(): void
+    {
+        $fields = [Field::EQ('value', 'burgundy')];
+        $this->assertEquals(0, Count::byFields(ThrowawayDb::TABLE, $fields), 'There should be no matching documents');
+        Patch::byFields(ThrowawayDb::TABLE, $fields, ['foo' => 'green']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByContainsSucceedsWhenDocumentsAreUpdated(): void
+    {
+        Patch::byContains(ThrowawayDb::TABLE, ['value' => 'another'], ['num_value' => 12]);
+        $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'another'], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('two', $doc->id, 'An incorrect document was returned');
+        $this->assertEquals(12, $doc->num_value, 'The document was not patched');
+    }
+
+    public function testByContainsSucceedsWhenNoDocumentsAreUpdated(): void
+    {
+        $criteria = ['value' => 'updated'];
+        $this->assertEquals(0, Count::byContains(ThrowawayDb::TABLE, $criteria),
+            'There should be no matching documents');
+        Patch::byContains(ThrowawayDb::TABLE, $criteria, ['sub.foo' => 'green']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    #[TestDox('By JSON Path succeeds when documents are updated')]
+    public function testByJsonPathSucceedsWhenDocumentsAreUpdated(): void
+    {
+        Patch::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', ['value' => 'blue']);
+        $docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertTrue($docs->hasItems(), 'The document list should not be empty');
+        foreach ($docs->items() as $item) {
+            $this->assertContains($item->id, ['four', 'five'], 'An incorrect document was returned');
+            $this->assertEquals('blue', $item->value, 'The document was not patched');
+        }
+    }
+
+    #[TestDox('By JSON Path succeeds when documents are not updated')]
+    public function testByJsonPathSucceedsWhenDocumentsAreNotUpdated(): void
+    {
+        $path = '$.num_value ? (@ > 100)';
+        $this->assertEquals(0, Count::byJsonPath(ThrowawayDb::TABLE, $path),
+            'There should be no documents matching this path');
+        Patch::byJsonPath(ThrowawayDb::TABLE, $path, ['value' => 'blue']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+}

tests/integration/postgresql/RemoveFieldsTest.php

@@ -0,0 +1,127 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{Field, Find, RemoveFields};
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Test\Integration\TestDocument;
+
+/**
+ * PostgreSQL integration tests for the RemoveFields class
+ */
+#[TestDox('Remove Fields (PostgreSQL integration)')]
+class RemoveFieldsTest extends TestCase
+{
+    /** @var string Database name for throwaway database */
+    private string $dbName;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->dbName = ThrowawayDb::create();
+    }
+
+    protected function tearDown(): void
+    {
+        ThrowawayDb::destroy($this->dbName);
+        parent::tearDown();
+    }
+
+    #[TestDox('By ID succeeds when fields are removed')]
+    public function testByIdSucceedsWhenFieldsAreRemoved(): void
+    {
+        RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']);
+        $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertEquals('', $doc->value, 'Value should have been blank (its default value)');
+        $this->assertNull($doc->sub, 'Sub-document should have been null');
+    }
+
+    #[TestDox('By ID succeeds when a field is not removed')]
+    public function testByIdSucceedsWhenAFieldIsNotRemoved(): void
+    {
+        RemoveFields::byId(ThrowawayDb::TABLE, 'one', ['a_field_that_does_not_exist']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    #[TestDox('By ID succeeds when no document is matched')]
+    public function testByIdSucceedsWhenNoDocumentIsMatched(): void
+    {
+        RemoveFields::byId(ThrowawayDb::TABLE, 'fifty', ['sub']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByFieldsSucceedsWhenAFieldIsRemoved(): void
+    {
+        RemoveFields::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], ['sub']);
+        $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], TestDocument::class);
+        $this->assertNotFalse($doc, 'There should have been a document returned');
+        $this->assertNull($doc->sub, 'Sub-document should have been null');
+    }
+
+    public function testByFieldsSucceedsWhenAFieldIsNotRemoved(): void
+    {
+        RemoveFields::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], ['nada']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByFieldsSucceedsWhenNoDocumentIsMatched(): void
+    {
+        RemoveFields::byFields(ThrowawayDb::TABLE, [Field::NE('missing', 'nope')], ['value']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByContainsSucceedsWhenAFieldIsRemoved(): void
+    {
+        $criteria = ['sub' => ['foo' => 'green']];
+        RemoveFields::byContains(ThrowawayDb::TABLE, $criteria, ['value']);
+        $docs = Find::byContains(ThrowawayDb::TABLE, $criteria, TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertTrue($docs->hasItems(), 'The document list should not have been empty');
+        foreach ($docs->items() as $item) {
+            $this->assertContains($item->id, ['two', 'four'], 'An incorrect document was returned');
+            $this->assertEquals('', $item->value, 'The value field was not removed');
+        }
+    }
+
+    public function testByContainsSucceedsWhenAFieldIsNotRemoved(): void
+    {
+        RemoveFields::byContains(ThrowawayDb::TABLE, ['sub' => ['foo' => 'green']], ['invalid_field']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    public function testByContainsSucceedsWhenNoDocumentIsMatched(): void
+    {
+        RemoveFields::byContains(ThrowawayDb::TABLE, ['value' => 'substantial'], ['num_value']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    #[TestDox('By JSON Path succeeds when a field is removed')]
+    public function testByJsonPathSucceedsWhenAFieldIsRemoved(): void
+    {
+        $path = '$.value ? (@ == "purple")';
+        RemoveFields::byJsonPath(ThrowawayDb::TABLE, $path, ['sub']);
+        $docs = Find::byJsonPath(ThrowawayDb::TABLE, $path, TestDocument::class);
+        $this->assertNotNull($docs, 'There should have been a document list returned');
+        $this->assertTrue($docs->hasItems(), 'The document list should not have been empty');
+        foreach ($docs->items() as $item) {
+            $this->assertContains($item->id, ['four', 'five'], 'An incorrect document was returned');
+            $this->assertNull($item->sub, 'The sub field was not removed');
+        }
+    }
+
+    #[TestDox('By JSON Path succeeds when a field is not removed')]
+    public function testByJsonPathSucceedsWhenAFieldIsNotRemoved(): void
+    {
+        RemoveFields::byJsonPath(ThrowawayDb::TABLE, '$.value ? (@ == "purple")', ['submarine']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+
+    #[TestDox('By JSON Path succeeds when no document is matched')]
+    public function testByJsonPathSucceedsWhenNoDocumentIsMatched(): void
+    {
+        RemoveFields::byJsonPath(ThrowawayDb::TABLE, '$.value ? (@ == "mauve")', ['value']);
+        $this->assertTrue(true, 'The above not throwing an exception is the test');
+    }
+}

tests/integration/postgresql/ThrowawayDb.php

@@ -0,0 +1,75 @@
+<?php declare(strict_types=1);
+
+namespace Test\Integration\PostgreSQL;
+
+use BitBadger\PDODocument\{AutoId, Configuration, Custom, Definition, Document, DocumentException, Mode};
+use Random\RandomException;
+use Test\Integration\{SubDocument, TestDocument};
+
+/**
+ * Utilities to create and destroy a throwaway PostgreSQL database to use for testing
+ */
+class ThrowawayDb
+{
+    /** @var string The table used for document manipulation */
+    public const TABLE = "test_table";
+
+    /**
+     * Configure the document library for the given database (or the main PostgreSQL connection, if the database name
+     * is not provided; this is used for creating and dropping databases)
+     *
+     * @param string|null $dbName The name of the database to configure (optional, defaults to env or "postgres")
+     */
+    private static function configure(?string $dbName = null): void
+    {
+        Configuration::$pdoDSN = sprintf("pgsql:host=%s;dbname=%s", $_ENV['PDO_DOC_PGSQL_HOST'] ?? 'localhost',
+            $dbName ?? $_ENV['PDO_DOC_PGSQL_DB'] ?? 'postgres');
+        Configuration::$username = $_ENV['PDO_DOC_PGSQL_USER'] ?? 'postgres';
+        Configuration::$password = $_ENV['PDO_DOC_PGSQL_PASS'] ?? 'postgres';
+        Configuration::$mode = Mode::PgSQL;
+        Configuration::resetPDO();
+    }
+
+    /**
+     * Create a throwaway PostgreSQL database
+     *
+     * @param bool $withData Whether to initialize this database with data (optional; defaults to `true`)
+     * @return string The name of the database (use to pass to `destroy` function at end of test)
+     * @throws DocumentException|RandomException If any is encountered
+     */
+    public static function create(bool $withData = true): string
+    {
+        $dbName = 'throwaway_' . AutoId::generateRandom(10);
+        self::configure();
+        Custom::nonQuery("CREATE DATABASE $dbName WITH OWNER " . Configuration::$username, []);
+        self::configure($dbName);
+
+        if ($withData) {
+            Definition::ensureTable(self::TABLE);
+            Document::insert(self::TABLE, new TestDocument('one', 'FIRST!', 0));
+            Document::insert(self::TABLE, new TestDocument('two', 'another', 10, new SubDocument('green', 'blue')));
+            Document::insert(self::TABLE, new TestDocument('three', '', 4));
+            Document::insert(self::TABLE, new TestDocument('four', 'purple', 17, new SubDocument('green', 'red')));
+            Document::insert(self::TABLE, new TestDocument('five', 'purple', 18));
+        }
+
+        return $dbName;
+    }
+
+    /**
+     * Destroy a throwaway PostgreSQL database
+     *
+     * @param string $dbName The name of the PostgreSQL database to be dropped
+     * @throws DocumentException If any is encountered
+     */
+    public static function destroy(string $dbName): void
+    {
+        self::configure();
+        Custom::nonQuery("DROP DATABASE IF EXISTS $dbName WITH (FORCE)", []);
+        Configuration::$pdoDSN   = '';
+        Configuration::$username = null;
+        Configuration::$password = null;
+        Configuration::$mode     = null;
+        Configuration::resetPDO();
+    }
+}

tests/integration/sqlite/CountTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Count, Field};
+use BitBadger\PDODocument\{Count, DocumentException, Field};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
@@ -44,4 +44,17 @@ class CountTest extends TestCase
         $count = Count::byFields(ThrowawayDb::TABLE, [Field::BT('value', 'aardvark', 'apple')]);
         $this->assertEquals(1, $count, 'There should have been 1 matching document');
     }
+
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Count::byContains('', []);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Count::byJsonPath('', '');
+    }
 }

tests/integration/sqlite/DefinitionTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Custom, Definition, DocumentException};
+use BitBadger\PDODocument\{Custom, Definition, DocumentException, DocumentIndex};
 use BitBadger\PDODocument\Mapper\ExistsMapper;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
@@ -41,7 +41,7 @@ class DefinitionTest extends TestCase
             [':name' => $name], new ExistsMapper());
     }
 
-    public function testEnsureTableSucceeds()
+    public function testEnsureTableSucceeds(): void
     {
         $this->assertFalse($this->itExists('ensured'), 'The table should not exist already');
         $this->assertFalse($this->itExists('idx_ensured_key'), 'The key index should not exist already');
@@ -50,11 +50,17 @@ class DefinitionTest extends TestCase
         $this->assertTrue($this->itExists('idx_ensured_key'), 'The key index should now exist');
     }
 
-    public function testEnsureFieldIndexSucceeds()
+    public function testEnsureFieldIndexSucceeds(): void
     {
         $this->assertFalse($this->itExists('idx_ensured_test'), 'The index should not exist already');
         Definition::ensureTable('ensured');
         Definition::ensureFieldIndex('ensured', 'test', ['name', 'age']);
         $this->assertTrue($this->itExists('idx_ensured_test'), 'The index should now exist');
     }
+
+    public function testEnsureDocumentIndexFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Definition::ensureDocumentIndex('nope', DocumentIndex::Full);
+    }
 }

tests/integration/sqlite/DeleteTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Count, Delete, Field};
+use BitBadger\PDODocument\{Count, Delete, DocumentException, Field};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
@@ -56,4 +56,17 @@ class DeleteTest extends TestCase
         Delete::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'crimson')]);
         $this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
     }
+
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Delete::byContains('', []);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Delete::byJsonPath('', '');
+    }
 }

tests/integration/sqlite/ExistsTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Exists, Field};
+use BitBadger\PDODocument\{DocumentException, Exists, Field};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
@@ -51,4 +51,18 @@ class ExistsTest extends TestCase
         $this->assertFalse(Exists::byFields(ThrowawayDb::TABLE, [Field::LT('nothing', 'none')]),
             'There should not have been any existing documents');
     }
+
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Exists::byContains('', []);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Exists::byJsonPath('', '');
+    }
 }
+

tests/integration/sqlite/FindTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Custom, Document, Field, Find};
+use BitBadger\PDODocument\{Custom, Document, DocumentException, Field, Find};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 use Test\Integration\TestDocument;
@@ -82,11 +82,22 @@ class FindTest extends TestCase
     {
         $docs = Find::byFields(ThrowawayDb::TABLE, [Field::GT('num_value', 100)], TestDocument::class);
         $this->assertNotNull($docs, 'There should have been a document list returned');
-        $count = 0;
-        foreach ($docs->items() as $ignored) $count++;
         $this->assertFalse($docs->hasItems(), 'There should have been no documents in the list');
     }
 
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::byContains('', [], TestDocument::class);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::byJsonPath('', '', TestDocument::class);
+    }
+
     public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void
     {
         $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class);
@@ -106,4 +117,17 @@ class FindTest extends TestCase
         $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'absent')], TestDocument::class);
         $this->assertFalse($doc, 'There should not have been a document returned');
     }
+
+    public function testFirstByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::firstByContains('', [], TestDocument::class);
+    }
+
+    #[TestDox('First by JSON Path fails')]
+    public function testFirstByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::firstByJsonPath('', '', TestDocument::class);
+    }
 }

tests/integration/sqlite/PatchTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Count, Field, Find, Patch};
+use BitBadger\PDODocument\{Count, DocumentException, Field, Find, Patch};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 use Test\Integration\TestDocument;
@@ -44,7 +44,6 @@ class PatchTest extends TestCase
         $this->assertTrue(true, 'The above not throwing an exception is the test');
     }
 
-
     public function testByFieldsSucceedsWhenADocumentIsUpdated(): void
     {
         Patch::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'purple')], ['num_value' => 77]);
@@ -57,4 +56,17 @@ class PatchTest extends TestCase
         Patch::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'burgundy')], ['foo' => 'green']);
         $this->assertTrue(true, 'The above not throwing an exception is the test');
     }
+
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Patch::byContains('', [], []);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        Patch::byJsonPath('', '', []);
+    }
 }

tests/integration/sqlite/RemoveFieldsTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\{Field, Find, RemoveFields};
+use BitBadger\PDODocument\{DocumentException, Field, Find, RemoveFields};
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 use Test\Integration\TestDocument;
@@ -71,4 +71,17 @@ class RemoveFieldsTest extends TestCase
         RemoveFields::byFields(ThrowawayDb::TABLE, [Field::NE('missing', 'nope')], ['value']);
         $this->assertTrue(true, 'The above not throwing an exception is the test');
     }
+
+    public function testByContainsFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        RemoveFields::byContains('', [], []);
+    }
+
+    #[TestDox('By JSON Path fails')]
+    public function testByJsonPathFails(): void
+    {
+        $this->expectException(DocumentException::class);
+        RemoveFields::byJsonPath('', '', []);
+    }
 }

tests/integration/sqlite/ThrowawayDb.php

@@ -2,13 +2,9 @@
 
 namespace Test\Integration\SQLite;
 
-use BitBadger\PDODocument\Configuration;
+use BitBadger\PDODocument\{AutoId, Configuration, Definition, Document, DocumentException, Mode};
-use BitBadger\PDODocument\Definition;
+use Random\RandomException;
-use BitBadger\PDODocument\Document;
+use Test\Integration\{SubDocument, TestDocument};
-use BitBadger\PDODocument\DocumentException;
-use BitBadger\PDODocument\Mode;
-use Test\Integration\SubDocument;
-use Test\Integration\TestDocument;
 
 /**
  * Utilities to create and destroy a throwaway SQLite database to use for testing
@@ -16,18 +12,18 @@ use Test\Integration\TestDocument;
 class ThrowawayDb
 {
     /** @var string The table used for document manipulation */
-    public const string TABLE = "test_table";
+    public const TABLE = "test_table";
 
     /**
      * Create a throwaway SQLite database
      *
      * @param bool $withData Whether to initialize this database with data (optional; defaults to `true`)
      * @return string The name of the database (use to pass to `destroy` function at end of test)
-     * @throws DocumentException If any is encountered
+     * @throws DocumentException|RandomException If any is encountered
      */
     public static function create(bool $withData = true): string
     {
-        $fileName = sprintf('throwaway-%s-%d.db', date('His'), rand(10, 99));
+        $fileName = sprintf('throwaway-%s.db', AutoId::generateRandom(10));
         Configuration::$pdoDSN = "sqlite:./$fileName";
         Configuration::$mode   = Mode::SQLite;
         Configuration::resetPDO();
@@ -52,20 +48,6 @@ class ThrowawayDb
     public static function destroy(string $fileName): void
     {
         Configuration::resetPDO();
-        unlink("./$fileName");
+        if (file_exists("./$fileName")) unlink("./$fileName");
-    }
-
-    /**
-     * Destroy the given throwaway database and create another
-     *
-     * @param string $fileName The name of the database to be destroyed
-     * @param bool $withData Whether to initialize the database with data (optional; defaults to `true`)
-     * @return string The name of the new database
-     * @throws DocumentException If any is encountered
-     */
-    public static function exchange(string $fileName, bool $withData = true): string
-    {
-        self::destroy($fileName);
-        return self::create($withData);
     }
 }

tests/unit/ConfigurationTest.php

@@ -9,6 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Configuration class
  */
+#[TestDox('Configuration (Unit tests)')]
 class ConfigurationTest extends TestCase
 {
     #[TestDox('ID field default succeeds')]

tests/unit/DocumentExceptionTest.php

@@ -4,11 +4,13 @@ namespace Test\Unit;
 
 use BitBadger\PDODocument\DocumentException;
 use Exception;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Unit tests for the DocumentException class
  */
+#[TestDox('Document Exception (Unit tests)')]
 class DocumentExceptionTest extends TestCase
 {
     public function testConstructorSucceedsWithCodeAndPriorException()

tests/unit/FieldMatchTest.php

@@ -3,11 +3,13 @@
 namespace Test\Unit;
 
 use BitBadger\PDODocument\FieldMatch;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Unit tests for the FieldMatch enum
  */
+#[TestDox('Field Match (Unit tests)')]
 class FieldMatchTest extends TestCase
 {
     public function testToStringSucceedsForAll(): void

tests/unit/FieldTest.php

@@ -9,6 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Field class
  */
+#[TestDox('Field (Unit tests)')]
 class FieldTest extends TestCase
 {
     #[TestDox('Append parameter succeeds for EX')]
@@ -221,7 +222,7 @@ class FieldTest extends TestCase
         try {
             $field = Field::LE('le_field', 18, '@it');
             $field->qualifier = 'q';
-            $this->assertEquals("q.data->>'le_field' <= @it", $field->toWhere(),
+            $this->assertEquals("(q.data->>'le_field')::numeric <= @it", $field->toWhere(),
                 'WHERE fragment not generated correctly');
         } finally {
             Configuration::$mode = null;
@@ -248,7 +249,7 @@ class FieldTest extends TestCase
         Configuration::$mode = Mode::PgSQL;
         try {
             $field = Field::EQ('sub.foo.bar', 22, '@it');
-            $this->assertEquals("data->>'sub.foo.bar' = @it", $field->toWhere(),
+            $this->assertEquals("(data#>>'{sub,foo,bar}')::numeric = @it", $field->toWhere(),
                 'WHERE fragment not generated correctly');
         } finally {
             Configuration::$mode = null;

tests/unit/Mapper/ArrayMapperTest.php

@@ -3,11 +3,13 @@
 namespace Test\Unit\Mapper;
 
 use BitBadger\PDODocument\Mapper\ArrayMapper;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Unit tests for the ArrayMapper class
  */
+#[TestDox('Array Mapper (Unit tests)')]
 class ArrayMapperTest extends TestCase
 {
     public function testMapSucceeds(): void

tests/unit/Mapper/CountMapperTest.php

@@ -3,11 +3,13 @@
 namespace Test\Unit\Mapper;
 
 use BitBadger\PDODocument\Mapper\CountMapper;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Unit tests for the CountMapper class
  */
+#[TestDox('Count Mapper (Unit tests)')]
 class CountMapperTest extends TestCase
 {
     public function testMapSucceeds(): void

tests/unit/Mapper/DocumentMapperTest.php

@@ -22,6 +22,7 @@ class TestDocument
 /**
  * Unit tests for the DocumentMapper class
  */
+#[TestDox('Document Mapper (Unit tests)')]
 class DocumentMapperTest extends TestCase
 {
     public function testConstructorSucceedsWithDefaultField(): void

tests/unit/Mapper/ExistsMapperTest.php

@@ -10,6 +10,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the ExistsMapper class
  */
+#[TestDox('Exists Mapper (Unit tests)')]
 class ExistsMapperTest extends TestCase
 {
     #[TestDox('Map succeeds for PostgreSQL')]

tests/unit/Mapper/StringMapperTest.php

@@ -3,8 +3,13 @@
 namespace Test\Unit\Mapper;
 
 use BitBadger\PDODocument\Mapper\StringMapper;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * Unit tests for the StringMapper class
+ */
+#[TestDox('String Mapper (Unit tests)')]
 class StringMapperTest extends TestCase
 {
     public function testMapSucceedsWhenFieldIsPresentAndString()

tests/unit/OpTest.php

@@ -9,6 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Op enumeration
  */
+#[TestDox('Op (Unit tests)')]
 class OpTest extends TestCase
 {
     #[TestDox('To string succeeds for EQ')]

tests/unit/ParametersTest.php

@@ -9,6 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Parameters class
  */
+#[TestDox('Parameters (Unit tests)')]
 class ParametersTest extends TestCase
 {
     #[TestDox('ID succeeds with string')]
@@ -51,7 +52,7 @@ class ParametersTest extends TestCase
     {
         try {
             Configuration::$mode = Mode::PgSQL;
-            $this->assertEquals([':names' => "ARRAY['one','two','seven']"],
+            $this->assertEquals([':names' => "{one,two,seven}"],
                 Parameters::fieldNames(':names', ['one', 'two', 'seven']), 'Field name parameters not correct');
         } finally {
             Configuration::$mode = null;

tests/unit/Query/CountTest.php

@@ -2,30 +2,64 @@
 
 namespace Test\Unit\Query;
 
-use BitBadger\PDODocument\{Configuration, Field, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
 use BitBadger\PDODocument\Query\Count;
+use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
 
 /**
  * Unit tests for the Count class
  */
+#[TestDox('Count Queries (Unit tests)')]
 class CountTest extends TestCase
 {
+    public function tearDown(): void
+    {
+        Configuration::$mode = null;
+        parent::tearDown();
+    }
 
-    public function testAllSucceeds()
+    public function testAllSucceeds(): void
     {
         $this->assertEquals('SELECT COUNT(*) FROM a_table', Count::all('a_table'),
             'SELECT statement not generated correctly');
     }
 
-    public function testByFieldsSucceeds()
+    public function testByFieldsSucceeds(): void
     {
         Configuration::$mode = Mode::SQLite;
-        try {
         $this->assertEquals("SELECT COUNT(*) FROM somewhere WHERE data->>'errors' > :errors",
-                Count::byFields('somewhere', [Field::GT('errors', 10, ':errors')]));
+            Count::byFields('somewhere', [Field::GT('errors', 10, ':errors')]),
-        } finally {
+            'SELECT statement not generated correctly');
-            Configuration::$mode = null;
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT COUNT(*) FROM the_table WHERE data @> :criteria', Count::byContains('the_table'),
+            'SELECT statement not generated correctly');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Count::byContains('');
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT COUNT(*) FROM a_table WHERE jsonb_path_exists(data, :path::jsonpath)',
+            Count::byJsonPath('a_table'), 'SELECT statement not generated correctly');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Count::byJsonPath('');
     }
 }

tests/unit/Query/DefinitionTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Unit\Query;
 
-use BitBadger\PDODocument\{Configuration, DocumentException, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, DocumentIndex, Mode};
 use BitBadger\PDODocument\Query\Definition;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
@@ -10,36 +10,34 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Definition class
  */
+#[TestDox('Definition Queries (Unit tests)')]
 class DefinitionTest extends TestCase
 {
+    protected function tearDown(): void
+    {
+        Configuration::$mode = null;
+        parent::tearDown();
+    }
+
     #[TestDox('Ensure table succeeds for PosgtreSQL')]
     public function testEnsureTableSucceedsForPostgreSQL(): void
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
         $this->assertEquals('CREATE TABLE IF NOT EXISTS documents (data JSONB NOT NULL)',
             Definition::ensureTable('documents'), 'CREATE TABLE statement not generated correctly');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('Ensure table succeeds for SQLite')]
     public function testEnsureTableSucceedsForSQLite(): void
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals('CREATE TABLE IF NOT EXISTS dox (data TEXT NOT NULL)', Definition::ensureTable('dox'),
             'CREATE TABLE statement not generated correctly');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     public function testEnsureTableFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         Definition::ensureTable('boom');
     }
 
@@ -57,9 +55,30 @@ class DefinitionTest extends TestCase
             'CREATE INDEX statement not generated correctly');
     }
 
-    public function testEnsureKey(): void
+    public function testEnsureKeySucceeds(): void
     {
         $this->assertEquals("CREATE UNIQUE INDEX IF NOT EXISTS idx_tbl_key ON tbl ((data->>'id'))",
             Definition::ensureKey('tbl'), 'CREATE INDEX statement for document key not generated correctly');
     }
+
+    public function testEnsureDocumentIndexOnSucceedsForSchemaAndFull(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals("CREATE INDEX IF NOT EXISTS idx_tbl_document ON my.tbl USING GIN (data)",
+            Definition::ensureDocumentIndexOn('my.tbl', DocumentIndex::Full));
+    }
+
+    public function testEnsureDocumentIndexOnSucceedsForNoSchemaAndOptimized(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals("CREATE INDEX IF NOT EXISTS idx_it_document ON it USING GIN (data jsonb_path_ops)",
+            Definition::ensureDocumentIndexOn('it', DocumentIndex::Optimized));
+    }
+
+    #[TestDox('Ensure document index on fails for non PostgreSQL')]
+    public function testEnsureDocumentIndexOnFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Definition::ensureDocumentIndexOn('', DocumentIndex::Full);
+    }
 }

tests/unit/Query/DeleteTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Unit\Query;
 
-use BitBadger\PDODocument\{Configuration, Field, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
 use BitBadger\PDODocument\Query\Delete;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
@@ -10,13 +10,9 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Delete class
  */
+#[TestDox('Delete Queries (Unit tests)')]
 class DeleteTest extends TestCase
 {
-    protected function setUp(): void
-    {
-        Configuration::$mode = Mode::SQLite;
-    }
-
     protected function tearDown(): void
     {
         Configuration::$mode = null;
@@ -25,14 +21,46 @@ class DeleteTest extends TestCase
     #[TestDox('By ID succeeds')]
     public function testByIdSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("DELETE FROM over_there WHERE data->>'id' = :id", Delete::byId('over_there'),
             'DELETE statement not constructed correctly');
     }
 
     public function testByFieldsSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("DELETE FROM my_table WHERE data->>'value' < :max AND data->>'value' >= :min",
             Delete::byFields('my_table', [Field::LT('value', 99, ':max'), Field::GE('value', 18, ':min')]),
             'DELETE statement not constructed correctly');
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('DELETE FROM somewhere WHERE data @> :criteria', Delete::byContains('somewhere'),
+            'DELETE statement not constructed correctly');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Delete::byContains('');
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('DELETE FROM here WHERE jsonb_path_exists(data, :path::jsonpath)',
+            Delete::byJsonPath('here'), 'DELETE statement not constructed correctly');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Delete::byJsonPath('');
+    }
 }

tests/unit/Query/ExistsTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Unit\Query;
 
-use BitBadger\PDODocument\{Configuration, Field, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
 use BitBadger\PDODocument\Query\Exists;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
@@ -10,13 +10,9 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Exists class
  */
+#[TestDox('Exists Queries (Unit tests)')]
 class ExistsTest extends TestCase
 {
-    protected function setUp(): void
-    {
-        Configuration::$mode = Mode::SQLite;
-    }
-
     protected function tearDown(): void
     {
         Configuration::$mode = null;
@@ -24,6 +20,7 @@ class ExistsTest extends TestCase
 
     public function testQuerySucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals('SELECT EXISTS (SELECT 1 FROM abc WHERE def)', Exists::query('abc', 'def'),
             'Existence query not generated correctly');
     }
@@ -31,14 +28,46 @@ class ExistsTest extends TestCase
     #[TestDox('By ID succeeds')]
     public function testByIdSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("SELECT EXISTS (SELECT 1 FROM dox WHERE data->>'id' = :id)", Exists::byId('dox'),
             'Existence query not generated correctly');
     }
 
     public function testByFieldsSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("SELECT EXISTS (SELECT 1 FROM box WHERE data->>'status' <> :status)",
             Exists::byFields('box', [Field::NE('status', 'occupied', ':status')]),
             'Existence query not generated correctly');
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT EXISTS (SELECT 1 FROM pocket WHERE data @> :criteria)',
+            Exists::byContains('pocket'), 'Existence query not generated correctly');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Exists::byContains('');
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT EXISTS (SELECT 1 FROM lint WHERE jsonb_path_exists(data, :path::jsonpath))',
+            Exists::byJsonPath('lint'), 'Existence query not generated correctly');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Exists::byJsonPath('');
+    }
 }

tests/unit/Query/FindTest.php

@@ -2,7 +2,7 @@
 
 namespace Test\Unit\Query;
 
-use BitBadger\PDODocument\{Configuration, Field, FieldMatch, Mode};
+use BitBadger\PDODocument\{Configuration, DocumentException, Field, FieldMatch, Mode};
 use BitBadger\PDODocument\Query\Find;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
@@ -10,13 +10,9 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Find class
  */
+#[TestDox('Find Queries (Unit tests)')]
 class FindTest extends TestCase
 {
-    protected function setUp(): void
-    {
-        Configuration::$mode = Mode::SQLite;
-    }
-
     protected function tearDown(): void
     {
         Configuration::$mode = null;
@@ -25,15 +21,47 @@ class FindTest extends TestCase
     #[TestDox('By ID succeeds')]
     public function testByIdSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("SELECT data FROM here WHERE data->>'id' = :id", Find::byId('here'),
             'SELECT query not generated correctly');
     }
 
     public function testByFieldsSucceeds(): void
     {
+        Configuration::$mode = Mode::SQLite;
         $this->assertEquals("SELECT data FROM there WHERE data->>'active' = :act OR data->>'locked' = :lock",
             Find::byFields('there', [Field::EQ('active', true, ':act'), Field::EQ('locked', true, ':lock')],
                 FieldMatch::Any),
             'SELECT query not generated correctly');
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT data FROM disc WHERE data @> :criteria', Find::byContains('disc'),
+            'SELECT query not generated correctly');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::byContains('');
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('SELECT data FROM light WHERE jsonb_path_exists(data, :path::jsonpath)',
+            Find::byJsonPath('light'), 'SELECT query not generated correctly');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Find::byJsonPath('');
+    }
 }

tests/unit/Query/PatchTest.php

@@ -10,71 +10,87 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Patch class
  */
+#[TestDox('Patch Queries (Unit tests)')]
 class PatchTest extends TestCase
 {
+    protected function tearDown(): void
+    {
+        Configuration::$mode = null;
+        parent::tearDown();
+    }
     #[TestDox('By ID succeeds for PostgreSQL')]
     public function testByIdSucceedsForPostgreSQL(): void
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
         $this->assertEquals("UPDATE doc_table SET data = data || :data WHERE data->>'id' = :id",
             Patch::byId('doc_table'), 'Patch UPDATE statement is not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By ID succeeds for SQLite')]
     public function testByIdSucceedsForSQLite(): void
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals("UPDATE my_table SET data = json_patch(data, json(:data)) WHERE data->>'id' = :id",
             Patch::byId('my_table'), 'Patch UPDATE statement is not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By ID fails when mode not set')]
     public function testByIdFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         Patch::byId('oof');
     }
 
     #[TestDox('By fields succeeds for PostgreSQL')]
     public function testByFieldsSucceedsForPostgreSQL(): void
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
-            $this->assertEquals("UPDATE that SET data = data || :data WHERE data->>'something' < :some",
+        $this->assertEquals("UPDATE that SET data = data || :data WHERE (data->>'something')::numeric < :some",
-                Patch::byFields('that', [Field::LT('something', 17, ':some')]),
+            Patch::byFields('that', [Field::LT('something', 17, ':some')]), 'Patch UPDATE statement is not correct');
-                'Patch UPDATE statement is not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By fields succeeds for SQLite')]
     public function testByFieldsSucceedsForSQLite(): void
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals(
             "UPDATE a_table SET data = json_patch(data, json(:data)) WHERE data->>'something' > :it",
-                Patch::byFields('a_table', [Field::GT('something', 17, ':it')]),
+            Patch::byFields('a_table', [Field::GT('something', 17, ':it')]), 'Patch UPDATE statement is not correct');
-                'Patch UPDATE statement is not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     public function testByFieldsFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         Patch::byFields('oops', []);
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('UPDATE this SET data = data || :data WHERE data @> :criteria', Patch::byContains('this'),
+            'Patch UPDATE statement is not correct');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Patch::byContains('');
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('UPDATE that SET data = data || :data WHERE jsonb_path_exists(data, :path::jsonpath)',
+            Patch::byJsonPath('that'), 'Patch UPDATE statement is not correct');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        Patch::byJsonPath('');
+    }
 }

tests/unit/Query/RemoveFieldsTest.php

@@ -10,108 +10,118 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the RemoveFields class
  */
+#[TestDox('Remove Fields Queries (Unit tests)')]
 class RemoveFieldsTest extends TestCase
 {
+    protected function tearDown(): void
+    {
+        Configuration::$mode = null;
+    }
+
     #[TestDox('Update succeeds for PostgreSQL')]
     public function testUpdateSucceedsForPostgreSQL(): void
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
-            $this->assertEquals('UPDATE taco SET data = data - :names WHERE it = true',
+        $this->assertEquals('UPDATE taco SET data = data - :names::text[] WHERE it = true',
-                RemoveFields::update('taco', [':names' => "ARRAY['one','two']"], 'it = true'),
+            RemoveFields::update('taco', [':names' => "{one,two}"], 'it = true'), 'UPDATE statement not correct');
-                'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('Update succeeds for SQLite')]
     public function testUpdateSucceedsForSQLite(): void
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals('UPDATE burrito SET data = json_remove(data, :name0, :name1, :name2) WHERE a = b',
             RemoveFields::update('burrito', Parameters::fieldNames(':name', ['one', 'two', 'ten']), 'a = b'),
             'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     public function testUpdateFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         RemoveFields::update('wow', [], '');
     }
 
     #[TestDox('By ID succeeds for PostgreSQL')]
     public function testByIdSucceedsForPostgreSQL()
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
-            $this->assertEquals("UPDATE churro SET data = data - :bite WHERE data->>'id' = :id",
+        $this->assertEquals("UPDATE churro SET data = data - :bite::text[] WHERE data->>'id' = :id",
-                RemoveFields::byId('churro', Parameters::fieldNames(':bite', ['byte'])),
+            RemoveFields::byId('churro', Parameters::fieldNames(':bite', ['byte'])), 'UPDATE statement not correct');
-                'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By ID succeeds for SQLite')]
     public function testByIdSucceedsForSQLite()
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals("UPDATE quesadilla SET data = json_remove(data, :bite0) WHERE data->>'id' = :id",
             RemoveFields::byId('quesadilla', Parameters::fieldNames(':bite', ['byte'])),
             'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By ID fails when mode not set')]
     public function testByIdFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         RemoveFields::byId('oof', []);
     }
 
     #[TestDox('By fields succeeds for PostgreSQL')]
     public function testByFieldsSucceedsForPostgreSQL()
     {
-        try {
         Configuration::$mode = Mode::PgSQL;
-            $this->assertEquals("UPDATE enchilada SET data = data - :sauce WHERE data->>'cheese' = :queso",
+        $this->assertEquals("UPDATE enchilada SET data = data - :sauce::text[] WHERE data->>'cheese' = :queso",
             RemoveFields::byFields('enchilada', [Field::EQ('cheese', 'jack', ':queso')],
                 Parameters::fieldNames(':sauce', ['white'])),
             'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     #[TestDox('By fields succeeds for SQLite')]
     public function testByFieldsSucceedsForSQLite()
     {
-        try {
         Configuration::$mode = Mode::SQLite;
         $this->assertEquals(
             "UPDATE chimichanga SET data = json_remove(data, :filling0) WHERE data->>'side' = :rice",
             RemoveFields::byFields('chimichanga', [Field::EQ('side', 'beans', ':rice')],
                 Parameters::fieldNames(':filling', ['beef'])),
             'UPDATE statement not correct');
-        } finally {
-            Configuration::$mode = null;
-        }
     }
 
     public function testByFieldsFailsWhenModeNotSet(): void
     {
         $this->expectException(DocumentException::class);
-        Configuration::$mode = null;
         RemoveFields::byFields('boing', [], []);
     }
+
+    #[TestDox('By contains succeeds for PostgreSQL')]
+    public function testByContainsSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals('UPDATE food SET data = data - :drink::text[] WHERE data @> :criteria',
+            RemoveFields::byContains('food', Parameters::fieldNames(':drink', ['a', 'b'])),
+            'UPDATE statement not correct');
+    }
+
+    #[TestDox('By contains fails for non PostgreSQL')]
+    public function testByContainsFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        RemoveFields::byContains('', []);
+    }
+
+    #[TestDox('By JSON Path succeeds for PostgreSQL')]
+    public function testByJsonPathSucceedsForPostgreSQL(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        $this->assertEquals(
+            'UPDATE dessert SET data = data - :cake::text[] WHERE jsonb_path_exists(data, :path::jsonpath)',
+            RemoveFields::byJsonPath('dessert', Parameters::fieldNames(':cake', ['b', 'c'])),
+            'UPDATE statement not correct');
+    }
+
+    #[TestDox('By JSON Path fails for non PostgreSQL')]
+    public function testByJsonPathFailsForNonPostgreSQL(): void
+    {
+        $this->expectException(DocumentException::class);
+        RemoveFields::byJsonPath('', []);
+    }
 }

tests/unit/QueryTest.php

@@ -9,6 +9,7 @@ use PHPUnit\Framework\TestCase;
 /**
  * Unit tests for the Query class
  */
+#[TestDox('Query (Unit tests)')]
 class QueryTest extends TestCase
 {
     protected function setUp(): void
@@ -60,6 +61,68 @@ class QueryTest extends TestCase
         $this->assertEquals("data->>'id' = :di", Query::whereById(':di'), 'WHERE fragment not constructed correctly');
     }
 
+    public function testWhereDataContainsSucceedsWithDefaultParameter(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        try {
+            $this->assertEquals('data @> :criteria', Query::whereDataContains(),
+                'WHERE fragment not constructed correctly');
+        } finally {
+            Configuration::$mode = null;
+        }
+    }
+
+    public function testWhereDataContainsSucceedsWithSpecifiedParameter(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        try {
+            $this->assertEquals('data @> :it', Query::whereDataContains(':it'),
+                'WHERE fragment not constructed correctly');
+        } finally {
+            Configuration::$mode = null;
+        }
+    }
+
+    #[TestDox('Where data contains fails if not PostgreSQL')]
+    public function testWhereDataContainsFailsIfNotPostgreSQL(): void
+    {
+        Configuration::$mode = null;
+        $this->expectException(DocumentException::class);
+        Query::whereDataContains();
+    }
+
+    #[TestDox('Where JSON Path matches succeeds with default parameter')]
+    public function testWhereJsonPathMatchesSucceedsWithDefaultParameter(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        try {
+            $this->assertEquals('jsonb_path_exists(data, :path::jsonpath)', Query::whereJsonPathMatches(),
+                'WHERE fragment not constructed correctly');
+        } finally {
+            Configuration::$mode = null;
+        }
+    }
+
+    #[TestDox('Where JSON Path matches succeeds with specified parameter')]
+    public function testWhereJsonPathMatchesSucceedsWithSpecifiedParameter(): void
+    {
+        Configuration::$mode = Mode::PgSQL;
+        try {
+            $this->assertEquals('jsonb_path_exists(data, :road::jsonpath)', Query::whereJsonPathMatches(':road'),
+                'WHERE fragment not constructed correctly');
+        } finally {
+            Configuration::$mode = null;
+        }
+    }
+
+    #[TestDox('Where JSON Path matches fails if not PostgreSQL')]
+    public function testWhereJsonPathMatchesFailsIfNotPostgreSQL(): void
+    {
+        Configuration::$mode = null;
+        $this->expectException(DocumentException::class);
+        Query::whereJsonPathMatches();
+    }
+
     #[TestDox('Insert succeeds with no auto-ID for PostgreSQL')]
     public function testInsertSucceedsWithNoAutoIdForPostgreSQL(): void
     {
@@ -90,8 +153,8 @@ class QueryTest extends TestCase
         Configuration::$mode = Mode::PgSQL;
         try {
             $this->assertEquals(
-                "INSERT INTO test_tbl VALUES (:data || ('{\"id\":' "
+                "INSERT INTO test_tbl VALUES (:data::jsonb || ('{\"id\":' "
-                    . "|| (SELECT COALESCE(MAX(data->>'id'), 0) + 1 FROM test_tbl) || '}'))",
+                    . "|| (SELECT COALESCE(MAX((data->>'id')::numeric), 0) + 1 FROM test_tbl) || '}')::jsonb)",
                 Query::insert('test_tbl', AutoId::Number), 'INSERT statement not constructed correctly');
         } finally {
             Configuration::$mode = null;
@@ -118,7 +181,7 @@ class QueryTest extends TestCase
         Configuration::$mode = Mode::PgSQL;
         try {
             $query = Query::insert('test_tbl', AutoId::UUID);
-            $this->assertStringStartsWith("INSERT INTO test_tbl VALUES (:data || '{\"id\":\"", $query,
+            $this->assertStringStartsWith("INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"", $query,
                 'INSERT statement not constructed correctly');
             $this->assertStringEndsWith("\"}')", $query, 'INSERT statement not constructed correctly');
         } finally {
@@ -147,10 +210,10 @@ class QueryTest extends TestCase
         Configuration::$idStringLength = 8;
         try {
             $query = Query::insert('test_tbl', AutoId::RandomString);
-            $this->assertStringStartsWith("INSERT INTO test_tbl VALUES (:data || '{\"id\":\"", $query,
+            $this->assertStringStartsWith("INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"", $query,
                 'INSERT statement not constructed correctly');
             $this->assertStringEndsWith("\"}')", $query, 'INSERT statement not constructed correctly');
-            $id = str_replace(["INSERT INTO test_tbl VALUES (:data || '{\"id\":\"", "\"}')"], '', $query);
+            $id = str_replace(["INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"", "\"}')"], '', $query);
             $this->assertEquals(8, strlen($id), "Generated ID [$id] should have been 8 characters long");
         } finally {
             Configuration::$mode           = null;