The panko.storage.sqlalchemy.models Module¶

SQLAlchemy models for Panko data.

service None

Bases: sqlalchemy.ext.declarative.api.Base

service None

Bases: sqlalchemy.ext.declarative.api.Base

Types of event records.

service None

Bases: sqlalchemy.sql.type_api.TypeDecorator

Represents an immutable structure as a json-encoded string.

None¶

alias of sqlalchemy.sql.sqltypes.Text

static JSONEncodedDict.process_bind_param(value, dialect)¶

Receive a bound parameter value to be converted.

Subclasses override this method to return the value that should be passed along to the underlying TypeEngine object, and from there to the DBAPI execute() method.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

This operation should be designed with the reverse operation in mind, which would be the process_result_value method of this class.

Parameters

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

static JSONEncodedDict.process_result_value(value, dialect)¶

Receive a result-row column value to be converted.

Subclasses should implement this method to operate on data fetched from the database.

Subclasses override this method to return the value that should be passed back to the application, given a value that is already processed by the underlying TypeEngine object, originally from the DBAPI cursor method fetchone() or similar.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

Parameters

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

This operation should be designed to be reversible by the “process_bind_param” method of this class.

service None

Bases: object

Base class for Panko Models.

PankoBase.update(values)¶

Make the model object behave like a dict.

service None

Bases: sqlalchemy.sql.type_api.TypeDecorator

Represents a timestamp precise to the microsecond.

None

alias of sqlalchemy.sql.sqltypes.DateTime

PreciseTimestamp.load_dialect_impl(dialect)¶

Return a TypeEngine object corresponding to a dialect.

This is an end-user override hook that can be used to provide differing types depending on the given dialect. It is used by the TypeDecorator implementation of type_engine() to help determine what type should ultimately be returned for a given TypeDecorator.

By default returns self.impl.

static PreciseTimestamp.process_bind_param(value, dialect)¶

Receive a bound parameter value to be converted.

Subclasses override this method to return the value that should be passed along to the underlying TypeEngine object, and from there to the DBAPI execute() method.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

This operation should be designed with the reverse operation in mind, which would be the process_result_value method of this class.

Parameters

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

static PreciseTimestamp.process_result_value(value, dialect)¶

Receive a result-row column value to be converted.

Subclasses should implement this method to operate on data fetched from the database.

Subclasses override this method to return the value that should be passed back to the application, given a value that is already processed by the underlying TypeEngine object, originally from the DBAPI cursor method fetchone() or similar.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

Parameters

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.

• dialect – the Dialect in use.

This operation should be designed to be reversible by the “process_bind_param” method of this class.

service None

Bases: sqlalchemy.ext.declarative.api.Base

Event datetime traits.

service None

Bases: sqlalchemy.ext.declarative.api.Base

Event float traits.

service None

Bases: sqlalchemy.ext.declarative.api.Base

Event integer traits.

service None

Bases: sqlalchemy.ext.declarative.api.Base

Event text traits.