A cacheable Django model
Project description
django cacheable model
A cacheable model for django.
- A generic way of creating cache keys from Django model fields
- Retrieve django models from cache with field values (cache on the way if cache missed)
- Retrieve all the model instances (suitable for small set of models)
- Support for cache aliases
See usage example below
1. Install
pip install django_cacheable_model
2. Configuration
DEFAULT_CACHE_ALIAS
the default cache name to use fromsettings.CACHES
. If not set default alias is name"default"
and must be configured in CACHES.CACHE_SET_MANY_LIMIT
is chunk size for calls tocache.set_many
.
whenall_ins_from_cache
brings in all entries from cache, it will set each object
in chunks to control request size. Default is5
i.e if there are 10 instances of a model
from db this config will set each of the models to the cache in two groups of5
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
CACHE_DEFAULT_ALIAS = 'example_cache_alias'
CACHE_SET_MANY_LIMIT = 10
CACHES = {
...,
'example_cache_alias': {
'BACKEND': 'django.core.cache.backends.memcached.PyMemcacheCache',
'LOCATION': 'memcached:11211',
},
...
}
3. Usage
See samples in example_django_project
views.py and models.py.
3.1. Create a model that inherits from CacheableModel
class Question(CacheableModel):
question_text = models.CharField(max_length=200)
pub_date = models.DateTimeField('date published')
class Choice(CacheableModel):
question = models.ForeignKey(Question, on_delete=models.CASCADE)
choice_text = models.CharField(max_length=200)
votes = models.IntegerField(default=0)
3.2. Use cache operations from django_cacheable_model.utils
from django_cacheable_model.utils import all_ins_from_cache, model_ins_from_cache
# Get all instances of model from cache (use for smaller set of models)
context['choices'] = all_ins_from_cache(Choice)
# Get all instances with select_related and order_by
choices = all_ins_from_cache(Choice,
select_related=('question',),
order_by_fields=('-id',))
# Get a single model. Note this method returns a list of matching objects
context['choice'] = model_ins_from_cache(Choice, {'id': 5})[-1]
4. License
Apache2 License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django_cacheable_model-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fbc067790428cf1d58762929b937182584c71d7107b022e5dfcf8494476149c |
|
MD5 | f21e604b9de11980cd79a6133c3332e8 |
|
BLAKE2b-256 | 8b289b4fbe83b3951c890dfe7bbcce05e0b95b24ae8d7dc2f6bc4a44e856cc3a |
Close
Hashes for django_cacheable_model-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc7ae5394286b42eddabe01b2a5779e16d4529a693438bfe39843594c1292b5f |
|
MD5 | c2d1424a5c39e52a726ea40e3dfa1182 |
|
BLAKE2b-256 | 3515f2ede77dbaae29a0c36e6c84b9d7f18ecdf5d429fd6ec4a796356804dd42 |