Skip to content

Adds QueryBuilder to MongoDBAtlasDocumentIndex #1891

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
JoanFM merged 5 commits into from
Jun 6, 2024
Merged

Adds QueryBuilder to MongoDBAtlasDocumentIndex #1891

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
937178b
Adds QueryBuilder to MongoDBAtlasDocumentIndex
caseyclements Jun 3, 2024
270604b
Formatting
caseyclements Jun 3, 2024
38c8668
Formatting tests
caseyclements Jun 3, 2024
a2adb53
Remove todo
caseyclements Jun 5, 2024
118dd8c
raise from to provide more context to failures in Atlas testing
caseyclements Jun 5, 2024
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
39 changes: 38 additions & 1 deletion docarray/index/backends/helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Any, Dict, List, Tuple, Type, cast
from typing import Any, Dict, List, Tuple, Type, cast, Set

from docarray import BaseDoc, DocList
from docarray.index.abstract import BaseDocIndex
Expand All @@ -20,6 +20,43 @@ def inner(self, *args, **kwargs):
return inner


def _collect_query_required_args(method_name: str, required_args: Set[str] = None):
"""
Returns a function that ensures required keyword arguments are provided.

:param method_name: The name of the method for which the required arguments are being checked.
:type method_name: str
:param required_args: A set containing the names of required keyword arguments. Defaults to None.
:type required_args: Optional[Set[str]]
:return: A function that checks for required keyword arguments before executing the specified method.
Raises ValueError if positional arguments are provided.
Raises TypeError if any required keyword argument is missing.
:rtype: Callable
"""

if required_args is None:
required_args = set()

def inner(self, *args, **kwargs):
if args:
raise ValueError(
f"Positional arguments are not supported for "
f"`{type(self)}.{method_name}`. "
f"Use keyword arguments instead."
)

missing_args = required_args - set(kwargs.keys())
if missing_args:
raise ValueError(
f"`{type(self)}.{method_name}` is missing required argument(s): {', '.join(missing_args)}"
)

updated_query = self._queries + [(method_name, kwargs)]
return type(self)(updated_query)

return inner


def _execute_find_and_filter_query(
doc_index: BaseDocIndex, query: List[Tuple[str, Dict]], reverse_order: bool = False
) -> FindResult:
Expand Down
Loading