Rate this page:
The app storage API is an untyped key-value storage API which allows your app to store data. The app storage API stores data partitioned by Atlassian product and site, and is accessible only to your app.
When using the app storage API, we strongly recommend that you:
The Atlassian Cloud backs up the entire hosted storage for disaster recovery. This includes content stored from the Forge storage API.
We will add admin-driven backup (and restore) capabilities for app-level data in a future update.
All data stored within the app storage API is namespaced. The namespace includes which Atlassian site, product, and Forge environment your app is installed on. As a result:
The read and query APIs within the app storage APIs are eventually consistent. This means that the data returned from the API may be slightly out of date.
Writes to keys using set
or delete
use a "last write wins" conflict resolution strategy.
Writes to individual keys are atomic - For example, the value is either updated in full or not.
The app storage API is able to persist any JSON data type except null
. For example:
The JavaScript storage API serializes your objects using JSON.stringify
, and as such
removes functions and the value undefined
from any object you attempt to serialize.
The app storage API uses cursors for paginated data access. The Query API returns a cursor in the results, which can be provided to subsequent queries to paginate over larger data sets than you would otherwise be able to fetch.
1 2// Fetch a page of 10 results const { nextCursor } = await storage.query().getMany(); // Fetch the next 10 results await storage.query().cursor(nextCursor).getMany();
Cursors may not always be stable and shouldn't be persisted.
Please note you will have to use the same parameters as the initial query. See the example below.
1 2// Fetch 15 results const { nextCursor } = await storage .query() .limit(15) .where('key', startsWith('account.')) .getMany(); // This is expected usage await storage.query() .limit(15) .where('key', startsWith('account.')) .cursor(nextCursor) .getMany(); // This will produce undefined results await storage.query() .cursor(nextCursor) .getMany();
Keys are lexicographically ordered - as such the Query API will return entities ordered by their key. This property can be used to group related entities or build adhoc indexes.
The app storage API does not have support for indexing of arbitrary attributes. However, it is possible to support this sort of access pattern if your keys are constructed in such a way as to support indexed reads.
Hierarchical keys can be constructed to allow for nested entities to be fetched in a single list operation such as the example below.
1 2import { storage, startsWith } from '@forge/api'; // Nested entities await storage.set('survey-responses#1#{UUID}', { }); await storage.set('survey-responses#1#{UUID}', { }); await storage.set('survey-responses#1#{UUID}', { }); await storage.set('survey-responses#1#{UUID}', { }); const results = await storage .query() .where('key', startsWith('survey-response#1#')) .limit(10) .getMany();
Rate this page: