The Module

Base classes for storage engines


Bases: object

Base class for event storage system connections.

CAPABILITIES = {'events': {'query': {'simple': False}}}
STORAGE_CAPABILITIES = {'storage': {'production_ready': False}}
static clear()

Clear database.

static clear_expired_data(ttl)

Clear expired data from the backend storage system.

Clearing occurs according to the time-to-live. :param ttl: Number of seconds to keep records for.

classmethod get_capabilities()

Return an dictionary with the capabilities of each driver.

static get_event_types()

Return all event types as an iterable of strings.

static get_events(event_filter, pagination=None)

Return an iterable of model.Event objects.

classmethod get_storage_capabilities()

Return a dictionary representing the performance capabilities.

This is needed to evaluate the performance of each driver.

static get_trait_types(event_type)

Return a dictionary containing the name and data type of the trait.

Only trait types for the provided event_type are returned. :param event_type: the type of the Event

static get_traits(event_type, trait_type=None)

Return all trait instances associated with an event_type.

If trait_type is specified, only return instances of that trait type. :param event_type: the type of the Event to filter by :param trait_type: the name of the Trait to filter by

static record_events(events)

Write the events to the backend storage system.


events – a list of model.Event objects.

static upgrade()

Migrate the database to version or the most recent version.


Bases: object

Base class for storage API models.