Skip to content

Commit

Permalink
docs: add to store guide
Browse files Browse the repository at this point in the history
  • Loading branch information
rkingsbury committed Jul 1, 2024
1 parent 036ff63 commit 8454489
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/getting_started/stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ like using the `key` argument when you instantiate a `Store`.
data = [{"task_id": 1, "AM": "sunrise"}, {"task_id: 2, "PM": "sunset"} ... ]
```

Just to emphasize - **every document must have a `task_id`, and the value of `task_id` must be unique for every document**. The rest of the document structure
is up to you, but `maggma` works best when every document follows a pre-defined
schema (i.e., all `dict` have the same set of keys / same structure).

## The `Store` interface

All `Store` provide a number of basic methods that facilitate querying, updating, and removing data:
Expand Down

0 comments on commit 8454489

Please sign in to comment.