diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-20 17:42:34 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-08-20 21:02:15 -0500 |
| commit | 88d9d3e12dca79dd9b6ac1c3af7a066d10e1fb1a (patch) | |
| tree | d747cb57d7fa215318edd46b83b9c89b6faccf7a /requests_cache/backends/gridfs.py | |
| parent | d492c56e6870537d02894a31325d23733f2d554b (diff) | |
| download | requests-cache-88d9d3e12dca79dd9b6ac1c3af7a066d10e1fb1a.tar.gz | |
Better backend docs
Diffstat (limited to 'requests_cache/backends/gridfs.py')
| -rw-r--r-- | requests_cache/backends/gridfs.py | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/requests_cache/backends/gridfs.py b/requests_cache/backends/gridfs.py index 8ac8e6a..4d5a3fa 100644 --- a/requests_cache/backends/gridfs.py +++ b/requests_cache/backends/gridfs.py @@ -1,3 +1,16 @@ +""" +.. image:: + ../_static/mongodb.png + +`GridFS <https://docs.mongodb.com/manual/core/gridfs/>`_ is a specification for storing large files +(>16 MB) in MongoDB. See :py:mod:`~requests_cache.backends.mongo` for more general info on MongoDB. + +API Reference +^^^^^^^^^^^^^ +.. automodsumm:: requests_cache.backends.gridfs + :classes-only: + :nosignatures: +""" from gridfs import GridFS from pymongo import MongoClient @@ -8,15 +21,10 @@ from .mongo import MongoDict class GridFSCache(BaseCache): """GridFS cache backend. - Use this backend to store documents greater than 16MB. Example: - >>> requests_cache.install_cache(backend='gridfs') - >>> - >>> # Or, to provide custom connection settings: - >>> from pymongo import MongoClient - >>> requests_cache.install_cache(backend='gridfs', connection=MongoClient('alternate-host')) + >>> session = CachedSession('http_cache', backend='gridfs') Args: db_name: Database name |
