Skip to content

Fix createIndex for sequence #944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fogelito wants to merge 2 commits into
base: main
Choose a base branch
from
+168 −12
Open

Fix createIndex for sequence #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c60b4d3
Postgres IndexTests.php
fogelito Aug 23, 2026
fb699e2
Merge branch 'main' of github.com:utopia-php/database into index-sequ…
fogelito Aug 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions src/Database/Adapter/Postgres.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -875,12 +875,8 @@ public function createIndex(string $collection, string $id, string $type, array
if ($isNestedPath) {
$attributes[$i] = $this->buildJsonbPath($attr, true) . ($order ? " {$order}" : '');
} else {
$attr = match ($attr) {
'$id' => '_uid',
'$createdAt' => '_createdAt',
'$updatedAt' => '_updatedAt',
default => $this->filter($attr),
};
$attr = $this->getInternalKeyForAttribute($attr);
$attr = $this->filter($attr);

$attributes[$i] = "\"{$attr}\" {$order}";
}
Expand Down
7 changes: 1 addition & 6 deletions src/Database/Adapter/SQLite.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1667,12 +1667,7 @@ protected function getSQLIndex(string $collection, string $id, string $type, arr
throw new DatabaseException('Unknown index type: ' . $type . '. Must be one of ' . Database::INDEX_KEY . ', ' . Database::INDEX_UNIQUE . ', ' . Database::INDEX_FULLTEXT);
}

$attributes = \array_map(fn ($attribute) => match ($attribute) {
'$id' => ID::custom('_uid'),
'$createdAt' => '_createdAt',
'$updatedAt' => '_updatedAt',
default => $attribute
}, $attributes);
$attributes = \array_map(fn ($attribute) => $this->getInternalKeyForAttribute($attribute), $attributes);

foreach ($attributes as $key => $attribute) {
$attribute = $this->filter($attribute);
Expand Down
165 changes: 165 additions & 0 deletions tests/e2e/Adapter/Scopes/IndexTests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,171 @@ public function testIndexValidation(): void
}
}

public function testCreateCollectionWithIndexOnSequence(): void
{
/** @var Database $database */
$database = $this->getDatabase();

if (!$database->getAdapter()->getSupportForIndex()) {
$this->expectNotToPerformAssertions();
return;
}

$collection = $database->createCollection('sequenceIndexes', [
new Document([
'$id' => ID::custom('username'),
'type' => Database::VAR_STRING,
'size' => 128,
'required' => false,
'signed' => true,
'array' => false,
'filters' => [],
]),
new Document([
'$id' => ID::custom('email'),
'type' => Database::VAR_STRING,
'size' => 128,
'required' => false,
'signed' => true,
'array' => false,
'filters' => [],
]),
], [
new Document([
'$id' => ID::custom('_index 123'),
'type' => Database::INDEX_KEY,
'attributes' => ['username', '$sequence'],
'lengths' => [],
'orders' => [Database::ORDER_ASC, Database::ORDER_DESC],
]),
new Document([
'$id' => ID::custom('_index 456'),
'type' => Database::INDEX_UNIQUE,
'attributes' => ['email', '$sequence'],
'lengths' => [],
'orders' => [Database::ORDER_ASC, Database::ORDER_DESC],
]),
]);

$indexes = $collection->getAttribute('indexes');
$this->assertCount(2, $indexes);
$this->assertEquals('_index 123', $indexes[0]->getId());
$this->assertEquals(['username', '$sequence'], $indexes[0]->getAttribute('attributes'));
$this->assertEquals('_index 456', $indexes[1]->getId());
$this->assertEquals(['email', '$sequence'], $indexes[1]->getAttribute('attributes'));

$database->createDocument('sequenceIndexes', new Document([
'$permissions' => [
Permission::read(Role::any()),
],
'username' => 'chester',
'email' => 'chester@example.com',
]));

$documents = $database->find('sequenceIndexes', [
Query::equal('username', ['chester']),
Query::orderDesc('$sequence'),
]);

$this->assertCount(1, $documents);
$this->assertEquals('chester', $documents[0]->getAttribute('username'));

/**
* $sequence is unique on its own, so a unique index containing it never
* conflicts. A duplicate here would mean the adapter built the index
* without the $sequence column.
*/
$database->createDocument('sequenceIndexes', new Document([
'$permissions' => [
Permission::read(Role::any()),
],
'username' => 'chester',
'email' => 'chester@example.com',
]));

$this->assertCount(2, $database->find('sequenceIndexes', [
Query::equal('email', ['chester@example.com']),
]));

$database->deleteCollection('sequenceIndexes');
}

public function testCreateIndexOnSequence(): void
{
/** @var Database $database */
$database = $this->getDatabase();

if (!$database->getAdapter()->getSupportForIndex()) {
$this->expectNotToPerformAssertions();
return;
}

$database->createCollection(__FUNCTION__);

$this->assertTrue($database->createAttribute(__FUNCTION__, 'username', Database::VAR_STRING, 128, false));
$this->assertTrue($database->createAttribute(__FUNCTION__, 'email', Database::VAR_STRING, 128, false));

$this->assertTrue($database->createIndex(
__FUNCTION__,
'_index 123',
Database::INDEX_KEY,
['username', '$sequence'],
[],
[Database::ORDER_ASC, Database::ORDER_DESC]
));

$this->assertTrue($database->createIndex(
__FUNCTION__,
'_index 456',
Database::INDEX_UNIQUE,
['email', '$sequence'],
[],
[Database::ORDER_ASC, Database::ORDER_DESC]
));

$indexes = $database->getCollection(__FUNCTION__)->getAttribute('indexes');
$this->assertCount(2, $indexes);
$this->assertEquals('_index 123', $indexes[0]->getId());
$this->assertEquals(['username', '$sequence'], $indexes[0]->getAttribute('attributes'));
$this->assertEquals('_index 456', $indexes[1]->getId());
$this->assertEquals(['email', '$sequence'], $indexes[1]->getAttribute('attributes'));

$database->createDocument(__FUNCTION__, new Document([
'$permissions' => [
Permission::read(Role::any()),
],
'username' => 'chester',
'email' => 'chester@example.com',
]));

$documents = $database->find(__FUNCTION__, [
Query::equal('username', ['chester']),
Query::orderDesc('$sequence'),
]);

$this->assertCount(1, $documents);
$this->assertEquals('chester', $documents[0]->getAttribute('username'));

/**
* $sequence is unique on its own, so a unique index containing it never
* conflicts. A duplicate here would mean the adapter built the index
* without the $sequence column.
*/
$database->createDocument(__FUNCTION__, new Document([
'$permissions' => [
Permission::read(Role::any()),
],
'username' => 'chester',
'email' => 'chester@example.com',
]));

$this->assertCount(2, $database->find(__FUNCTION__, [
Query::equal('email', ['chester@example.com']),
]));

$database->deleteCollection(__FUNCTION__);
}

public function testIndexLengthZero(): void
{
/** @var Database $database */
Expand Down
Loading