Mongo ttl index support

src/Database/Adapter.php

@@ -666,10 +666,12 @@ abstract public function renameIndex(string $collection, string $old, string $ne
      * @param array<int> $lengths
      * @param array<string> $orders
      * @param array<string,string> $indexAttributeTypes
+     * @param array<string, mixed> $collation
+     * @param int $ttl
      *
      * @return bool
      */
-    abstract public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = []): bool;
+    abstract public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool;
 
     /**
      * Delete Index
@@ -1483,4 +1485,14 @@ public function getSupportForRegex(): bool
     {
         return $this->getSupportForPCRERegex() || $this->getSupportForPOSIXRegex();
     }
+
+    /**
+     * Are ttl indexes supported?
+     *
+     * @return bool
+     */
+    public function getSupportTTLIndexes(): bool
+    {
+        return false;
+    }
 }

src/Database/Adapter/MariaDB.php

@@ -715,7 +715,7 @@ public function renameIndex(string $collection, string $old, string $new): bool
      * @return bool
      * @throws DatabaseException
      */
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool
     {
         $metadataCollection = new Document(['$id' => Database::METADATA]);
         $collection = $this->getDocument($metadataCollection, $collection);
@@ -2255,4 +2255,9 @@ public function getSupportForPOSIXRegex(): bool
     {
         return false;
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return false;
+    }
 }

src/Database/Adapter/Mongo.php

