Client-side blobs

Data storage

On the client-side, blobs can be managed using the BlobManager API, which is responsible for managing storage of blobs both in local and remote storages. See Blobs creation, retrieval, deletion and flagging and Blobs Synchronization for information on the client-side API.

All data is stored locally in the blobs table of a SQLCipher database called {uuid}_blobs.db that lies in the same directory as the Soledad Client’s JSON documents database (see Client-side databases). All actions performed locally are mirrored remotelly using the Public Blobs HTTP API.

Namespaces

The Blobs API supports namespaces so that applications can store and fetch blobs without interfering in each another. Namespaces are also used to implement the server-side Local Incoming Box HTTP API, used for mail delivery. All methods that deal with blobs storage, transfer and flagging provide a namespace parameter. If no namespace is given, the value default is used. See Blobs creation, retrieval, deletion and flagging for information on how to use namespaces.

Remote flags

In order to allow clients to control the processing of blobs that are delivered by external applications, the Blobs API has the concept of remote flags. The client can get and set the following flags for Blobs that reside in the server: PENDING, PROCESSING, PROCESSED, and FAILED. See Blobs creation, retrieval, deletion and flagging for more information on how to use flags.

Remote listing

The client can obtain a list of blobs in the server side so it can compare with its own local list and queue up blobs for download and upload. The remote listing can be ordered by upload date and filtered by namespace and flag. The listing can also only return the number of matches instead of the whole content. See Blobs creation, retrieval, deletion and flagging for more information on how to use remote listing.