Welcome to dogpile.cache’s documentation! — dogpile.cache 1.3.4 documentation

Skip to main content
`Ctrl`+`K`

# Welcome to dogpile.cache’s documentation!

Dogpile consists of two subsystems, one building on top of the other.

`dogpile` provides the concept of a “dogpile lock”, a control structure which allows a single thread of execution to be selected as the “creator” of some resource, while allowing other threads of execution to refer to the previous version of this resource as the creation proceeds; if there is no previous version, then those threads block until the object is available.

`dogpile.cache` is a caching API which provides a generic interface to caching backends of any variety, and additionally provides API hooks which integrate these cache backends with the locking mechanism of `dogpile`.

New backends are very easy to create and use; users are encouraged to adapt the provided backends for their own needs, as high volume caching requires lots of tweaks and adjustments specific to an application and its environment.

- Front Matter
  - Project Homepage
  - Installation
  - Bugs
- Usage Guide
  - Overview
  - Rudimentary Usage
  - Region Configuration
  - Using a Region
  - Creating Backends
  - Changing Backend Behavior
  - Configuring Logging
- Recipes
  - Invalidating a group of related keys
  - Asynchronous Data Updates with ORM Events
  - Prefixing all keys in Redis
  - Encoding/Decoding data into another format
- dogpile Core
  - Do I Need to Learn the dogpile Core API Directly?
  - Rudimentary Usage
  - Example: Using dogpile directly for Caching
  - Using a File or Distributed Lock with Dogpile
- API
  - Region
  - Backend API
  - Backends
  - Exceptions
  - Plugins
  - Utilities
  - dogpile Core
- Changelog
  - 1.3.4
  - 1.3.3
  - 1.3.2
  - 1.3.1
  - 1.3.0
  - 1.2.2
  - 1.2.1
  - 1.2.0
  - 1.1.8
  - 1.1.7
  - 1.1.6
  - 1.1.5
  - 1.1.4
  - 1.1.3
  - 1.1.2
  - 1.1.1
  - 1.1.0
  - 1.0.2
  - 1.0.1
  - 1.0.0
  - 0.9.2
  - 0.9.1
  - 0.9.0
  - 0.8.0
  - 0.7.1
  - 0.7.0
  - 0.6.8
  - 0.6.7
  - 0.6.6
  - 0.6.5
  - 0.6.4
  - 0.6.3
  - 0.6.2
  - 0.6.1
  - 0.6.0
  - 0.5.7
  - 0.5.6
  - 0.5.5
  - 0.5.4
  - 0.5.3
  - 0.5.2
  - 0.5.1
  - 0.5.0
  - 0.4.3
  - 0.4.2
  - 0.4.1
  - 0.4.0
  - 0.3.1
  - 0.3.0
  - 0.2.4
  - 0.2.3
  - 0.2.2
  - 0.2.1
  - 0.2.0
  - 0.1.1
  - 0.1.0

## Indices and tables

- Index

- Module Index

- Search Page