Skip to content

docs: add note that query syntax is docstore dependant #586

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 1 commit into from
Oct 4, 2022
Merged

docs: add note that query syntax is docstore dependant #586

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions docs/fundamentals/documentarray/find.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ We can use {meth}`~docarray.array.mixins.find.FindMixin.find` to select Document
- To filter Documents, the `query` object is a Python dictionary object that defines the filtering conditions using a [MongoDB](https://docs.mongodb.com/manual/reference/operator/query/)-like query language.
- To find nearest neighbours, the `query` object needs to be a NdArray-like, a Document, or a DocumentArray object that defines embedding. One can also use `.match()` function for this purpose, and there is a minor interface difference between these two functions, which will be described {ref}`in the next chapter<match-documentarray>`.

```{admonition} filter query syntax
:class: note

The syntax to define filter queries is dependant of the {ref}`Document store <doc-store>` used. Some will have their own query language
depending on the supporting backend.
```

Let's see some examples in action. First, let's prepare a DocumentArray we will use.

```python
Expand Down