@@ -488,7 +488,7 @@ public function createCollection(string $name, array $attributes = [], array $in
                 $orders = $index->getAttribute('orders');
 
                 // If sharedTables, always add _tenant as the first key
-                if ($this->sharedTables) {
+                if ($this->sharedTables && $index->getAttribute('type') !== Database::INDEX_TTL) {
                     $key['_tenant'] = $this->getOrder(Database::ORDER_ASC);
                 }
 
@@ -508,6 +508,9 @@ public function createCollection(string $name, array $attributes = [], array $in
                             $order = $this->getOrder($this->filter($orders[$j] ?? Database::ORDER_ASC));
                             $unique = true;
                             break;
+                        case Database::INDEX_TTL:
+                            $order = $this->getOrder($this->filter($orders[$j] ?? Database::ORDER_ASC));
+                            break;
                         default:
                             // index not supported
                             return false;
@@ -526,6 +529,14 @@ public function createCollection(string $name, array $attributes = [], array $in
                     $newIndexes[$i]['default_language'] = 'none';
                 }
 
+                // Handle TTL indexes
+                if ($index->getAttribute('type') === Database::INDEX_TTL) {
+                    $ttl = $index->getAttribute('ttl', 0);
+                    if ($ttl > 0) {
+                        $newIndexes[$i]['expireAfterSeconds'] = $ttl;
+                    }
+                }
+
                 // Add partial filter for indexes to avoid indexing null values
                 if (in_array($index->getAttribute('type'), [
                     Database::INDEX_UNIQUE,
@@ -901,10 +912,11 @@ public function deleteRelationship(
      * @param array<string> $orders
      * @param array<string, string> $indexAttributeTypes
      * @param array<string, mixed> $collation
+     * @param int $ttl
      * @return bool
      * @throws Exception
      */
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool
     {
         $name = $this->getNamespace() . '_' . $this->filter($collection);
         $id = $this->filter($id);
@@ -913,7 +925,7 @@ public function createIndex(string $collection, string $id, string $type, array
         $indexes['name'] = $id;
 
         // If sharedTables, always add _tenant as the first key
-        if ($this->sharedTables) {
+        if ($this->sharedTables && $type !== Database::INDEX_TTL) {
             $indexes['key']['_tenant'] = $this->getOrder(Database::ORDER_ASC);
         }
 
@@ -933,6 +945,8 @@ public function createIndex(string $collection, string $id, string $type, array
                 case Database::INDEX_UNIQUE:
                     $indexes['unique'] = true;
                     break;
+                case Database::INDEX_TTL:
+                    break;
                 default:
                     return false;
             }
@@ -961,6 +975,11 @@ public function createIndex(string $collection, string $id, string $type, array
             $indexes['default_language'] = 'none';
         }
 
+        // Handle TTL indexes
+        if ($type === Database::INDEX_TTL && $ttl > 0) {
+            $indexes['expireAfterSeconds'] = $ttl;
+        }
+
         // Add partial filter for indexes to avoid indexing null values
         if (in_array($type, [Database::INDEX_UNIQUE, Database::INDEX_KEY])) {
             $partialFilter = [];
@@ -1073,7 +1092,7 @@ public function renameIndex(string $collection, string $old, string $new): bool
 
         try {
             $deletedindex = $this->deleteIndex($collection, $old);
-            $createdindex = $this->createIndex($collection, $new, $index['type'], $index['attributes'], $index['lengths'] ?? [], $index['orders'] ?? [], $indexAttributeTypes);
+            $createdindex = $this->createIndex($collection, $new, $index['type'], $index['attributes'], $index['lengths'] ?? [], $index['orders'] ?? [], $indexAttributeTypes, [], $index['ttl'] ?? 0);
         } catch (\Exception $e) {
             throw $this->processException($e);
         }
@@ -3395,4 +3414,9 @@ public function getSupportForTrigramIndex(): bool
     {
         return false;
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return true;
+    }
 }

src/Database/Adapter/MySQL.php

@@ -317,4 +317,9 @@ protected function getOperatorSQL(string $column, \Utopia\Database\Operator $ope
         // For all other operators, use parent implementation
         return parent::getOperatorSQL($column, $operator, $bindIndex);
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return false;
+    }
 }

src/Database/Adapter/Pool.php

@@ -210,7 +210,7 @@ public function renameIndex(string $collection, string $old, string $new): bool
         return $this->delegate(__FUNCTION__, \func_get_args());
     }
 
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool
     {
         return $this->delegate(__FUNCTION__, \func_get_args());
     }
@@ -649,4 +649,9 @@ public function getSupportForAlterLocks(): bool
     {
         return $this->delegate(__FUNCTION__, \func_get_args());
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return $this->delegate(__FUNCTION__, \func_get_args());
+    }
 }

src/Database/Adapter/Postgres.php

@@ -319,6 +319,7 @@ public function createCollection(string $name, array $attributes = [], array $in
                     }
                 }
                 $indexOrders = $index->getAttribute('orders', []);
+                $indexTtl = $index->getAttribute('ttl', 0);
                 if ($indexType === Database::INDEX_SPATIAL && count($indexOrders)) {
                     throw new DatabaseException('Spatial indexes with explicit orders are not supported. Remove the orders to create this index.');
                 }
@@ -329,7 +330,9 @@ public function createCollection(string $name, array $attributes = [], array $in
                     $indexAttributes,
                     [],
                     $indexOrders,
-                    $indexAttributesWithType
+                    $indexAttributesWithType,
+                    [],
+                    $indexTtl
                 );
             }
         } catch (PDOException $e) {
@@ -876,7 +879,7 @@ public function deleteRelationship(
 
      * @return bool
      */
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool
     {
         $collection = $this->filter($collection);
         $id = $this->filter($id);
@@ -2829,4 +2832,9 @@ protected function getSQLTable(string $name): string
 
         return "{$this->quote($this->getDatabase())}.{$this->quote($table)}";
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return false;
+    }
 }

src/Database/Adapter/SQLite.php

@@ -216,8 +216,9 @@ public function createCollection(string $name, array $attributes = [], array $in
                 $indexAttributes = $index->getAttribute('attributes', []);
                 $indexLengths = $index->getAttribute('lengths', []);
                 $indexOrders = $index->getAttribute('orders', []);
+                $indexTtl = $index->getAttribute('ttl', 0);
 
-                $this->createIndex($id, $indexId, $indexType, $indexAttributes, $indexLengths, $indexOrders);
+                $this->createIndex($id, $indexId, $indexType, $indexAttributes, $indexLengths, $indexOrders, [], [], $indexTtl);
             }
 
             $this->createIndex("{$id}_perms", '_index_1', Database::INDEX_UNIQUE, ['_document', '_type', '_permission'], [], []);
@@ -455,7 +456,7 @@ public function renameIndex(string $collection, string $old, string $new): bool
      * @throws Exception
      * @throws PDOException
      */
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths, array $orders, array $indexAttributeTypes = [], array $collation = [], int $ttl = 0): bool
     {
         $name = $this->filter($collection);
         $id = $this->filter($id);
@@ -1908,4 +1909,9 @@ public function getSupportForPOSIXRegex(): bool
     {
         return false;
     }
+
+    public function getSupportTTLIndexes(): bool
+    {
+        return false;
+    }
 }

src/Database/Database.php

@@ -86,6 +86,7 @@ class Database
     public const INDEX_HNSW_COSINE = 'hnsw_cosine';
     public const INDEX_HNSW_DOT = 'hnsw_dot';
     public const INDEX_TRIGRAM = 'trigram';
+    public const INDEX_TTL = 'ttl';
 
     // Max limits
     public const MAX_INT = 2147483647;
@@ -1648,6 +1649,7 @@ public function createCollection(string $id, array $attributes = [], array $inde
                 $this->adapter->getSupportForIndex(),
                 $this->adapter->getSupportForUniqueIndex(),
                 $this->adapter->getSupportForFulltextIndex(),
+                $this->adapter->getSupportTTLIndexes()
             );
             foreach ($indexes as $index) {
                 if (!$validator->isValid($index)) {
@@ -2798,6 +2800,7 @@ public function updateAttribute(string $collection, string $id, ?string $type =
                         $this->adapter->getSupportForIndex(),
                         $this->adapter->getSupportForUniqueIndex(),
                         $this->adapter->getSupportForFulltextIndex(),
+                        $this->adapter->getSupportTTLIndexes()
                     );
 
                     foreach ($indexes as $index) {
@@ -3603,6 +3606,7 @@ public function renameIndex(string $collection, string $old, string $new): bool
      * @param array<string> $attributes
      * @param array<int> $lengths
      * @param array<string> $orders
+     * @param int $ttl
      *
      * @return bool
      * @throws AuthorizationException
@@ -3613,14 +3617,13 @@ public function renameIndex(string $collection, string $old, string $new): bool
      * @throws StructureException
      * @throws Exception
      */
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths = [], array $orders = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths = [], array $orders = [], int $ttl = 0): bool
     {
         if (empty($attributes)) {
             throw new DatabaseException('Missing attributes');
         }
 
         $collection = $this->silent(fn () => $this->getCollection($collection));
-
         // index IDs are case-insensitive
         $indexes = $collection->getAttribute('indexes', []);
 
@@ -3671,6 +3674,7 @@ public function createIndex(string $collection, string $id, string $type, array
             'attributes' => $attributes,
             'lengths' => $lengths,
             'orders' => $orders,
+            'ttl' => $ttl
         ]);
 
         if ($this->validate) {
@@ -3693,6 +3697,7 @@ public function createIndex(string $collection, string $id, string $type, array
                 $this->adapter->getSupportForIndex(),
                 $this->adapter->getSupportForUniqueIndex(),
                 $this->adapter->getSupportForFulltextIndex(),
+                $this->adapter->getSupportTTLIndexes()
             );
             if (!$validator->isValid($index)) {
                 throw new IndexException($validator->getDescription());
@@ -3702,7 +3707,7 @@ public function createIndex(string $collection, string $id, string $type, array
         $collection->setAttribute('indexes', $index, Document::SET_TYPE_APPEND);
 
         try {
-            $created = $this->adapter->createIndex($collection->getId(), $id, $type, $attributes, $lengths, $orders, $indexAttributesWithTypes);
+            $created = $this->adapter->createIndex($collection->getId(), $id, $type, $attributes, $lengths, $orders, $indexAttributesWithTypes, [], $ttl);
 
             if (!$created) {
                 throw new DatabaseException('Failed to create index');

src/Database/Mirror.php

@@ -469,9 +469,9 @@ public function deleteAttribute(string $collection, string $id): bool
         return $result;
     }
 
-    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths = [], array $orders = []): bool
+    public function createIndex(string $collection, string $id, string $type, array $attributes, array $lengths = [], array $orders = [], int $ttl = 0): bool
     {
-        $result = $this->source->createIndex($collection, $id, $type, $attributes, $lengths, $orders);
+        $result = $this->source->createIndex($collection, $id, $type, $attributes, $lengths, $orders, $ttl);
 
         if ($this->destination === null) {
             return $result;
@@ -502,7 +502,8 @@ public function createIndex(string $collection, string $id, string $type, array
                 $document->getAttribute('type'),
                 $document->getAttribute('attributes'),
                 $document->getAttribute('lengths'),
-                $document->getAttribute('orders')
+                $document->getAttribute('orders'),
+                $document->getAttribute('ttl', 0)
             );
         } catch (\Throwable $err) {
             $this->logError('createIndex', $err);