Skip to main content

Update with Higher Throughput

When the Update Data API is called, FileSpin synchronously updates asset data within multiple services such as Database and Search. Thus the Update API has inherent throughput limitations due to the nature of synchronous service calls.

In scenarios where there is a need for higher throughput with eventual consistency, the Update API can be called in asynchronous mode. The Update API provides an async query parameter option that can be used to inform FileSpin to perform the update asynchronously. Asynchronous mode provides higher throughput while offering eventual data consistency of asset data across the system.

To use asynchronous update, supply async=1 as a query parameter in the API URL:

/api/v1/assets/{ASSET_ID}/data/update?async=1
warning

When asynchronous mode is used, FileSpin APIs such as Get Data and Search may take time to reflect the metadata changes. This time may range from a few seconds to minutes depending on the volume of async updates. Asynchronous mode should be used only if this trade-off is acceptable.