@@ -21,11 +21,29 @@ the collection (generated from the app at /profile/tokens).
21
21
Learn more about Collections and common use cases in the
22
22
[ Collections Docs] ( /documentation/build/collections ) .
23
23
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.
29
47
30
48
:::
31
49
@@ -63,8 +81,8 @@ a collection.
63
81
- Use [ ` collections.get() ` ] ( /adaptors/packages/collections-docs#collections_get )
64
82
to fetch a single value, or batch-download a range of values.
65
83
- 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
68
86
large data sets.
69
87
- Use [ ` collections.set() ` ] ( /adaptors/packages/collections-docs#collections_set )
70
88
to upload one or more values to a collection. ` set() ` is always an "upsert":
0 commit comments