Skip to content

Update secondary index guide #154

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update secondary index guide #154

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed3fb38
Update secondary index guide
jsimnz Feb 28, 2025
3a3ca6f
Relationship cardinality fix
jsimnz Feb 28, 2025
571b7ec
side bar title case
jsimnz Feb 28, 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
10 changes: 6 additions & 4 deletions docs/defradb/guides/secondary-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
---
sidebar_label: Secondary index guide
sidebar_label: Secondary Index Guide
sidebar_position: 80
---

# Secondary Indexes

## Introduction

DefraDB provides a powerful and flexible secondary indexing system that enables efficient document lookups and queries.
Expand Down Expand Up @@ -73,7 +75,7 @@ query {
- Retrieve the corresponding User documents. This method is much faster because indexes enable direct lookups.

#### Enforcing relationship cardinality
Indexes can also enforce one-to-one relationships. For instance, to ensure each User has exactly one unique Address:
Indexes can also enforce one-to-one relationships. For instance, to ensure each Address has exactly one unique User:

```graphql
type User {
Expand Down Expand Up @@ -103,7 +105,7 @@ JSON fields differ from other field types (e.g., Int, String, Bool) because they

#### JSON Interface

DefraDB's JSON interface, defined in client/json.go, is essential for managing JSON fields. It allows the system to:
DefraDB's JSON interface, defined in [`client/json.go`](https://github.com/sourcenetwork/defradb/blob/master/client/json.go), is essential for managing JSON fields. It allows the system to:

Traverse all leaf nodes in a JSON document.
Represent a JSON value as either a complete document or a single node within the structure.
Expand Down Expand Up @@ -157,7 +159,7 @@ When indexing a document with JSON fields, the system:
##### Query example
Retrieve documents where the model is "iPhone":

```
```graphql
query {
Collection(filter: {
jsonField: {
Expand Down