panko  8.1.0
About: OpenStack Panko is an event storage service and REST API for Ceilometer.
The "Ussuri" series (maintained release).
  Fossies Dox: panko-8.1.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

panko.storage.base.Connection Class Reference
Inheritance diagram for panko.storage.base.Connection:
[legend]
Collaboration diagram for panko.storage.base.Connection:
[legend]

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

Member Function Documentation

◆ 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()

◆ get_event_types()

◆ get_events()

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

◆ 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()

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: