Skip to content

add support for sort in collection.find function #359

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
merged 7 commits into from
Jan 31, 2025
Merged

add support for sort in collection.find function #359

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
32cdc62
add support for sort in collection.find function
Jan 26, 2025
107df52
update sort parameter type. add SortValidationError as custom exception
Jan 30, 2025
1149f01
Update arango/collection.py
denizalpaslan Jan 30, 2025
df2ab2f
Update arango/collection.py
denizalpaslan Jan 30, 2025
71776c3
update utils.py and collection.py to raise SortValidationError
Jan 30, 2025
856743a
update utils.py for build_sort_expression to accept Jsons or None
Jan 30, 2025
bedc4d4
Update arango/collection.py
apetenchea Jan 31, 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
Prev Previous commit
Next Next commit
update sort parameter type. add SortValidationError as custom exception
  • Loading branch information
Deniz Alpaslan committed Jan 30, 2025
commit 107df529b51c9905a7ce9ec0dd31787d5182da96
5 changes: 4 additions & 1 deletion arango/collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,7 @@ def all(
:return: Document cursor.
:rtype: arango.cursor.Cursor
:raise arango.exceptions.DocumentGetError: If retrieval fails.
:raise arango.exceptions.SortValidationError: If sort parameters are invalid.
"""
assert is_none_or_int(skip), "skip must be a non-negative int"
assert is_none_or_int(limit), "limit must be a non-negative int"
Expand Down Expand Up @@ -755,7 +756,7 @@ def find(
skip: Optional[int] = None,
limit: Optional[int] = None,
allow_dirty_read: bool = False,
sort: Sequence[Json] = [],
sort: Jsons = [],
) -> Result[Cursor]:
"""Return all documents that match the given filters.

Expand All @@ -767,6 +768,8 @@ def find(
:type limit: int | None
:param allow_dirty_read: Allow reads from followers in a cluster.
:type allow_dirty_read: bool
:param sort: Document sort parameters
:type sort: Jsons
:return: Document cursor.
:rtype: arango.cursor.Cursor
:raise arango.exceptions.DocumentGetError: If retrieval fails.
Expand Down
7 changes: 7 additions & 0 deletions arango/exceptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1074,3 +1074,10 @@ class JWTRefreshError(ArangoClientError):

class JWTExpiredError(ArangoClientError):
"""JWT token has expired."""


###################################
# Parameter Validation Exceptions #
###################################
class SortValidationError(ArangoClientError):
"""Invalid sort parameters."""
6 changes: 3 additions & 3 deletions arango/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from typing import Any, Iterator, Sequence, Union

from arango.exceptions import DocumentParseError
from arango.typings import Json
from arango.typings import Json, Jsons


@contextmanager
Expand Down Expand Up @@ -148,11 +148,11 @@ def validate_sort_parameters(sort: Sequence[Json]) -> bool:
return True


def build_sort_expression(sort: Sequence[Json]) -> str:
def build_sort_expression(sort: Jsons) -> str:
"""Build a sort condition for an AQL query.

:param sort: Document sort parameters.
:type sort: Sequence[Json]
:type sort: Jsons
:return: The complete AQL sort condition.
:rtype: str
"""
Expand Down
Loading