Merge pull request #661 from ArnabChatterjee20k/spatial-attribute-support

Spatial attribute support

Author: abnegate

docker-compose.yml

@@ -30,7 +30,11 @@ services:
       - database
 
   postgres:
-    image: postgres:16.4
+    build:
+      context: .
+      dockerfile: postgres.dockerfile
+      args:
+        POSTGRES_VERSION: 16
     container_name: utopia-postgres
     networks:
       - database
@@ -39,9 +43,14 @@ services:
     environment:
       POSTGRES_USER: root
       POSTGRES_PASSWORD: password
+      POSTGRES_DB: root
 
   postgres-mirror:
-    image: postgres:16.4
+    build:
+      context: .
+      dockerfile: postgres.dockerfile
+      args:
+        POSTGRES_VERSION: 16
     container_name: utopia-postgres-mirror
     networks:
       - database
@@ -50,6 +59,7 @@ services:
     environment:
       POSTGRES_USER: root
       POSTGRES_PASSWORD: password
+      POSTGRES_DB: root
 
   mariadb:
     image: mariadb:10.11

postgres.dockerfile

@@ -0,0 +1,7 @@
+FROM postgres:16
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        postgresql-16-postgis-3 \
+        postgresql-16-postgis-3-scripts \
+    && rm -rf /var/lib/apt/lists/* 

src/Database/Adapter.php

@@ -534,7 +534,7 @@ abstract public function analyzeCollection(string $collection): bool;
      * @throws TimeoutException
      * @throws DuplicateException
      */
-    abstract public function createAttribute(string $collection, string $id, string $type, int $size, bool $signed = true, bool $array = false): bool;
+    abstract public function createAttribute(string $collection, string $id, string $type, int $size, bool $signed = true, bool $array = false, bool $required = false): bool;
 
     /**
      * Create Attributes
@@ -661,75 +661,75 @@ abstract public function deleteIndex(string $collection, string $id): bool;
     /**
      * Get Document
      *
-     * @param string $collection
+     * @param Document $collection
      * @param string $id
      * @param array<Query> $queries
      * @param bool $forUpdate
      * @return Document
      */
-    abstract public function getDocument(string $collection, string $id, array $queries = [], bool $forUpdate = false): Document;
+    abstract public function getDocument(Document $collection, string $id, array $queries = [], bool $forUpdate = false): Document;
 
     /**
      * Create Document
      *
-     * @param string $collection
+     * @param Document $collection
      * @param Document $document
      *
      * @return Document
      */
-    abstract public function createDocument(string $collection, Document $document): Document;
+    abstract public function createDocument(Document $collection, Document $document): Document;
 
     /**
      * Create Documents in batches
      *
-     * @param string $collection
+     * @param Document $collection
      * @param array<Document> $documents
      *
      * @return array<Document>
      *
      * @throws DatabaseException
      */
-    abstract public function createDocuments(string $collection, array $documents): array;
+    abstract public function createDocuments(Document $collection, array $documents): array;
 
     /**
      * Update Document
      *
-     * @param string $collection
+     * @param Document $collection
      * @param string $id
      * @param Document $document
      * @param bool $skipPermissions
      *
      * @return Document
      */
-    abstract public function updateDocument(string $collection, string $id, Document $document, bool $skipPermissions): Document;
+    abstract public function updateDocument(Document $collection, string $id, Document $document, bool $skipPermissions): Document;
 
     /**
      * Update documents
      *
      * Updates all documents which match the given query.
      *
-     * @param string $collection
+     * @param Document $collection
      * @param Document $updates
      * @param array<Document> $documents
      *
      * @return int
      *
      * @throws DatabaseException
      */
-    abstract public function updateDocuments(string $collection, Document $updates, array $documents): int;
+    abstract public function updateDocuments(Document $collection, Document $updates, array $documents): int;
 
     /**
      * Create documents if they do not exist, otherwise update them.
      *
      * If attribute is not empty, only the specified attribute will be increased, by the new value in each document.
      *
-     * @param string $collection
+     * @param Document $collection
      * @param string $attribute
      * @param array<Change> $changes
      * @return array<Document>
      */
     abstract public function createOrUpdateDocuments(
-        string $collection,
+        Document $collection,
         string $attribute,
         array $changes
     ): array;
@@ -767,7 +767,7 @@ abstract public function deleteDocuments(string $collection, array $sequences, a
      *
      * Find data sets using chosen queries
      *
-     * @param string $collection
+     * @param Document $collection
      * @param array<Query> $queries
      * @param int|null $limit
      * @param int|null $offset
@@ -776,10 +776,9 @@ abstract public function deleteDocuments(string $collection, array $sequences, a
      * @param array<string, mixed> $cursor
      * @param string $cursorDirection
      * @param string $forPermission
-     *
      * @return array<Document>
      */
-    abstract public function find(string $collection, array $queries = [], ?int $limit = 25, ?int $offset = null, array $orderAttributes = [], array $orderTypes = [], array $cursor = [], string $cursorDirection = Database::CURSOR_AFTER, string $forPermission = Database::PERMISSION_READ): array;
+    abstract public function find(Document $collection, array $queries = [], ?int $limit = 25, ?int $offset = null, array $orderAttributes = [], array $orderTypes = [], array $cursor = [], string $cursorDirection = Database::CURSOR_AFTER, string $forPermission = Database::PERMISSION_READ): array;
 
     /**
      * Sum an attribute
@@ -1029,6 +1028,34 @@ abstract public function getSupportForHostname(): bool;
      */
     abstract public function getSupportForBatchCreateAttributes(): bool;
 
+    /**
+     * Is spatial attributes supported?
+     *
+     * @return bool
+     */
+    abstract public function getSupportForSpatialAttributes(): bool;
+
+    /**
+     * Does the adapter support null values in spatial indexes?
+     *
+     * @return bool
+     */
+    abstract public function getSupportForSpatialIndexNull(): bool;
+
+    /**
+     * Does the adapter support order attribute in spatial indexes?
+     *
+     * @return bool
+     */
+    abstract public function getSupportForSpatialIndexOrder(): bool;
+
+    /**
+     * Does the adapter includes boundary during spatial contains?
+     *
+     * @return bool
+     */
+    abstract public function getSupportForBoundaryInclusiveContains(): bool;
+
     /**
      * Get current attribute count from collection document
      *