summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-11-02 12:41:07 -0200
committerdrebs <drebs@riseup.net>2017-11-03 09:09:22 -0200
commita1430bfea56d8aa27656730d27ed780f1444bf97 (patch)
tree287fd5e3a751c9e8307a6117870424281aa8fb3e
parent64dd8d41f08eae8dd4f793348e498c8ef3dc75b0 (diff)
[doc] improve client-side dbs doc
-rw-r--r--docs/reference/client-database.rst23
1 files changed, 17 insertions, 6 deletions
diff --git a/docs/reference/client-database.rst b/docs/reference/client-database.rst
index d8fd3be7..ac59c1bd 100644
--- a/docs/reference/client-database.rst
+++ b/docs/reference/client-database.rst
@@ -3,10 +3,21 @@
Client-side databases
=====================
-Soledad Client uses `SQLCipher <https://www.zetetic.net/sqlcipher/>`_ for
-storing data. The symmetric key used to unlock databases is chosen randomly and
-stored encrypted with the user's passphrase (see :ref:`storage-secrets` for
-more details).
+These are some important information about Soledad's client-side databases:
-:ref:`Documents <document-encryption>` and :ref:`blobs <blobs>` are stored in
-different databases protected with the same symmetric secret.
+- 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.