Address #249: add documentation about DynamoDB cache refresh behavior

stevearc · Jun 14, 2020 · 44da3f0 · aperuru · Jan 4, 2021 · stevearc
1 parent 84e5b7a
commit 44da3f0
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/doc/ref/pypicloud.storage.azure_blob.rst b/doc/ref/pypicloud.storage.azure_blob.rst
@@ -1,5 +1,5 @@
-pypicloud.storage.azure_blob module
-===================================
+pypicloud.storage.azure\_blob module
+====================================
 
 .. automodule:: pypicloud.storage.azure_blob
    :members:

diff --git a/doc/ref/pypicloud.storage.rst b/doc/ref/pypicloud.storage.rst
@@ -7,6 +7,7 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   pypicloud.storage.azure_blob
    pypicloud.storage.base
    pypicloud.storage.files
    pypicloud.storage.gcs

diff --git a/doc/topics/cache.rst b/doc/topics/cache.rst
@@ -69,6 +69,21 @@ Set ``pypi.db = dynamo`` OR ``pypi.db = pypicloud.cache.dynamo.DynamoCache``
   install the necessary DynamoDB libraries. Also, be sure you have set the
   correct :ref:`dynamodb_policy`.
 
+.. note::
+
+   Pypicloud will create the DynamoDB tables if none exist. By default the
+   tables will be named ``pypicloud-DynamoPackage`` and
+   ``pypicloud-PackageSummary`` (this can be configured with ``db.namespace``
+   and ``db.tablenames``). You may create and configure these tables yourself as
+   long as they have the same schema.
+
+.. warning::
+
+   When you reload the cache from the admin interface, the default behavior will
+   drop the DynamoDB tables and re-create them. If you have configured the
+   tables to have server-side encryption, or customized the throughput, you may
+   find this undesirable. To avoid this, set ``db.graceful_reload = true``
+
 ``db.region_name``
 ~~~~~~~~~~~~~~~~~~
 **Argument:** string