Documented permanent store, updated fallback store docs

This commit is contained in:
lukas committed 2026-10-18 17:10:23 +00:00
1 parent 1f938cf19d
commit 55419acb09
2 files changed
+73 -1

No files matched your search

+2
View File
@@ -16,3 +16,5 @@ The `ObjectRetriever` constructor accepts an associative array of options. All o
| `connect_timeout` | Timeout for establishing a connection to the API, in seconds. | `5` |
| `fallback_store_directory` | Writeable directory in which copies of retrieved objects are saved and returned when the API fails with a 5xx error, times out, or the request fails without a response. Requires `fallback_store_scope`. See [caching](caching.md#fallback-store). | `null` |
| `fallback_store_scope` | Which objects are saved in the fallback store: `'*'` for all objects, or a list of namespaces (domains without `coid://` prefix) as a comma-separated string or an array of strings. | `null` |
| `permanent_store_directory` | Writeable directory in which copies of retrieved objects are saved; once an object is stored there, it is always returned from the store and the API is never contacted for it again. Requires `permanent_store_scope` and must differ from `fallback_store_directory`. See [caching](caching.md#permanent-store). | `null` |
| `permanent_store_scope` | Which objects are saved in the permanent store: `'*'` for all objects, or a list of namespaces (domains without `coid://` prefix) as a comma-separated string or an array of strings. | `null` |