Structure-Fields¶
The structure fields are the networked equivalent of data-structures such as sets, hash-tables, lists and so forth. They are associated with an instance of a StdModel or, for redis backend only, with a StdModel class.
List¶
Backends: redis, mongodb
default encoder: stdnet.utils.encoders.NumericDefault.
Methods
The following api methods are available for a ListField via the List structure:
- Structure.size() list size.
- Structure.items() retrieve all items for a list.
- Sequence.push_back() append an element at the end of the list.
- List.push_front() prepend an element at the beginning of the list.
- Sequence.pop_back() remove the last element the list.
- List.pop_front() remove the first element of the list.
Set¶
Backends: redis, mongodb
default encoder: stdnet.utils.encoders.NumericDefault.
Methods
The following api methods are available for a Set and SetField:
- Structure.size() set size.
- Set.add() add a new element to the set.
- Set.update() add a collection of elements to the set.
- Set.discard() remove an element from the set if it is a member.
- Set.remove() remove an element from the set. Raises an KeyError if not available.
- Set.difference_update() remove a collection of elements from the set.
Zset¶
Backends: redis
default encoder: stdnet.utils.encoders.NumericDefault.
Methods
The following api methods are available for a Zset and SetField with SetField.ordered attribute set to True:
- Structure.size() set size.
- Set.add() add a new element to the set.
- Zset.rank() the rank (position) of an element withing the ordered set.
- Set.update() add a collection of elements to the set.
- Set.discard() remove an element from the set if it is a member.
- Set.remove() remove an element from the set. Raises an KeyError if not available.
- Set.difference_update() remove a collection of elements from the set.
- OrderedMixin.range() the specified range of elements in the sorted set.
- OrderedMixin.irange() the specified range of elements by index.
- OrderedMixin.pop_range() remove the specified range of elements in the sorted set.
- OrderedMixin.ipop_range() remove the specified range of elements by index.
Hash table¶
Backends: redis
default field encoder: stdnet.utils.encoders.Default.
default value encoder: stdnet.utils.encoders.NumericDefault.
Methods
The following api methods are available for a HashTable and HashField:
- Structure.size() Hash table size.
- Set.add() add a new element to the set.
- Set.update() add a collection of elements to the set.
- Set.discard() remove an element from the set if it is a memeber.
- Set.remove() remove an element from the set.
- Set.difference_update() remove a collection of elements from the set.
Timiseries¶
Backends: redis
default field encoder: stdnet.utils.encoders.DateTimeConverter.
default value encoder: stdnet.utils.encoders.Json.
A timeseries is an ordered associative container where entries are ordered with respect times and each entry is associated with a time. There are two types of timeseries in stdnet: the stdnet.odm.TS which accepts any type of entry and the stdnet.apps.columnts.ColumnTS, a specialized stdnet.odm.TS for multivariate numeric timeseries.
The TS has a simple api:
from datetime import date
from stdnet import odm
session = ...
with session.begin() as t:
ts = t.add(odm.TS())
ts[date(2013,1,1)] = "New year's day!"
Methods
The following api methods are available for a TS and TimeSeriesField:
- Structure.size()
- OrderedMixin.range() retrieve a range between two dates/datetimes.
- OrderedMixin.irange() retrieve a range by rank.
- OrderedMixin.pop_range() remove a range between two dates/datetimes.
- OrderedMixin.ipop_range() remove a range by rank.
