Skip to content

Commit

Permalink
extra docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josephjclark committed Dec 11, 2024
1 parent e4fee1b commit 19952a4
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/build/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,20 @@ uploaded to a collection using the CLI.

## Collections Basics

Data is stored in Collections as key-value pairs, where the key is a unique
identifier for some data (like a UUID, or timestamp). The value is always a
string - although JSON objects will be automatically serialized to a string
using the Collections API.
:::tip

The Collections API is automatically available to all Workflows and does not
require any credentials. Authentication with the OpenFn platform is managed for
you.

You can use the Collections API with any adaptor.

:::

Data is stored in as key-value pairs, where the key is a unique identifier for
some data (like a UUID, or timestamp). The value is always saved as a string
(although you can pass JSON-compatible objects directly, which will be
automatically serialized by the Collections API).

Keys can be fetched in bulk and filtered by _pattern_. For example, the pattern
`2024*` will match all keys which start with `2024`. Designing keys to have an
Expand Down

0 comments on commit 19952a4

Please sign in to comment.