summaryrefslogtreecommitdiff
path: root/docs/reference/client-database.rst
blob: ac59c1bd367e0c8e3bb3e51670cd09604771c005 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.. _client-databases:

Client-side databases
=====================

These are some important information about Soledad's client-side databases:

- Soledad Client uses `SQLCipher <https://www.zetetic.net/sqlcipher/>`_ for
  storing data.
- :ref:`Documents <document-encryption>` and :ref:`blobs <blobs>` are stored in
  different databases protected with the same symmetric key.
- The symmetric key used to unlock databases is chosen randomly and is stored
  encrypted by the user's passphrase (see :ref:`storage-secrets` for more details).

The database files currently used in the client-side are:

- ``<user_id>.db``: The database for JSON documents storage.
- ``<user_id>_blobs.db``: The database for storage of blobs.

Depending on how local databases are configured, you may also find files with
the same names of the above but ending in ``-wal`` and ``-shm``, which
correspond to SQLCipher's `Write-Ahead Logging
<http://www.sqlite.org/wal.html>`_ implementation.