Skip to content

Commit

Permalink
Merge pull request #612 from OpenFn/minor-comments-collections
Browse files Browse the repository at this point in the history
Minor changes to collections docs
  • Loading branch information
josephjclark authored Dec 24, 2024
2 parents b6cc6ba + 14c62b7 commit 868f23b
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions adaptors/collections.md
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

0 comments on commit 868f23b

Please sign in to comment.