Skip to content

docs: add explanation about id field #1242

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
JohannesMessner merged 2 commits into from
Mar 20, 2023
Merged

docs: add explanation about id field #1242

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d39952
docs: add explanation about id field
JohannesMessner Mar 15, 2023
ce7ec8d
docs: update docs/tutorials/add_doc_index.md
JohannesMessner Mar 20, 2023
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
5 changes: 5 additions & 0 deletions docs/tutorials/add_doc_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,11 @@ helper method. Inside of `_index()` you can use this to transform `column_to_dat
**If your backend has native nesting capabilities:** You can also ignore most of the above, and implement the public `index()` method directly.
That way you have full control over whether the input data gets flattened or not.

**The `.id` field:** Every Document has an `.id` field, which is intended to act as a unique identifier or primary key
in your backend, if such a concepts exists in your case. In your implementation you can assume that `.id`s are **unique** and **non-empty**.
(Strictly speaking, this uniqueness property is not guaranteed, since a user could override the auto-generated `.id` field with a custom value.
If your implementation encounters a duplicate `.id`, it is okay to fail and raise an Exception.)

## Implement a Query Builder for your Document Index

Every Document Index exposes a Query Builder interface which the user can use to build composed, hybrid queries.
Expand Down