Inheritance diagram for panko.storage.base.Connection:

Collaboration diagram for panko.storage.base.Connection:

Public Member Functions
def	get_capabilities (cls)
	More...

def	get_storage_capabilities (cls)
	More...

Static Public Member Functions
def	__init__ (url, conf)
	More...

def	upgrade ()
	More...

def	clear ()
	More...

def	record_events (events)
	More...

def	get_events (event_filter, pagination=None)
	More...

def	get_event_types ()
	More...

def	get_trait_types (event_type)
	More...

def	get_traits (event_type, trait_type=None)
	More...

def	clear_expired_data (ttl, max_count=None)
	More...

Static Public Attributes
dictionary	CAPABILITIES
	More...

dictionary	STORAGE_CAPABILITIES
	More...

Detailed Description

Base class for event storage system connections.

Definition at line 49 of file base.py.

Constructor & Destructor Documentation

◆ init()

def panko.storage.base.Connection.__init__	(	url,
		conf
	)

static

Reimplemented in panko.storage.impl_elasticsearch.Connection, panko.storage.impl_mongodb.Connection, and panko.storage.impl_sqlalchemy.Connection.

Definition at line 62 of file base.py.

References panko.storage.base.Connection.__init__().

Referenced by panko.storage.base.Connection.__init__().

Member Function Documentation

◆ clear()

def panko.storage.base.Connection.clear ( )

static

Clear database.

Reimplemented in panko.storage.impl_hbase.Connection, panko.storage.impl_mongodb.Connection, and panko.storage.impl_sqlalchemy.Connection.

Definition at line 70 of file base.py.

References panko.storage.base.Connection.clear().

Referenced by panko.storage.base.Connection.clear(), panko.storage.impl_hbase.Connection.clear(), panko.storage.impl_mongodb.Connection.clear(), and panko.storage.impl_sqlalchemy.Connection.clear().

◆ clear_expired_data()

def panko.storage.base.Connection.clear_expired_data	(	ttl,
		max_count = `None`
	)

static

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.
:param max_count: Number of records to delete.

Reimplemented in panko.storage.impl_sqlalchemy.Connection, panko.storage.impl_mongodb.Connection, and panko.storage.impl_log.Connection.

Definition at line 125 of file base.py.

References panko.storage.base.Connection.clear_expired_data().

Referenced by panko.storage.base.Connection.clear_expired_data().

◆ get_capabilities()

def panko.storage.base.Connection.get_capabilities ( cls )

Return an dictionary with the capabilities of each driver.

Definition at line 112 of file base.py.

References panko.storage.base.Connection.CAPABILITIES, panko.storage.impl_elasticsearch.Connection.CAPABILITIES, panko.storage.impl_hbase.Connection.CAPABILITIES, panko.storage.impl_sqlalchemy.Connection.CAPABILITIES, panko.storage.pymongo_base.Connection.CAPABILITIES, and panko.storage.base.Connection.get_capabilities().

Referenced by panko.storage.base.Connection.get_capabilities().

◆ get_event_types()

def panko.storage.base.Connection.get_event_types ( )

static

Return all event types as an iterable of strings.

Reimplemented in panko.storage.impl_elasticsearch.Connection, panko.storage.impl_hbase.Connection, panko.storage.impl_sqlalchemy.Connection, and panko.storage.pymongo_base.Connection.

Definition at line 86 of file base.py.

References panko.storage.base.Connection.get_event_types().

Referenced by panko.storage.base.Connection.get_event_types(), panko.storage.impl_elasticsearch.Connection.get_event_types(), panko.storage.impl_hbase.Connection.get_event_types(), panko.storage.impl_sqlalchemy.Connection.get_event_types(), and panko.storage.pymongo_base.Connection.get_event_types().

◆ get_events()

def panko.storage.base.Connection.get_events	(	event_filter,
		pagination = `None`
	)

static

Return an iterable of model.Event objects.

Reimplemented in panko.storage.impl_elasticsearch.Connection, panko.storage.impl_hbase.Connection, panko.storage.impl_sqlalchemy.Connection, and panko.storage.pymongo_base.Connection.

Definition at line 82 of file base.py.

References panko.storage.base.Connection.get_events().

