Skip to content

Commit

Permalink
Add paragraph to caveats about cache volume for Issue #140
Browse files Browse the repository at this point in the history
  • Loading branch information
grantjenks committed Aug 23, 2020
1 parent 4f2ff54 commit a8a014c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,12 @@ thread-pool executor asynchronously. For example::

asyncio.run(set_async('test-key', 'test-value'))

The cache :meth:`volume <diskcache.Cache.volume>` is based on the size of the
database that stores metadata and the size of the values stored in files. It
does not account the size of directories themselves or other filesystem
metadata. If directory count or size is a concern then consider implementing an
alternative :class:`Disk <diskcache.Disk>`.

.. _`hash protocol`: https://docs.python.org/library/functions.html#hash
.. _`not recommended`: https://www.sqlite.org/faq.html#q5
.. _`performs poorly`: https://www.pythonanywhere.com/forums/topic/1847/
Expand Down

0 comments on commit a8a014c

Please sign in to comment.