Skip to content

Commit 8200d3d

Browse files
committed
Docs update
1 parent 972c5d9 commit 8200d3d

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ NOTE: Rule complexity is limited by the querying capabilities of the backend.
5353

5454
### DynamoDB
5555

56-
`query(query_expr: Optional[Rule], filter_expr: Optional[Rule])` - Providing a
57-
`query_expr` parameter will try to apply the keys of the expression to an
58-
existing index. Providing a `filter_expr` parameter will filter the results of
56+
`query(query_expr: Optional[Rule], filter_expr: Optional[Rule], limit: Optional[str], exclusive_start_key: Optional[tuple[Any]], order: str = 'asc'`
57+
- Providing a `query_expr` parameter will try to apply the keys of the expression to an
58+
existing index.
59+
- Providing a `filter_expr` parameter will filter the results of
5960
a passed `query_expr` or run a dynamodb `scan` if no `query_expr` is passed.
60-
An empty call to `query()` will return the scan results (and be resource
61+
- An empty call to `query()` will return the scan results (and be resource
6162
intensive).
63+
- Providing a `limit` parameter will limit the number of results. If more results remain, the returned dataset will have an `last_evaluated_key` property that can be passed to `exclusive_start_key` to continue with the next page.
64+
- Providing `order='desc'` will return the result set in descending order. This is not available for query calls that "scan" dynamodb.
6265

6366
## Backend Configuration Members
6467

pydanticrud/backends/dynamodb.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ def query(self,
295295
query_expr: Optional[Rule] = None,
296296
filter_expr: Optional[Rule] = None,
297297
limit: Optional[int] = None,
298-
exclusive_start_key: Optional[Dict[str, Any]] = None,
298+
exclusive_start_key: Optional[tuple[Any]] = None,
299299
order: str = 'asc',
300300
):
301301
table = self.get_table()

0 commit comments

Comments
 (0)