Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
triliodata-3-4 / contego deb
Repository URL to install this package:
|
Version:
3.4.45 ▾
|
contego
/
home
/
tvault
/
.virtenv
/
lib
/
python2.7
/
site-packages
/
oslo_db
/
sqlalchemy
/
utils.pyc
|
|---|
ó
xEYc @ së d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l Z d d l Z d d l m Z d d l m
Z
d d l m Z d d l m
Z
d d l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d
l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l m Z d d l! m" Z" m# Z# m$ Z$ d d l% m& Z& e j' Z' e j( Z( e j) e* Z+ e j, d Z- g e j. d d g d d g D] Z/ d j0 e/ ^ qÿZ1 d Z2 d Z3 d Z4 d d d d Z6 d d! Z7 d" Z8 d# Z9 d d$ Z: d% Z; d& e< f d' YZ= d( Z> d) Z? d* Z@ d+ ZA d, ZB d- ZC d. ZD d/ ZE d0 ZF d d d1 d2 ZG d d d3 ZH d4 ZI d5 ZJ d6 ZK d7 ZL d8 ZM d9 ZN d: e< f d; YZO d< eO f d= YZP d> eO f d? YZQ eO jR ZR dK dB ZS dC e< f dD YZT dE eT f dF YZU dG eT f dH YZV dI e< f dJ YZW d S(L iÿÿÿÿN( t timeutils( t Boolean( t CheckConstraint( t Column( t Connectable( t
reflection( t url( t exc( t func( t Index( t inspect( t Integer( t MetaData( t literal_column( t text( t String( t Table( t NullType( t exception( t _t _LIt _LW( t modelss [^:]+://([^:]+):([^@]+)@.+t asct desct
nullsfirstt nullslastt -c C sA t j | } | r= d | | j d | | j d f S| S( Ns
%s****:****%si i ( t _DBURL_REGEXt matcht startt end( R R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt sanitize_db_url? s (c C sm y t | } Wn t j k
r' d SX| j } | j j } | d k rM d St | d } | r | j } d | k r | d Sn g } y
| j } Wn t k
r® g } n XxF | D]> } t
| t j t j
f r¶ | j d | j D q¶ q¶ Wy
| j } Wn t k
r g } n Xx4 | D], }
|
j r&| j d |
j D q&q&W| ri| | d <n | S( s¶ Get a list of sets of unique model keys.
:param model: the ORM model class
:rtype: list of sets of strings
:return: unique model keys or None if unable to find them
t infot oslodb_unique_keysc S s h | ] } | j q S( ( t name( t .0t c( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pys <setcomp>i s c S s h | ] } | j q S( ( R# ( R$ R% ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pys <setcomp>p s N( R
R t NoInspectionAvailablet Nonet local_tablet base_mappert hasattrR! t constraintst AttributeErrort
isinstancet
sqlalchemyt UniqueConstraintt PrimaryKeyConstraintt appendt columnst indexest unique( t modelt mapperR( t
base_tablet has_infoR! t resR+ t
constraintR3 t index( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _get_unique_keysF s@
!
!
c C sP t | } | d k r d St | } x! | D] } | j | r/ t Sq/ Wt S( s Check whetever the sorting order is stable.
:return: True if it is stable, False if it's not, None if it's impossible
to determine.
N( R< R' t sett issubsett Truet False( R5 t sort_keyst keyst
sort_keys_sett unique_keys( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _stable_sorting_orderw s
c C sK t | | t k r+ t j t d n | o4 | s> t | d
k r_ | d
k r_ d } n | d
k r g | D] } | ^ qr } n t | t | k s¥ t x>t | | D]-\ } } y t | j
| Wn t k
rø t j
| n Xt | | }
yk | j d \ } } }
i t j d 6t j d 6| } i d
d 6|
j d
d 6|
j d
d 6|
} Wn0 t k
r¥t t d d j t n X| d
k rÍ| j t j | } n | j | |
} qµ W| d
k r)g } x* | D]" } t | | } | j | qÿWg } x× t t | D]Ã } g } x> t | D]0 } t | | | } | j | | | k qWWt | | | } | | j d rË| j | | | k n | j | | | k t j j | } | j | q>Wt j j | } | j | } n | d
k rG| j! | } n | S( s; Returns a query with sorting / pagination criteria added.
Pagination works by requiring a unique sort_key, specified by sort_keys.
(If sort_keys is not unique, then we risk looping through values.)
We use the last row in the previous page as the 'marker' for pagination.
So we must return values that follow the passed marker in the order.
With a single-valued sort_key, this would be easy: sort_key > X.
With a compound-values sort_key, (k1, k2, k3) we must do this to repeat
the lexicographical ordering:
(k1 > X1) or (k1 == X1 && k2 > X2) or (k1 == X1 && k2 == X2 && k3 > X3)
We also have to cope with different sort_directions.
Typically, the id of the last row is used as the client-facing pagination
marker, then the actual marker object must be fetched from the db and
passed in to us as marker.
:param query: the query object to which we should add paging/sorting
:param model: the ORM model class
:param limit: maximum number of items to return
:param sort_keys: array of attributes by which results should be sorted
:param marker: the last item of the previous page; we returns the next
results after this value.
:param sort_dir: direction in which results should be sorted (asc, desc)
suffix -nullsfirst, -nullslast can be added to defined
the ordering of null values
:param sort_dirs: per-column array of sort_dirs, corresponding to sort_keys
:rtype: sqlalchemy.orm.query.Query
:return: The query with sorting/pagination added.
s@ Unique keys not in sort_keys. The sorting order may be unstable.R R R t R R s* Unknown sort direction, must be one of: %ss , N(" RE R@ t LOGt warningR t AssertionErrorR' t lent zipR
t all_orm_descriptorst KeyErrorR t InvalidSortKeyt getattrt partitionR. R R t is_t isnott
ValueErrorR t joint _VALID_SORT_DIRt order_byR1 t ranget
startswitht sqlt and_t or_t filtert limit( t queryR5 R] RA t markert sort_dirt sort_dirst _sort_keyt current_sort_keyt current_sort_dirt
sort_key_attrt
main_sort_dirt __t
null_sort_dirt
sort_dir_funct null_order_by_stmtt
marker_valuest sort_keyt vt
criteria_listt it
crit_attrst jt
model_attrt criteriat f( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt paginate_query sj !
c C s] | d k r | St | t j s5 t | t j r< | g St | t rO | St | Sd S( N( R' R- t collectionst Iterablet sixt string_typest list( t xt default( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt to_listø s c C s d | j j k r. t t d | j n | j j j j j } | rd | j | j | k } n | j | j | k } | S( Nt deletedsU There is no `deleted` column in `%s` table. Project doesn't use soft-deleted feature.(
t __table__R2 RS R t __name__R% R~ R| t argR\ ( R^ t db_modelR~ t default_deleted_value( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _read_deleted_filter s c C s d | j j k r. t t d | j n t | t t t f rd | j | j
j | } n | j | j
| k } | S( Nt
project_ids. There is no `project_id` column in `%s` table.( R R2 RS R R R- Rz t tupleR= R\ R
t in_( R^ R R
( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _project_filter s c K s t | t j s' t t d n | s< | j | n | j | } d | k rp t | | | d } n d | k r t | | | d } n | S( s' Query helper for db.sqlalchemy api methods.
This accounts for `deleted` and `project_id` fields.
:param model: Model to query. Must be a subclass of ModelBase.
:type model: models.ModelBase
:param session: The session to use.
:type session: sqlalchemy.orm.session.Session
:param args: Arguments to query. If None - model is used.
:type args: tuple
Keyword arguments:
:keyword project_id: If present, allows filtering by project_id(s).
Can be either a project_id value, or an iterable of
project_id values, or None. If an iterable is passed,
only rows whose project_id column value is on the
`project_id` list will be returned. If None is passed,
only rows which are not bound to any project, will be
returned.
:type project_id: iterable,
model.__table__.columns.project_id.type,
None type
:keyword deleted: If present, allows filtering by deleted field.
If True is passed, only deleted entries will be
returned, if False - only existing entries.
:type deleted: bool
Usage:
.. code-block:: python
from oslo_db.sqlalchemy import utils
def get_instance_by_uuid(uuid):
session = get_session()
with session.begin()
return (utils.model_query(models.Instance, session=session)
.filter(models.Instance.uuid == uuid)
.first())
def get_nodes_stat():
data = (Node.id, Node.cpu, Node.ram, Node.hdd)
session = get_session()
with session.begin()
return utils.model_query(Node, session=session, args=data).all()
Also you can create your own helper, based on ``utils.model_query()``.
For example, it can be useful if you plan to use ``project_id`` and
``deleted`` parameters from project's ``context``
.. code-block:: python
from oslo_db.sqlalchemy import utils
def _model_query(context, model, session=None, args=None,
project_id=None, project_only=False,
read_deleted=None):
# We suppose, that functions ``_get_project_id()`` and
# ``_get_deleted()`` should handle passed parameters and
# context object (for example, decide, if we need to restrict a user
# to query his own entries by project_id or only allow admin to read
# deleted entries). For return values, we expect to get
# ``project_id`` and ``deleted``, which are suitable for the
# ``model_query()`` signature.
kwargs = {}
if project_id is not None:
kwargs['project_id'] = _get_project_id(context, project_id,
project_only)
if read_deleted is not None:
kwargs['deleted'] = _get_deleted_dict(context, read_deleted)
session = session or get_session()
with session.begin():
return utils.model_query(model, session=session,
args=args, **kwargs)
def get_instance_by_uuid(context, uuid):
return (_model_query(context, models.Instance, read_deleted='yes')
.filter(models.Instance.uuid == uuid)
.first())
def get_nodes_data(context, project_id, project_only='allow_none'):
data = (Node.id, Node.cpu, Node.ram, Node.hdd)
return (_model_query(context, Node, args=data, project_id=project_id,
project_only=project_only)
.all())
s' model should be a subclass of ModelBaseR~ R
( t
issubclassR t ModelBaset TypeErrorR R^ R R ( R5 t sessiont argst kwargsR^ ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt model_query s d$ c C s% t } | | _ t | | d t S( s Returns an sqlalchemy table dynamically from db.
Needed because the models don't work for us in migrations
as models will be far out of sync with the current data.
.. warning::
Do not use this method when creating ForeignKeys in database migrations
because sqlalchemy needs the same MetaData object to hold information
about the parent table and the reference table in the ForeignKey. This
method uses a unique MetaData object per table object so it won't work
with ForeignKey creation.
t autoload( R t bindR R? ( t engineR# t metadata( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt get_table s t InsertFromSelectc B s& e Z d Z d d Z d d Z RS( s Form the base for `INSERT INTO table (SELECT ... )` statement.
DEPRECATED: this class is deprecated and will be removed from oslo_db
in a few releases. Use default SQLAlchemy insert from select implementation
instead
:param table: table to insert records
:param select: select query
:param cols: list of columns to specify in insert clause
:return: SQLAlchemy :class:`Insert` object instance
Usage:
.. code-block:: python
select = sql.select(table_from)
insert = InsertFromSelect(table_to, select,
['id', 'name', 'insert_date'])
engine.execute(insert)
c C sD | s( g | j D] } | j ^ q } n | j d t j | | S( Nt inline( R% R# t insertR? t from_select( t clst tablet selectt colsR% ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt __new__¼ s "c C s d S( N( ( t selfR R R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt __init__Â s N( R t
__module__t __doc__R' R R ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR ¢ s c C sv y | | } Wn0 t k
r@ t d } t j | | n Xt | t sr t d } t j | | n | S( Nsv Please specify column %s in col_name_col_instance param. It is required because column has unsupported type by SQLite.sw col_name_col_instance param has wrong type of column instance for column %s It should be instance of sqlalchemy.Column.( RM R R t ColumnErrorR- R ( t col_name_col_instancet column_namet columnt msg( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _get_not_supported_columnÆ s
c G sþ t } | | _ t | | d t } g | D] } | j | ^ q. } t j | j j g } | j | t j
j | d | d t j | j j d k } xX| j
| j D]A}
| j j |
d k } d } | | j j | k M} x) | D]! } | | j | |
| k M} qô Wt j
j | j j g j | }
xF | j
|
j D]/ }
t j t d t d |
d d | qSW| rÔ| j j | j i t d d 6t d
d
6t j d 6 } n | j j | } | j
| qµ Wd S(
sô Drop all old rows having the same values for columns in uc_columns.
This method drop (or mark ad `deleted` if use_soft_delete is True) old
duplicate rows form table with name `table_name`.
:param migrate_engine: Sqlalchemy engine
:param table_name: Table with duplicates
:param use_soft_delete: If True - values will be marked as `deleted`,
if False - values will be removed from table
:param uc_column_names: Unique constraint columns
R t group_byt havingi i s= Deleting duplicated row with id: %(id)s from table: %(table)st idR R~ t
updated_att
deleted_atN( R R R R? R% R t maxRª t extendR. RY R t countt executet fetchallR' R¬ t whereRG R! R t dictt updatet valuesR
R t utcnowt delete( t migrate_enginet
table_namet use_soft_deletet uc_column_namest metaR R# t columns_for_group_byt columns_for_selectt duplicated_rows_selectt rowt delete_conditiont is_nonet rows_to_delete_selectt delete_statement( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt% drop_old_duplicate_entries_from_table× s:
c C sQ t | j j j t r d St | j j j t r8 d St j t d d S( Ni RF s Unsupported id columns type( R- R% Rª t typeR R R R¢ R ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _get_default_deleted_value s
c
C s9 t | | } t j j | } | j | } t g | D] } | d | d f ^ q: } xÕ | D]Í } d | d k r qd n | d } | | k rã g | | D] } | j | ^ q¡ }
t | d | d |
} | j | n g | d D] } | j | ^ qî }
t | d d | d |
} | j | qd Wd S( NR# t column_namesR~ R4 (
R R t Inspectort from_enginet get_indexesR³ R% R t dropt create(
R¸ R¹ R3 R t inspt real_indexesR; t existing_index_namesR# R% RÈ t old_indext new_index( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt# _restore_indexes_on_deleted_columns s *
$$ c K sè | j d k r t | | | St j j | } | j | } t | | } t d t d t } | j
| d t | j j | j
j | j
j k j d t j | j
j j | j
j j d d t | | | d S( Nt sqlitet old_deletedR| t populate_defaultR# R~ ( R# t- _change_deleted_column_type_to_boolean_sqliteR RÉ RÊ RË R R R R@ RÍ R´ R² R% R~ Rª Rµ R? R° RÌ RÕ t alterRÓ ( R¸ R¹ R£ RÎ R3 R RÕ ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt% change_deleted_column_type_to_boolean+ s
c K sO t j j | } t | | } g } x~ | j D]s } d } | j d k r t | j t rs t
| | j } q | j } n t d t
d d } | j | q1 Wg | j D] } | j ^ q² } | j }
t | d |
| | } | j g } x_ | j | D]N }
g |
d D] } | j | ^ q } | j t |
d d |
d | q
Wg } xO | j D]D } | j d k r| j | qo| j | j j | j j k qoWt | t j j | } | j | | j x | D] }
|
j | qðW| j | | j j | j j | j j k j! d t" j d S( NR~ R| i t __tmp__RÈ R# R4 (# R RÉ RÊ R R2 R' R# R- RÆ R R§ t copyR R R1 R+ R R RÍ RË R% R R~ Rª R R. RY R R° RÌ t renameR´ R² Rµ R? ( R¸ R¹ R£ RÎ R R2 R¥ t column_copyR: R+ R¼ t new_tableR3 R; R% RÈ t c_selectt ins( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR× C sH "
$#
c K sý | j d k r t | | | St j j | } | j | } t | | } t d | j j j
d t | } | j | d t
t
} | j j | j j | k j d | j j j | j j j | j j j d d t | | | d S( NRÔ t new_deletedR| RÖ R# R~ ( R# t- _change_deleted_column_type_to_id_type_sqliteR RÉ RÊ RË R R R% Rª RÆ RÇ RÍ R? R´ R² R~ Rµ R° RÌ Rá RØ RÓ ( R¸ R¹ R£ RÎ R3 R Rá R~ ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt% change_deleted_column_type_to_id_typew s
c C s> t | t s t St | j } t t j d | t j S( Ns .*deleted in \(.*\)( R- R R@ t strt sqltextt boolt reR t I( R: Rå ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _is_deleted_column_constraint s c K si t j j | } t d | } t | | d t } t | } g } x | j D]| } d } | j d k r£ t
| j t r t
| | j } qÁ | j } n t d | j j j d | } | j | qR Wg }
x3 | j D]( } t | sâ |
j | j qâ qâ Wt | d | | |
} | j g }
x_ | j | D]N } g | d D] } | j | ^ qY} |
j t | d d | d | qHWt | | j } | j | | j x |
D] } | j | qÍW| j | t } | j j | j j | k j d | j j j t! } | j j | j j | k j d | j d S( NR R R~ R| RÚ RÈ R# R4 (" R RÉ RÊ R R R? RÇ R2 R' R# R- RÆ R R§ RÛ R R% Rª R1 R+ Ré RÍ RË R R R R° RÌ RÜ R´ R² R~ Rµ R@ ( R¸ R¹ R£ RÎ R¼ R R R2 R¥ RÝ R+ R: RÞ R3 R; R% RÈ Rà R~ ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRâ sR
$
t localhostc C sL i | d 6| d 6| d 6| d 6| d 6} | d k r> d } n d } | | S( sd Get database connection
Try to get a connection with a very specific set of values, if we get
these then we'll run the tests, otherwise they are skipped
DEPRECATED: this function is deprecated and will be removed from oslo_db
in a few releases. Please use the provisioning system for dealing
with URLs and database provisioning.
t backendt usert passwdt hostt databaseRÔ s %(backend)s:///%(database)ss7 %(backend)s://%(user)s:%(passwd)s@%(host)s/%(database)s( ( Rë Rï Rì Rí Rî R t template( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt get_connect_stringà s
c C sq d d l m } t d | d | d | d | } y | j j | } | j Wn t j k
rh t SXt Sd S( sô Return True if the given backend is available.
DEPRECATED: this function is deprecated and will be removed from oslo_db
in a few releases. Please use the provisioning system to access
databases based on backend availability.
iÿÿÿÿ( t provisionRë Rï Rì Rí N(
t oslo_db.sqlalchemyRò Rñ t Backendt _ensure_backend_availablet disposeR t BackendNotAvailableR@ R? ( Rë Rï Rì Rí Rò t connect_urit eng( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt is_backend_availø s c C s | j j d } | j j d } | d } | d j d } | d } d } t | d k rv | d j } n | | | | f S( Nt /t @i i t :RF ( t patht stript netloct splitRJ ( t conn_piecesRï t
loc_piecesRî t auth_piecesRì t password( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt get_db_connection_info s
c C sH t j j | } | j | } g | D] } | d ^ q( } | | k S( s© Check if given index exists.
:param migrate_engine: sqlalchemy engine
:param table_name: name of the table
:param index_name: name of the index
R# ( R RÉ RÊ RË ( R¸ R¹ t
index_namet inspectorR3 R; t index_names( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt index_exists s c C sp t | | } t | | | s\ t | g | D] } t | j | ^ q. } | j n t d | d S( sû Create an index for given columns.
:param migrate_engine: sqlalchemy engine
:param table_name: name of the table
:param index_name: name of the index
:param idx_columns: tuple with names of columns that will be indexed
s Index '%s' already exists!N( R R
R RO R% RÍ RS ( R¸ R¹ R t idx_columnsR t colR; ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt add_index+ s +
c C sT t | | } x> | j D]# } | j | k r | j Pq q Wt d | d S( s¨ Drop index with given name.
:param migrate_engine: sqlalchemy engine
:param table_name: name of the table
:param index_name: name of the index
s Index '%s' not found!N( R R3 R# RÌ RS ( R¸ R¹ R R R; ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt
drop_index= s
c C s' t | | | t | | | | d S( s Change set of columns that are indexed by given index.
:param migrate_engine: sqlalchemy engine
:param table_name: name of the table
:param index_name: name of the index
:param new_columns: tuple with names of columns that will be indexed
N( R R
( R¸ R¹ R t new_columns( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt change_index_columnsM s c C s t | | } | | j k S( s Check if table has given column.
:param engine: sqlalchemy engine
:param table_name: name of the table
:param column: name of the colmn
( R R% ( R R¹ R¥ t t( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt
column_existsY s t DialectFunctionDispatcherc B sh e Z e e d Z e j d Z d Z d Z d Z
d Z d Z d Z
d Z RS( c C s% | r t } n t } | j | S( s Provide dialect-specific functionality within distinct functions.
e.g.::
@dispatch_for_dialect("*")
def set_special_option(engine):
pass
@set_special_option.dispatch_for("sqlite")
def set_sqlite_special_option(engine):
return engine.execute("sqlite thing")
@set_special_option.dispatch_for("mysql+mysqldb")
def set_mysqldb_special_option(engine):
return engine.execute("mysqldb thing")
After the above registration, the ``set_special_option()`` function
is now a dispatcher, given a SQLAlchemy ``Engine``, ``Connection``,
URL string, or ``sqlalchemy.engine.URL`` object::
eng = create_engine('...')
result = set_special_option(eng)
The filter system supports two modes, "multiple" and "single".
The default is "single", and requires that one and only one function
match for a given backend. In this mode, the function may also
have a return value, which will be returned by the top level
call.
"multiple" mode, on the other hand, does not support return
arguments, but allows for any number of matching functions, where
each function will be called::
# the initial call sets this up as a "multiple" dispatcher
@dispatch_for_dialect("*", multiple=True)
def set_options(engine):
# set options that apply to *all* engines
@set_options.dispatch_for("postgresql")
def set_postgresql_options(engine):
# set options that apply to all Postgresql engines
@set_options.dispatch_for("postgresql+psycopg2")
def set_postgresql_psycopg2_options(engine):
# set options that apply only to "postgresql+psycopg2"
@set_options.dispatch_for("*+pyodbc")
def set_pyodbc_options(engine):
# set options that apply to all pyodbc backends
Note that in both modes, any number of additional arguments can be
accepted by member functions. For example, to populate a dictionary of
options, it may be passed in::
@dispatch_for_dialect("*", multiple=True)
def set_engine_options(url, opts):
pass
@set_engine_options.dispatch_for("mysql+mysqldb")
def _mysql_set_default_charset_to_utf8(url, opts):
opts.setdefault('charset', 'utf-8')
@set_engine_options.dispatch_for("sqlite")
def _set_sqlite_in_memory_check_same_thread(url, opts):
if url.database in (None, 'memory'):
opts['check_same_thread'] = False
opts = {}
set_engine_options(url, opts)
The driver specifiers are of the form:
``<database | *>[+<driver | *>]``. That is, database name or "*",
followed by an optional ``+`` sign with driver or "*". Omitting
the driver name implies all drivers for that database.
( t DialectMultiFunctionDispatchert DialectSingleFunctionDispatchert dispatch_for( R t exprt multiple( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt dispatch_for_dialecte s N s ([^+]+?)(?:\+(.+))?$c s f d } | S( Nc sP j \ } } | k r- | j } n | _ j | | | S( N( t _parse_dispatcht _lastt _register( t fnt dbnamet driver( R R ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt decorate¼ s ( ( R R R ( ( R R sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR » s c C sS | j j | } | s+ t d | n | j d p= d | j d pO d f S( Ns$ Couldn't parse database[+driver]: %ri t *i ( t _db_plus_driver_regR RS t group( R R t m( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR Å s c O s) | d } | j | j | | | | S( Ni ( t _dispatch_ont _url_from_target( R R t kwt target( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt __call__Ë s
c C s t | t r | j j St | t j r` d | k rM t j d | } n t j | } | St | t j rv | St d | d S( Ns ://s %s://s Invalid target type: %r(
R- R R R Rx Ry t sa_urlt make_urlt URLRS ( R R( t
target_url( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR& Ð s
c s: j j | j d d \ } f d } | S( sç Return a sub-dispatcher for the given drivername.
This provides a means of calling a different function, such as the
"*" function, for a given target object that normally refers
to a sub-function.
i i c s j d | | S( NR! ( t _dispatch_on_db_driver( R R' ( R R ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt goè s ( R" R R# ( R t
drivernameR R/ ( ( R R sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt dispatch_on_drivernameÞ s $c C sU | j j | j j d d \ } } | s? | j j } n | j | | | | S( Ni i ( R" R R0 R# t get_dialectR R. ( R R R( R R' R R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR% í s
c C s
| | | S( N( ( R R R R' ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt
_invoke_fnõ s ( R R t classmethodR@ R Rç t compileR" R R R) R& R1 R% R3 ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR d s S
R c B s, e Z d Z d Z d Z d Z RS( c C s t j t | _ d S( N( Rv t defaultdictR³ t reg( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR ú s c C s: | j | } | | k r, t d | n | | | <d S( Ns$ Multiple functions for expression %r( R7 R ( R R R R R t fn_dict( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR ý s
c C sm xf | d f D]> } | j | } x( | d f D] } | | k r- | | Sq- Wq
Wt d d | | f d S( NR! s( No default function found for driver: %rs %s+%s( R7 RS ( R R R t dbt subdictt drv( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _matches s
c C s% | j | | } | j | | | S( N( R< R3 ( R R R R R' R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR. s ( R R R R R< R. ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR ù s R c B s, e Z d Z d Z d Z d Z RS( c C s t j d | _ d S( Nc S s
t j t S( N( Rv R6 Rz ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt <lambda> s ( Rv R6 R7 ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR s c C s | j | | j | d S( N( R7 R1 ( R R R R R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR s c c st | d k r | d f } n d } xL | d f D]> } | j | } x( | D] } x | | D] } | VqY WqH Wq. Wd S( NR! ( R! ( R7 ( R R R t driversR9 R: R; R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR< s
c C sK xD | j | | D]0 } | j | | | d k r t d q q Wd S( Ns7 Return value not allowed for multiple filtered function( R< R3 R' R ( R R R R R' R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR. ' s ( R R R R R< R. ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR s t migrate_versiont alembic_versionc C s¤ d } i } | rX t d t | D } d j d | D } | d | 7} n | j j j | d <t | } | j | | } g | D] } | d ^ q S( s÷ Get a list of tables which don't use InnoDB storage engine.
:param connectable: a SQLAlchemy Engine or a Connection instance
:param skip_tables: a list of tables which might have a different
storage engine
s
SELECT table_name
FROM information_schema.tables
WHERE table_schema = :database AND
engine != 'InnoDB'
c s s% | ] \ } } d | | f Vq d S( s skip_%sN( ( R$ Ro R¹ ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pys <genexpr>D s s , c s s | ] } d | Vq d S( Rý N( ( R$ t p( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pys <genexpr>H s s AND table_name NOT IN (%s)Rï i ( R³ t enumerateRT R R Rï R R° ( t connectablet skip_tablest query_strt paramst placeholdersR^ t noninnodbRo ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt get_non_innodb_tables1 s t NonCommittingConnectablec B s; e Z d Z d Z d Z d Z d Z d Z RS( s¢ A ``Connectable`` substitute which rolls all operations back.
``NonCommittingConnectable`` forms the basis of mock
``Engine`` and ``Connection`` objects within a test. It provides
only that part of the API that should reasonably be used within
a single-connection test environment (e.g. no engine.dispose(),
connection.invalidate(), etc. ). The connection runs both within
a transaction as well as a savepoint. The transaction is there
so that any operations upon the connection can be rolled back.
If the test calls begin(), a "pseduo" transaction is returned that
won't actually commit anything. The subtransaction is there to allow
a test to successfully call rollback(), however, where all operations
to that point will be rolled back and the operations can continue,
simulating a real rollback while still remaining within a transaction
external to the test.
c C s& | | _ | j | _ | j d S( N( t
connectiont begint _transt _restart_nested( R RK ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR d s c C s | j j | _ d S( N( RK t begin_nestedt
_nested_trans( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRN i s c C s: | j j s6 | j j | j j | j j n d S( N( RK t closedRP t rollbackRM t close( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt _disposel s
c O s | j j | | | S( sA Executes the given construct and returns a :class:`.ResultProxy`.( RK R° ( R t objt multiparamsRF ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR° r s c O s | j j | | | S( s7 Executes and returns the first column of the first row.( RK t scalar( R RU RV RF ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRW w s ( R R R¡ R RN RT R° RW ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRJ Q s t NonCommittingEnginec B sG e Z d Z e d Z e d Z d Z e j d Z RS( s0 ``Engine`` -specific non committing connectbale.c C s
| j j j S( N( RK R R ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR s c C s | S( N( ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR s c C s
t | j S( N( t NonCommittingConnectionRK ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt connect s c c sM | j } | j } y | VWn t k
r> | j n X| j d S( N( RZ RL t ExceptionRR t commit( R t connt trans( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRL s
(
R R R¡ t propertyR R RZ t
contextlibt contextmanagerRL ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRX } s
RY c B s2 e Z d Z d Z d Z d Z d Z RS( s4 ``Connection`` -specific non committing connectbale.c C s d S( sO Close the 'Connection'.
In this context, close() is a no-op.
N( ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRS s c C s t | | j j S( N( t NonCommittingTransactionRK RL ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRL ¢ s c C s | S( N( ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt __enter__¥ s c G s d S( N( ( R R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt __exit__¨ s ( R R R¡ RS RL Rc Rd ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRY s
Rb c B s; e Z d Z d Z d Z d Z d Z d Z RS( s A wrapper for ``Transaction``.
This is to accommodate being able to guaranteed start a new
SAVEPOINT when a transaction is rolled back.
c C s | | _ | | _ d S( N( t provisionedt transaction( R Re Rf ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR ³ s c C s | S( N( ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRc · s c C sL | d k r> y | j WqH t k
r: | j qH Xn
| j d S( N( R' R\ R[ RR ( R RÆ t valuet traceback( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRd º s
c C s | j j d S( N( Rf R\ ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyR\ Ä s c C s | j j | j j d S( N( Rf RR Re RN ( R ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRR Ç s
( R R R¡ R Rc Rd R\ RR ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyRb ¬ s
( R? R@ (X Rv R` t itertoolst loggingRç t
oslo_utilsR Rx R. R R R t sqlalchemy.engineR R R R* R R R R
R R t sqlalchemy.sql.expressionR
t sqlalchemy.sqlR R R t sqlalchemy.typesR t oslo_dbR t
oslo_db._i18nR R R Ró R RN R¢ t getLoggerR RG R5 R t productR{ RT RU R R< RE R' Ru R} R R R R t objectR R§ RÅ RÇ RÓ RÙ R× Rã Ré Râ Rñ Rú R R
R
R R R R R R R RI RJ RX RY Rb ( ( ( sM /home/tvault/.virtenv/lib/python2.7/site-packages/oslo_db/sqlalchemy/utils.pyt <module> s ( 1 o
p $ 5 4
C
,