Skip to content
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

Minor changes to collections docs #612

Merged
merged 3 commits into from
Dec 24, 2024
Merged

Minor changes to collections docs #612

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3a8457
Fixed typos and readaility
christad92 Dec 5, 2024
64bdd10
More copy updates
christad92 Dec 5, 2024
14c62b7
minor adjustments
josephjclark Dec 24, 2024
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
36 changes: 20 additions & 16 deletions adaptors/collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,42 @@ title: Collections Adaptor

## Collections Overview

The Collections API provides access to a secure key/value store on the OpenFn
Platform. It is designed for high performance over a large volume of data.
The Collections API provides access to a secure key/value store that allows
users to store, update and reuse data across workflows in their OpenFn projects.
It is designed for high performance over a large volume of data.

Collections are secure, private datastores which are visible only to Workflows
within a particular OpenFn Project. They can be created, managed and destroyed
from the OpenFn Admin page.
Collections are secure, private datastores which are only accessible to
Workflows within a particular OpenFn Project. They can be created, managed and
destroyed from the OpenFn Admin page.

The Collections Adaptor provides an interface to workflows to use the
Collections API.

When running in the CLI, a Personal Access Token can be used to get access to
the collection (generated from the app at /profile/tokens).

See the [Collections](/documentation/build/collections) Platform Docs to learn
more about Collections.
Learn more about Collections and common use cases in the
[Collections Docs](/documentation/build/collections).

:::caution

Collections must be created in the platform Admin page before they can be used.

Refer to the [Collections Docs](/documentation/build/collections) for details
Collections must be created in the
[Platform Admin page](https://docs.openfn.org/documentation/build/collections#managing-collections)
before they can be used.

:::

## The Collections Adaptor

The Collections API is inserted into all Steps through a special kind of
adaptor.
The Collections API is inserted into all each Step of a Workflow through a
special kind of adaptor.

Uniquely, the Collections adaptor it is designed to be run _alongside_ other
adaptors, not by itself. It is injected into the runtime environment for you for
you by OpenFn. This makes the Collections API available to every Step in a
Workflow, regardless of which adaptor it is using.
adaptors, not by itself. It is automatically injected into the runtime
environment making the Collections API available to every Step in a Workflow,
regardless of which adaptor it is using.

If using the CLI run a workflow with Collections, refer to the
If using the CLI the use Collections locally, refer to the
[CLI Usage](#cli-usage) guide below.

## Usage Guide
Expand Down
Loading