Skip to content

Commit 0c91755

Browse files
Updates to collections description & zero persistence update (#667)
* updated zero-persistence diagram and deployment option descriptions * collections docs update * remove duplicate image --------- Co-authored-by: Joe Clark <[email protected]>
1 parent 1ab587b commit 0c91755

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

adaptors/collections.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,29 @@ the collection (generated from the app at /profile/tokens).
2121
Learn more about Collections and common use cases in the
2222
[Collections Docs](/documentation/build/collections).
2323

24-
:::caution
25-
26-
Collections must be created in the
27-
[Platform Admin page](/documentation/build/collections#managing-collections)
28-
before they can be used.
24+
:::caution Collections is _not_ a long-term data storage solution!
25+
26+
The OpenFn Collections feature is designed to be a _temporary_ data store or
27+
integration “buffer” during data transfer and processing between digital
28+
systems.
29+
30+
- This feature is optimized for throughput and performance (rather then
31+
long-term retention and making the data accessible to end users for
32+
querying/analysis)
33+
- Technically, collections is a key value store, so performance for complex
34+
aggregations or queries is either unsupported or inefficient
35+
- Collections doesn't support advance archiving, backup, and recovery features
36+
that you’d want in a long-term storage solution
37+
- Most buffer implementations have retention mechanisms that automatically
38+
expire/purge data after a certain period of time to clear up space and memory
39+
to ensure resources aren’t exhausted for active processing
40+
41+
Therefore, if you're interested in storing data collected longer term–we
42+
recommend you set up a dedicated database and configure OpenFn to route data to
43+
there as a long-term storage and/or backup option. Ask on
44+
[Community](https://community.openfn.org) or get in touch with
45+
[our support team](mailto://[email protected]) to learn more about related
46+
OpenFn services.
2947

3048
:::
3149

@@ -63,8 +81,8 @@ a collection.
6381
- Use [`collections.get()`](/adaptors/packages/collections-docs#collections_get)
6482
to fetch a single value, or batch-download a range of values.
6583
- Use
66-
[`collections.each()`](/adaptors/packages/collections-docs#collections_each) to
67-
efficiently iterate over a range of items in a collection. Recommended for
84+
[`collections.each()`](/adaptors/packages/collections-docs#collections_each)
85+
to efficiently iterate over a range of items in a collection. Recommended for
6886
large data sets.
6987
- Use [`collections.set()`](/adaptors/packages/collections-docs#collections_set)
7088
to upload one or more values to a collection. `set()` is always an "upsert":

docs/get-started/security-compliance.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ See our main website to learn more about OpenFn
2424

2525
## OpenFn and data storage
2626

27-
In your digital ecosystem, typically **OpenFn serves as a data processing and transfer
28-
solution—not as a data storage service.**
27+
In your digital ecosystem, typically **OpenFn serves as a data processing and
28+
transfer solution—not as a data storage service.**
2929

3030
As an open source Digital Public Good, OpenFn can be deployed anywhere and
3131
workflows can be configured to adhere to your organization's specific data
@@ -34,10 +34,10 @@ sharing agreements and security policies.
3434
Consult the `Manage Projects` docs pages for more on project and
3535
[data storage settings](../manage-projects/io-data-storage.md).
3636

37-
See the below diagram for an example architecture where even the OpenFn Cloud can be configured as a **“zero-persistence” data pipeline** to
38-
ensure compliance with data security and residency requirements. This enables
39-
partners to rapidly configure and pilot projects using the turnkey OpenFn
40-
cloud-hosted platform, before migrating to a local deployment when they’re ready
41-
to scale.
37+
See the below diagram for an example architecture where even the OpenFn Cloud
38+
can be configured as a **“zero-persistence” data pipeline** to ensure compliance
39+
with data security and residency requirements. This enables partners to rapidly
40+
configure and pilot projects using the turnkey OpenFn cloud-hosted platform,
41+
before migrating to a local deployment when they’re ready to scale.
4242

4343
![Sample Architecture](/img/zero-persistence.webp)

0 commit comments

Comments
 (0)