Merge pull request #9870 from appwrite/feat-expose-sequence

Feat expose sequence
This commit is contained in:
Jake Barnby 2025-05-27 02:40:47 +00:00 committed by GitHub
commit 4ffa89fe35
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 31 additions and 7 deletions

View file

@ -36,6 +36,12 @@ class Document extends Any
'default' => '',
'example' => '5e5ea5c16897e',
])
->addRule('$sequence', [
'type' => self::TYPE_INTEGER,
'description' => 'Document automatically incrementing ID.',
'default' => 0,
'example' => 1,
])
->addRule('$collectionId', [
'type' => self::TYPE_STRING,
'description' => 'Collection ID.',
@ -71,7 +77,6 @@ class Document extends Any
public function filter(DatabaseDocument $document): DatabaseDocument
{
$document->removeAttribute('$sequence');
$document->removeAttribute('$collection');
$document->removeAttribute('$tenant');

View file

@ -1645,6 +1645,7 @@ trait DatabasesBase
$this->assertEquals($document1['body']['actors'][0], 'Chris Evans');
$this->assertEquals($document1['body']['actors'][1], 'Samuel Jackson');
$this->assertEquals($document1['body']['birthDay'], '1975-06-12T12:12:55.000+00:00');
$this->assertTrue(array_key_exists('$sequence', $document1['body']));
$this->assertEquals(201, $document2['headers']['status-code']);
$this->assertEquals($data['moviesId'], $document2['body']['$collectionId']);
@ -1662,6 +1663,7 @@ trait DatabasesBase
$this->assertEquals($document2['body']['birthDay'], null);
$this->assertEquals($document2['body']['integers'][0], 50);
$this->assertEquals($document2['body']['integers'][1], 60);
$this->assertTrue(array_key_exists('$sequence', $document2['body']));
$this->assertEquals(201, $document3['headers']['status-code']);
$this->assertEquals($data['moviesId'], $document3['body']['$collectionId']);
@ -1676,6 +1678,7 @@ trait DatabasesBase
$this->assertEquals($document3['body']['actors'][0], 'Tom Holland');
$this->assertEquals($document3['body']['actors'][1], 'Zendaya Maree Stoermer');
$this->assertEquals($document3['body']['birthDay'], '1975-06-12T18:12:55.000+00:00'); // UTC for NY
$this->assertTrue(array_key_exists('$sequence', $document3['body']));
$this->assertEquals(400, $document4['headers']['status-code']);
@ -2003,9 +2006,9 @@ trait DatabasesBase
$this->assertEquals(1944, $documents['body']['documents'][0]['releaseYear']);
$this->assertEquals(2017, $documents['body']['documents'][1]['releaseYear']);
$this->assertEquals(2019, $documents['body']['documents'][2]['releaseYear']);
$this->assertFalse(array_key_exists('$sequence', $documents['body']['documents'][0]));
$this->assertFalse(array_key_exists('$sequence', $documents['body']['documents'][1]));
$this->assertFalse(array_key_exists('$sequence', $documents['body']['documents'][2]));
$this->assertTrue(array_key_exists('$sequence', $documents['body']['documents'][0]));
$this->assertTrue(array_key_exists('$sequence', $documents['body']['documents'][1]));
$this->assertTrue(array_key_exists('$sequence', $documents['body']['documents'][2]));
$this->assertCount(3, $documents['body']['documents']);
foreach ($documents['body']['documents'] as $document) {
@ -2098,7 +2101,7 @@ trait DatabasesBase
$this->assertEquals($response['body']['releaseYear'], $document['releaseYear']);
$this->assertEquals($response['body']['$permissions'], $document['$permissions']);
$this->assertEquals($response['body']['birthDay'], $document['birthDay']);
$this->assertFalse(array_key_exists('$sequence', $response['body']));
$this->assertTrue(array_key_exists('$sequence', $response['body']));
$this->assertFalse(array_key_exists('$tenant', $response['body']));
}
}
@ -2124,6 +2127,22 @@ trait DatabasesBase
$this->assertEquals($document['title'], $response['body']['title']);
$this->assertEquals($document['releaseYear'], $response['body']['releaseYear']);
$this->assertArrayNotHasKey('birthDay', $response['body']);
$sequence = $response['body']['$sequence'];
// Query by sequence
$response = $this->client->call(Client::METHOD_GET, '/databases/' . $databaseId . '/collections/' . $document['$collectionId'] . '/documents/' . $document['$id'], array_merge([
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
], $this->getHeaders()), [
'queries' => [
Query::equal('$sequence', [$sequence])
],
]);
$this->assertEquals(200, $response['headers']['status-code']);
$this->assertEquals($document['title'], $response['body']['title']);
$this->assertEquals($document['releaseYear'], $response['body']['releaseYear']);
$this->assertTrue(array_key_exists('$sequence', $response['body']));
}
/**
@ -4361,8 +4380,8 @@ trait DatabasesBase
$this->assertArrayNotHasKey('$collection', $person1['body']);
$this->assertArrayNotHasKey('$collection', $person1['body']['library']);
$this->assertArrayNotHasKey('$sequence', $person1['body']);
$this->assertArrayNotHasKey('$sequence', $person1['body']['library']);
$this->assertArrayHasKey('$sequence', $person1['body']);
$this->assertArrayHasKey('$sequence', $person1['body']['library']);
$documents = $this->client->call(Client::METHOD_GET, '/databases/' . $databaseId . '/collections/' . $person['body']['$id'] . '/documents', array_merge([
'content-type' => 'application/json',