Skip to content

Commit b6d23cb

Browse files
Tim FarrellTim Farrell
authored andcommitted
Add documentation
1 parent 9c1f0c8 commit b6d23cb

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ NOTE: Rule complexity is limited by the querying capabilities of the backend.
7272
- 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.
7373
- Providing `order='desc'` will return the result set in descending order. This is not available for query calls that "scan" dynamodb.
7474

75+
`count(query_expr: Optional[Rule], exclusive_start_key: Optional[tuple[Any]], order: str = 'asc'`
76+
- Same as `query` but returns an integer count as total. (When calling `query` with a limit, the count dynamodb returns is <= the limit you provide)
77+
78+
7579
## Backend Configuration Members
7680

7781
`hash_key` - the name of the key field for the backend table

0 commit comments

Comments
 (0)