Skip to content

Commit 31d366d

Browse files
Copilothotlong
andcommitted
Update documentation in redis driver to reflect FilterCondition format
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent b6530b4 commit 31d366d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/drivers/redis/src/index.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -378,9 +378,9 @@ export class RedisDriver implements Driver {
378378
* This method handles all read operations using the QueryAST format from @objectstack/spec.
379379
* It provides a standardized query interface that supports:
380380
* - Field selection (projection)
381-
* - Filter conditions (using FilterNode AST)
381+
* - Filter conditions (using FilterCondition format)
382382
* - Sorting
383-
* - Pagination (skip/top)
383+
* - Pagination (offset/limit)
384384
* - Grouping and aggregations (delegated to find)
385385
*
386386
* The method converts the QueryAST format to the legacy query format and delegates
@@ -639,22 +639,22 @@ export class RedisDriver implements Driver {
639639
// ========== Helper Methods ==========
640640

641641
/**
642-
* Convert FilterNode (QueryAST format) to legacy filter array format
642+
* Convert FilterCondition (MongoDB-like format) to legacy filter array format
643643
*
644-
* This method bridges the gap between the new QueryAST filter format (tree-based)
644+
* This method bridges the gap between the new FilterCondition format (MongoDB-style)
645645
* and the legacy array-based filter format used internally by the driver.
646646
*
647-
* QueryAST FilterNode format:
648-
* - type: 'comparison' | 'and' | 'or' | 'not'
649-
* - field, operator, value for comparisons
650-
* - children for logical operators
647+
* FilterCondition format (MongoDB-like):
648+
* - Field-level operators: { field: { $eq: value }, field2: { $gt: value } }
649+
* - Logical operators: { $and: [...], $or: [...], $not: {...} }
650+
* - Examples: { age: { $gt: 18 } }, { $and: [{ age: { $gt: 18 }}, { role: { $eq: 'user' }}] }
651651
*
652652
* Legacy format:
653653
* - Array of conditions: [field, operator, value]
654654
* - String separators: 'and', 'or'
655655
* - Example: [['age', '>', 18], 'and', ['role', '=', 'user']]
656656
*
657-
* @param node - The FilterNode to convert
657+
* @param condition - The FilterCondition to convert (object or legacy array)
658658
* @returns Legacy filter array format, or undefined if no filters
659659
* @private
660660
*

0 commit comments

Comments
 (0)