Class BaseCache

Declaration

Methods

• ▷ def __contains__(self, key)

  Return True if the key is in the cache and has not expired.

  source link
• ▶ def __init__(self, params)

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.BaseDatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def add(self, key, value, timeout=DEFAULT_TIMEOUT, version=None)

  Set a value in the cache if the key does not already exist. If timeout is given, use that timeout for the key; otherwise use the default cache timeout.

  source link

  Return True if the value was stored, False otherwise.

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def clear(self)

  Remove *all* values from the cache at once.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def close(self, **kwargs)

  Close the cache connection

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▶ def decr(self, key, delta=1, version=None)

  Subtract delta from value in the cache. If the key does not exist, raise a ValueError exception.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▷ def decr_version(self, key, delta=1, version=None)

  Subtract delta from the cache version for the supplied key. Return the new version.

  source link
• ▶ def delete(self, key, version=None)

  Delete a key from the cache and return whether it succeeded, failing silently.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def delete_many(self, keys, version=None)

  Delete a bunch of values in the cache at once. For certain backends (memcached), this is much more efficient than calling delete() multiple times.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▶ def get(self, key, default=None, version=None)

  Fetch a given key from the cache. If the key does not exist, return default, which itself defaults to None.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def get_backend_timeout(self, timeout=DEFAULT_TIMEOUT)

  Return the timeout value usable by this backend based upon the provided timeout.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▶ def get_many(self, keys, version=None)

  Fetch a bunch of keys from the cache. For certain backends (memcached, pgsql) this can be *much* faster when fetching multiple values.

  source link

  Return a dict mapping each key in keys to its value. If the given
  key is missing, it will be missing from the response dict.

  Overrides

  This method is overriden in:

  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▶ def get_or_set(self, key, default, timeout=DEFAULT_TIMEOUT, version=None)

  Fetch a given key from the cache. If the key does not exist,

  source link

  add the key and set it to the default value. The default value can
  also be any callable. If timeout is given, use that timeout for the
  key; otherwise use the default cache timeout.
  
  Return the value of the key stored or retrieved.

• ▶ def has_key(self, key, version=None)

  Return True if the key is in the cache and has not expired.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def incr(self, key, delta=1, version=None)

  Add delta to value in the cache. If the key does not exist, raise a ValueError exception.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▷ def incr_version(self, key, delta=1, version=None)

  Add delta to the cache version for the supplied key. Return the new version.

  source link
• ▶ def make_key(self, key, version=None)

  Construct the key used by all other methods. By default, use the

  source link

  key_func to generate a key (which, by default, prepends the
  `key_prefix' and 'version'). A different key function can be provided
  at the time of cache construction; alternatively, you can subclass the
  cache backend to provide custom key making behavior.

• ▶ def set(self, key, value, timeout=DEFAULT_TIMEOUT, version=None)

  Set a value in the cache. If timeout is given, use that timeout for the key; otherwise use the default cache timeout.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def set_many(self, data, timeout=DEFAULT_TIMEOUT, version=None)

  Set a bunch of values in the cache at once from a dict of key/value pairs. For certain backends (memcached), this is much more efficient than calling set() multiple times.

  source link

  If timeout is given, use that timeout for the key; otherwise use the
  default cache timeout.
  
  On backends that support it, return a list of keys that failed
  insertion, or an empty list if all keys were inserted successfully.

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache
• ▶ def touch(self, key, timeout=DEFAULT_TIMEOUT, version=None)

  Update the key's expiry time using timeout. Return True if successful or False if the key does not exist.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.filebased.FileBasedCache
  • django.core.cache.backends.db.DatabaseCache
  • django.core.cache.backends.dummy.DummyCache
  • django.core.cache.backends.memcached.BaseMemcachedCache
  • django.core.cache.backends.locmem.LocMemCache
• ▶ def validate_key(self, key)

  Warn about keys that would not be portable to the memcached backend. This encourages (but does not force) writing backend-portable cache code.

  source link

  Overrides

  This method is overriden in:

  • django.core.cache.backends.memcached.BaseMemcachedCache

Subclasses

• django.core.cache.backends.filebased.FileBasedCache
• django.core.cache.backends.db.BaseDatabaseCache
• django.core.cache.backends.dummy.DummyCache
• django.core.cache.backends.memcached.BaseMemcachedCache
• django.core.cache.backends.locmem.LocMemCache

Reexports

• Imported in django.core.cache.backends.filebased.
• Imported in django.core.cache.backends.db.
• Imported in django.core.cache.backends.dummy.
• Imported in django.core.cache.backends.memcached.
• Imported in django.core.cache.backends.locmem.
• Imported in django.core.cache.

Generated by nedoc v0.9 at 2020-12-29 14:04