pyams_alchemy.interfaces package ⊞

interface pyams_alchemy.interfaces.IAlchemyEngineUtility[source]

SQLALchemy engine definition interface

name

Engine name

Keep empty if this engine is the default engine…

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:‘’
Allowed Type:str
dsn

DSN

RFC-1738 compliant URL for the database connection

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:‘sqlite://’
Allowed Type:str
echo

Echo SQL?

Log all SQL statements to system logger

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
use_pool

Use connections pool?

If ‘no’, collections pooling will be disabled

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:True
Allowed Type:bool
pool_size

Pool size

SQLAlchemy connections pool size

Implementation:zope.schema.Int
Read Only:False
Required:False
Default Value:25
Allowed Type:int
pool_recycle

Pool recycle time

SQLAlchemy connection recycle time (-1 for none)

Implementation:zope.schema.Int
Read Only:False
Required:False
Default Value:-1
Allowed Type:int
echo_pool

Echo pool?

Log all pool checkouts/checkins to system logger?

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
encoding

Encoding

Implementation:zope.schema.Choice
Read Only:False
Required:True
Default Value:‘utf-8’
convert_unicode

Convert Unicode

Implementation:zope.schema.Bool
Read Only:False
Required:True
Default Value:False
Allowed Type:bool
get_engine(self, use_pool=True)

Get SQLAlchemy engine

clear_engine(self)

Remove inner volatile attributes when utility properties are modified