Database - redish.client

class redish.client.Client(host=None, port=None, db=None, serializer=None)

Redis Client

Parameters:
  • host – Hostname of the Redis server to connect to. Default is "localhost".
  • port – Port of the server to connect to. Default is 6379.
  • db – Name of the database to use. Default is to use the default database.
  • serializer – Object used to serialize/deserialize values. Must support the methods serialize(value) and deserialize(value). The default is to use redish.serialization.Pickler.
Dict(name, initial=None, **extra)

The dictionary datatype (Hash).

Parameters:
  • name – The name of the dictionary.
  • initial – Initial contents.
  • **extra – Initial contents as keyword arguments.

The initial, and **extra keyword arguments will be merged (keyword arguments has priority).

See redish.types.Dict.

LifoQueue(name, initial=None, maxsize=None)

The LIFO queue datatype.

Parameters:
  • name – The name of the queue.
  • initial – Initial items in the queue.

See redish.types.LifoQueue.

List(name, initial=None)

The list datatype.

Parameters:
  • name – The name of the list.
  • initial – Initial contents of the list.

See redish.types.List.

Queue(name, initial=None, maxsize=None)

The queue datatype.

Parameters:
  • name – The name of the queue.
  • initial – Initial items in the queue.

See redish.types.Queue.

Set(name, initial=None)

The set datatype.

Parameters:
  • name – The name of the set.
  • initial – Initial members of the set.

See redish.types.Set.

SortedSet(name, initial=None)

The sorted set datatype.

Parameters:
  • name – The name of the sorted set.
  • initial – Initial members of the set as an iterable of (element, score) tuples.

See redish.types.SortedSet.

clear()
Remove all keys from the current database.
get(key, default=None)
Returns the value at key if present, otherwise returns default (None by default.)
id(name)
Return the next id for a name.
items(pattern='*')
Get a list of all the (key, value) pairs in the database, or the keys matching pattern, as 2-tuples.
iteritems(pattern='*')
An iterator over all the (key, value) items in the database, or where the keys matches pattern.
iterkeys(pattern='*')
An iterator over all the keys in the database, or matching pattern.
itervalues(pattern='*')
Iterate over all the values in the database, or those where the keys matches pattern.
keys(pattern='*')
Get a list of all the keys in the database, or matching pattern.
pop(name)
Get and remove key from database (atomic).
prepare_value(value)
Encode python object to be stored in the database.
rename(old_name, new_name)
Rename key to a new name.
update(mapping)
Update database with the key/values from a dict.
value_to_python(value)
Decode value to a Python object.
values(pattern='*')
Get a list of all values in the database, or those where the keys matches pattern.

Previous topic

API Reference

Next topic

Datatypes - redish.types

This Page