Referenced by panko.storage.impl_sqlalchemy.Connection._get_pagination_query(), and panko.storage.base.Connection.get_events().

◆ get_storage_capabilities()

def panko.storage.base.Connection.get_storage_capabilities ( cls )

Return a dictionary representing the performance capabilities.

This is needed to evaluate the performance of each driver.

Definition at line 117 of file base.py.

References panko.storage.base.Connection.get_storage_capabilities(), panko.storage.base.Connection.STORAGE_CAPABILITIES, panko.storage.impl_elasticsearch.Connection.STORAGE_CAPABILITIES, panko.storage.impl_hbase.Connection.STORAGE_CAPABILITIES, panko.storage.impl_sqlalchemy.Connection.STORAGE_CAPABILITIES, and panko.storage.pymongo_base.Connection.STORAGE_CAPABILITIES.

Referenced by panko.storage.base.Connection.get_storage_capabilities().

◆ get_trait_types()

def panko.storage.base.Connection.get_trait_types ( event_type )

static

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

Reimplemented in panko.storage.impl_elasticsearch.Connection, panko.storage.impl_hbase.Connection, panko.storage.impl_sqlalchemy.Connection, and panko.storage.pymongo_base.Connection.

Definition at line 91 of file base.py.

References panko.storage.base.Connection.get_trait_types().

Referenced by panko.storage.impl_elasticsearch.Connection.get_events(), panko.storage.base.Connection.get_trait_types(), and panko.storage.impl_elasticsearch.Connection.get_traits().

◆ get_traits()

def panko.storage.base.Connection.get_traits	(	event_type,
		trait_type = `None`
	)

static

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

Reimplemented in panko.storage.pymongo_base.Connection, panko.storage.impl_elasticsearch.Connection, panko.storage.impl_hbase.Connection, and panko.storage.impl_sqlalchemy.Connection.

Definition at line 101 of file base.py.

References panko.storage.base.Connection.get_traits().

Referenced by panko.storage.base.Connection.get_traits().

◆ record_events()

def panko.storage.base.Connection.record_events ( events )

static

Write the events to the backend storage system.

:param events: a list of model.Event objects.

Reimplemented in panko.storage.impl_hbase.Connection, panko.storage.impl_sqlalchemy.Connection, panko.storage.pymongo_base.Connection, and panko.storage.impl_elasticsearch.Connection.

Definition at line 74 of file base.py.

References panko.storage.base.Connection.record_events().

Referenced by panko.storage.base.Connection.record_events().

◆ upgrade()

def panko.storage.base.Connection.upgrade ( )

static

Migrate the database to `version` or the most recent version.

Reimplemented in panko.storage.impl_elasticsearch.Connection, panko.storage.impl_hbase.Connection, panko.storage.impl_mongodb.Connection, and panko.storage.impl_sqlalchemy.Connection.

Definition at line 66 of file base.py.

References panko.storage.base.Connection.upgrade().

Referenced by panko.storage.base.Connection.upgrade(), panko.storage.impl_elasticsearch.Connection.upgrade(), panko.storage.impl_hbase.Connection.upgrade(), panko.storage.impl_mongodb.Connection.upgrade(), and panko.storage.impl_sqlalchemy.Connection.upgrade().

Member Data Documentation

◆ CAPABILITIES

dictionary panko.storage.base.Connection.CAPABILITIES

static

Initial value:

=  {
        'events': {'query': {'simple': False}},
    }

Definition at line 53 of file base.py.

Referenced by panko.storage.base.Connection.get_capabilities().

◆ STORAGE_CAPABILITIES

dictionary panko.storage.base.Connection.STORAGE_CAPABILITIES

static

Initial value:

=  {
        'storage': {'production_ready': False},
    }

Definition at line 57 of file base.py.

Referenced by panko.storage.base.Connection.get_storage_capabilities().

The documentation for this class was generated from the following file:

panko/storage/base.py

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ clear()

◆ clear_expired_data()

◆ get_capabilities()

◆ get_event_types()

◆ get_events()

◆ get_storage_capabilities()

◆ get_trait_types()

◆ get_traits()

◆ record_events()

◆ upgrade()

Member Data Documentation

◆ CAPABILITIES

◆ STORAGE_CAPABILITIES

◆ init()