Skip to content

Add date-based query helpers for createdAt and updatedAt #653

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

Merged
abnegate merged 2 commits into from
Aug 7, 2025
Merged

Add date-based query helpers for createdAt and updatedAt #653

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
c3e29c5
Add date-based query helpers for createdAt and updatedAt
cursoragent Aug 7, 2025
c7975f9
Change parameter name from $isoDateString to $value for consistency
cursoragent Aug 7, 2025
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
44 changes: 44 additions & 0 deletions src/Database/Query.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,50 @@ public static function notEndsWith(string $attribute, string $value): self
return new self(self::TYPE_NOT_ENDS_WITH, $attribute, [$value]);
}

/**
* Helper method to create Query for documents created before a specific date
*
* @param string $value
* @return Query
*/
public static function createdBefore(string $value): self
{
return self::lessThan('$createdAt', $value);
}

/**
* Helper method to create Query for documents created after a specific date
*
* @param string $value
* @return Query
*/
public static function createdAfter(string $value): self
{
return self::greaterThan('$createdAt', $value);
}

/**
* Helper method to create Query for documents updated before a specific date
*
* @param string $value
* @return Query
*/
public static function updatedBefore(string $value): self
{
return self::lessThan('$updatedAt', $value);
}

/**
* Helper method to create Query for documents updated after a specific date
*
* @param string $value
* @return Query
*/
public static function updatedAfter(string $value): self
{
return self::greaterThan('$updatedAt', $value);
}

/**
* @param array<Query> $queries
* @return Query
Expand Down
104 changes: 104 additions & 0 deletions tests/e2e/Adapter/Scopes/DocumentTests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2644,6 +2644,110 @@ public function testFindOrderByUpdateDateAndCursor(): void
$this->assertEquals($documentsTest[1]['$id'], $documents[0]['$id']);
}

public function testFindCreatedBefore(): void
{
/** @var Database $database */
$database = static::getDatabase();

/**
* Test Query::createdBefore wrapper
*/
$futureDate = '2050-01-01T00:00:00.000Z';
$pastDate = '1900-01-01T00:00:00.000Z';

$documents = $database->find('movies', [
Query::createdBefore($futureDate),
Query::limit(1)
]);

$this->assertGreaterThan(0, count($documents));

$documents = $database->find('movies', [
Query::createdBefore($pastDate),
Query::limit(1)
]);

$this->assertEquals(0, count($documents));
}

public function testFindCreatedAfter(): void
{
/** @var Database $database */
$database = static::getDatabase();

/**
* Test Query::createdAfter wrapper
*/
$futureDate = '2050-01-01T00:00:00.000Z';
$pastDate = '1900-01-01T00:00:00.000Z';

$documents = $database->find('movies', [
Query::createdAfter($pastDate),
Query::limit(1)
]);

$this->assertGreaterThan(0, count($documents));

$documents = $database->find('movies', [
Query::createdAfter($futureDate),
Query::limit(1)
]);

$this->assertEquals(0, count($documents));
}

public function testFindUpdatedBefore(): void
{
/** @var Database $database */
$database = static::getDatabase();

/**
* Test Query::updatedBefore wrapper
*/
$futureDate = '2050-01-01T00:00:00.000Z';
$pastDate = '1900-01-01T00:00:00.000Z';

$documents = $database->find('movies', [
Query::updatedBefore($futureDate),
Query::limit(1)
]);

$this->assertGreaterThan(0, count($documents));

$documents = $database->find('movies', [
Query::updatedBefore($pastDate),
Query::limit(1)
]);

$this->assertEquals(0, count($documents));
}

public function testFindUpdatedAfter(): void
{
/** @var Database $database */
$database = static::getDatabase();

/**
* Test Query::updatedAfter wrapper
*/
$futureDate = '2050-01-01T00:00:00.000Z';
$pastDate = '1900-01-01T00:00:00.000Z';

$documents = $database->find('movies', [
Query::updatedAfter($pastDate),
Query::limit(1)
]);

$this->assertGreaterThan(0, count($documents));

$documents = $database->find('movies', [
Query::updatedAfter($futureDate),
Query::limit(1)
]);

$this->assertEquals(0, count($documents));
}

public function testFindLimit(): void
{
/** @var Database $database */
Expand Down
46 changes: 46 additions & 0 deletions tests/unit/QueryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,31 @@ public function testCreate(): void
$this->assertEquals(Query::TYPE_NOT_BETWEEN, $query->getMethod());
$this->assertEquals('score', $query->getAttribute());
$this->assertEquals([10, 20], $query->getValues());

// Test new date query wrapper methods
$query = Query::createdBefore('2023-01-01T00:00:00.000Z');

$this->assertEquals(Query::TYPE_LESSER, $query->getMethod());
$this->assertEquals('$createdAt', $query->getAttribute());
$this->assertEquals(['2023-01-01T00:00:00.000Z'], $query->getValues());

$query = Query::createdAfter('2023-01-01T00:00:00.000Z');

$this->assertEquals(Query::TYPE_GREATER, $query->getMethod());
$this->assertEquals('$createdAt', $query->getAttribute());
$this->assertEquals(['2023-01-01T00:00:00.000Z'], $query->getValues());

$query = Query::updatedBefore('2023-12-31T23:59:59.999Z');

$this->assertEquals(Query::TYPE_LESSER, $query->getMethod());
$this->assertEquals('$updatedAt', $query->getAttribute());
$this->assertEquals(['2023-12-31T23:59:59.999Z'], $query->getValues());

$query = Query::updatedAfter('2023-12-31T23:59:59.999Z');

$this->assertEquals(Query::TYPE_GREATER, $query->getMethod());
$this->assertEquals('$updatedAt', $query->getAttribute());
$this->assertEquals(['2023-12-31T23:59:59.999Z'], $query->getValues());
}

/**
Expand Down Expand Up @@ -225,6 +250,27 @@ public function testParse(): void
$this->assertEquals(null, $query->getAttribute());
$this->assertEquals(['title', 'director'], $query->getValues());

// Test new date query wrapper methods parsing
$query = Query::parse(Query::createdBefore('2023-01-01T00:00:00.000Z')->toString());
$this->assertEquals('lessThan', $query->getMethod());
$this->assertEquals('$createdAt', $query->getAttribute());
$this->assertEquals(['2023-01-01T00:00:00.000Z'], $query->getValues());

$query = Query::parse(Query::createdAfter('2023-01-01T00:00:00.000Z')->toString());
$this->assertEquals('greaterThan', $query->getMethod());
$this->assertEquals('$createdAt', $query->getAttribute());
$this->assertEquals(['2023-01-01T00:00:00.000Z'], $query->getValues());

$query = Query::parse(Query::updatedBefore('2023-12-31T23:59:59.999Z')->toString());
$this->assertEquals('lessThan', $query->getMethod());
$this->assertEquals('$updatedAt', $query->getAttribute());
$this->assertEquals(['2023-12-31T23:59:59.999Z'], $query->getValues());

$query = Query::parse(Query::updatedAfter('2023-12-31T23:59:59.999Z')->toString());
$this->assertEquals('greaterThan', $query->getMethod());
$this->assertEquals('$updatedAt', $query->getAttribute());
$this->assertEquals(['2023-12-31T23:59:59.999Z'], $query->getValues());

$query = Query::parse(Query::between('age', 15, 18)->toString());
$this->assertEquals('between', $query->getMethod());
$this->assertEquals('age', $query->getAttribute());
Expand Down