B KLc@sdZddlZddlmZddlmZddlmZddlmZdd lmZdd lm Z dd lm Z dd l m Z dd l m Z ddlmZddl mZe jddZejGdddeZdS)aProvides an abstraction for obtaining database schema information. Usage Notes: Here are some general conventions when accessing the low level inspector methods such as get_table_names, get_columns, etc. 1. Inspector methods return lists of dicts in most cases for the following reasons: * They're both standard types that can be serialized. * Using a dict instead of a tuple allows easy expansion of attributes. * Using a list for the outer structure maintains order and is easy to work with (e.g. list comprehension [d['name'] for d in cols]). 2. Records that contain a name, such as the column name in a column record use the key 'name'. So for most return values, each record will have a 'name' attribute.. N) Connectable) Connection)Engine)exc) inspection)sql)util) operators)schema) TypeEngine) topologicalcOs|dd}|dkr&|||f||S|jtdd|Dtdd|Df}||}|dkr~|||f||}|||<|S)N info_cachecss|]}t|tjr|VqdS)N) isinstancer Z string_types).0ar;lib/python3.7/site-packages/sqlalchemy/engine/reflection.py 2szcache..css"|]\}}|dkr||fVqdS)rNr)rkvrrrr3s)get__name__tupleitems)fnselfZconargskwrkeyZretrrrcache+s  r!c@seZdZdZeddddZeddZdd Z d d Z d d Z eeddddZ e eddZe eddZe eddZejddZejddZeddZddZd^d d!Zd_d"d#Zd`d$d%Zdad&d'Zd(d)Z d*d+Z!dbd,d-Z"dcd.d/Z#ddd0d1Z$ded2d3Z%dfd4d5Z&dgd6d7Z'dhd8d9Z(did:d;Z)djdd?Z+dld@dAZ,e-dBdCdDdEZ.dmdHdIZ/dJdKZ0dLdMZ1dNdOZ2dPdQZ3dRe4j5fdSe4j6fdTe4j7fdUe4j8fgZ9dVdWZ:dXdYZ;dZd[ZWytt ||}Wnpt j k r} zNx8| j D].| fdddDqWtt ||}Wdd} ~ XYnXfd d|DdtfgS) aReturn dependency-sorted table and foreign key constraint names in referred to within a particular schema. This will yield 2-tuples of ``(tablename, [(tname, fkname), (tname, fkname), ...])`` consisting of table names in CREATE order grouped with the foreign key constraint names that are not detected as belonging to a cycle. The final element will be ``(None, [(tname, fkname), (tname, fkname), ..])`` which will consist of remaining foreign key constraint names that would require a separate CREATE step after-the-fact, based on dependencies between tables. .. versionadded:: 1.0.- .. seealso:: :meth:`_reflection.Inspector.get_table_names` :func:`.sort_tables_and_constraints` - similar method which works with an already-given :class:`_schema.MetaData`. )rNcSsg|] }|dqS)namer)rZfkrrr Nsz.referred_tablec3s|]}d|fVqdS)rNr)rZfkc)edgerrrXsz;Inspector.get_sorted_table_and_fkc_names..rcsg|]}||fqSr) difference)rtname)fknames_for_tableremaining_fkcsrrrA]s)r7r(r<rsetget_foreign_keysaddlistrsortrZCircularDependencyErrorZedgesremoveupdate) rr r6ZtnamesZtuplesrEfkeysZfkeyZcandidate_sorterrr)rCrFrGrget_sorted_table_and_fkc_names*s.        " z(Inspector.get_sorted_table_and_fkc_namesc Cs&|}|jj||jdSQRXdS)zReturn a list of temporary table names for the current bind. This method is unsupported by most dialects; currently only SQLite implements it. .. versionadded:: 1.0.0 )rN)r7r(get_temp_table_namesr)rr6rrrrRas zInspector.get_temp_table_namesc Cs&|}|jj||jdSQRXdS)zReturn a list of temporary view names for the current bind. This method is unsupported by most dialects; currently only SQLite implements it. .. versionadded:: 1.0.0 )rN)r7r(get_temp_view_namesr)rr6rrrrSps zInspector.get_temp_view_namesc Ks>t|jdr:| }|jj|||fd|ji|SQRXiS)aReturn a dictionary of options specified when the table of the given name was created. This currently includes some options that apply to MySQL tables. :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. get_table_optionsrN)r'r(r7rTr)rr>r rr6rrrrT~s   zInspector.get_table_optionsc Cs(|}|jj|||jdSQRXdS)zReturn all view names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. )rN)r7r(get_view_namesr)rr r6rrrrUs zInspector.get_view_namesc Cs(|}|jj|||jdSQRXdS)zReturn all sequence names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. )rN)r7r(get_sequence_namesr)rr r6rrrrVs zInspector.get_sequence_namesc Cs*|}|jj||||jdSQRXdS)zReturn definition for `view_name`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. )rN)r7r(get_view_definitionr)rZ view_namer r6rrrrWs zInspector.get_view_definitionc Ks`|$}|jj|||fd|ji|}WdQRXx(|D] }|d}t|ts8||d<q8W|S)aReturn information about columns in `table_name`. Given a string `table_name` and an optional string `schema`, return column information as a list of dicts with these keys: * ``name`` - the column's name * ``type`` - the type of this column; an instance of :class:`~sqlalchemy.types.TypeEngine` * ``nullable`` - boolean flag if the column is NULL or NOT NULL * ``default`` - the column's server default value - this is returned as a string SQL expression. * ``autoincrement`` - indicates that the column is auto incremented - this is returned as a boolean or 'auto' * ``comment`` - (optional) the comment on the column. Only some dialects return this key * ``computed`` - (optional) when present it indicates that this column is computed by the database. Only some dialects return this key. Returned as a dict with the keys: * ``sqltext`` - the expression used to generate this column returned as a string SQL expression * ``persisted`` - (optional) boolean that indicates if the column is stored in the table .. versionadded:: 1.3.16 - added support for computed reflection. * ``identity`` - (optional) when present it indicates that this column is a generated always column. Only some dialects return this key. For a list of keywords on this dict see :class:`_schema.Identity`. .. versionadded:: 1.4 - added support for identity column reflection. * ``dialect_options`` - (optional) a dict with dialect specific options :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :return: list of dictionaries, each representing the definition of a database column. rNtype)r7r( get_columnsrrr )rr>r rr6Zcol_defsZcol_defcoltyperrrrYs6 "  zInspector.get_columnsc Ks2| }|jj|||fd|ji|SQRXdS)aReturn information about primary key constraint on `table_name`. Given a string `table_name`, and an optional string `schema`, return primary key information as a dictionary with these keys: * ``constrained_columns`` - a list of column names that make up the primary key * ``name`` - optional name of the primary key constraint. :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. rN)r7r(get_pk_constraintr)rr>r rr6rrrr[s zInspector.get_pk_constraintc Ks2| }|jj|||fd|ji|SQRXdS)aReturn information about foreign_keys in `table_name`. Given a string `table_name`, and an optional string `schema`, return foreign key information as a list of dicts with these keys: * ``constrained_columns`` - a list of column names that make up the foreign key * ``referred_schema`` - the name of the referred schema * ``referred_table`` - the name of the referred table * ``referred_columns`` - a list of column names in the referred table that correspond to constrained_columns * ``name`` - optional name of the foreign key constraint. :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. rN)r7r(rIr)rr>r rr6rrrrIs zInspector.get_foreign_keysc Ks2| }|jj|||fd|ji|SQRXdS)aReturn information about indexes in `table_name`. Given a string `table_name` and an optional string `schema`, return index information as a list of dicts with these keys: * ``name`` - the index's name * ``column_names`` - list of column names in order * ``unique`` - boolean * ``column_sorting`` - optional dict mapping column names to tuple of sort keywords, which may include ``asc``, ``desc``, ``nulls_first``, ``nulls_last``. .. versionadded:: 1.3.5 * ``dialect_options`` - dict of dialect-specific index options. May not be present for all dialects. .. versionadded:: 1.0.0 :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. rN)r7r( get_indexesr)rr>r rr6rrrr\8s$ zInspector.get_indexesc Ks2| }|jj|||fd|ji|SQRXdS)aReturn information about unique constraints in `table_name`. Given a string `table_name` and an optional string `schema`, return unique constraint information as a list of dicts with these keys: * ``name`` - the unique constraint's name * ``column_names`` - list of column names in order :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. rN)r7r(get_unique_constraintsr)rr>r rr6rrrr]as z Inspector.get_unique_constraintsc Ks2| }|jj|||fd|ji|SQRXdS)aReturn information about the table comment for ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return table comment information as a dictionary with these keys: * ``text`` - text of the comment. Raises ``NotImplementedError`` for a dialect that does not support comments. .. versionadded:: 1.2 rN)r7r(get_table_commentr)rr>r rr6rrrr^{s zInspector.get_table_commentc Ks2| }|jj|||fd|ji|SQRXdS)acReturn information about check constraints in `table_name`. Given a string `table_name` and an optional string `schema`, return check constraint information as a list of dicts with these keys: * ``name`` - the check constraint's name * ``sqltext`` - the check constraint's SQL expression * ``dialect_options`` - may or may not be present; a dictionary with additional dialect-specific options for this CHECK constraint .. versionadded:: 1.3.8 :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. .. versionadded:: 1.1.0 rN)r7r(get_check_constraintsr)rr>r rr6rrrr_s zInspector.get_check_constraintsz*:meth:`_reflection.Inspector.reflecttable`zThe :meth:`_reflection.Inspector.reflecttable` method was renamed to :meth:`_reflection.Inspector.reflect_table`. This deprecated alias will be removed in a future release.cOs |j||S)z1See reflect_table. This method name is deprecated) reflect_table)rrkwargsrrr reflecttables zInspector.reflecttablerTc s|dk r|krdS||jj}|}|}WdQRXj} tfdd|jD} |j| |fj } | r | t j rt |tr||j}t | tr| |j} d} i} x0|j| |fj D]}d} ||||| qW| s || |s t| || || ||| || ||||| || || ||| || || ||| || || ||| || || dS)aZGiven a :class:`_schema.Table` object, load its internal constructs based on introspection. This is the underlying method used by most dialects to produce table reflection. Direct usage is like:: from sqlalchemy import create_engine, MetaData, Table from sqlalchemy import inspect engine = create_engine('...') meta = MetaData() user_table = Table('user', meta) insp = inspect(engine) insp.reflect_table(user_table, None) .. versionchanged:: 1.4 Renamed from ``reflecttable`` to ``reflect_table`` :param table: a :class:`~sqlalchemy.schema.Table` instance. :param include_columns: a list of string column names to include in the reflection process. If ``None``, all columns are reflected. Nc3s(|] }|jkr|j|fVqdS)N)dialect_kwargsr)rr)tablerrrsz*Inspector.reflect_table..FT)rJr$r(r7Zschema_for_objectr@dictreflection_optionsrTrcZ_validate_dialect_kwargsr Zpy2krstrdecodeencodingrY_reflect_columnr=rZNoSuchTableError _reflect_pk _reflect_fk_reflect_indexes_reflect_unique_constraints_reflect_check_constraints_reflect_table_comment)rrdinclude_columnsexclude_columns resolve_fks _extend_onr(r6r r>rfZtbl_optsZ found_tablecols_by_orig_namecol_dr)rdrr`s            zInspector.reflect_tablecsd}|jj|||j||d}|r>||ksJ|rN||krNdSd}tfdddD} dkr| dg} ddk rd} t| tjj rt j | dd } n$t| t j st j t ddd } | | d kr t jfd } | | d kr0t jfd } | | d krF|| t j||f| | ||<} | j|jkrvd| _|j| dd dS)Nr@rXc3s"|]}|kr||fVqdS)Nr)rr)rvrrr]sz,Inspector._reflect_column..)ZnullableZ autoincrementZquoteinfor commentdialect_optionsdefaultT)Z _reflectedcomputedZidentitysequence)Zreplace_existing)metadatadispatchZcolumn_reflectrerNrrr elementsZ TextClause sa_schemaZ DefaultClauseZ FetchedValuetextappendZComputedZIdentity_reflect_col_sequenceZColumnr primary_keyZ append_column)rrdrvrqrrruZ orig_namer@rZZcol_kwcolargsrzr{colr)rvrrjIsF            zInspector._reflect_columncCsTd|krP|d}t|ddd}d|kr4|d|_d|krF|d|_||dS)Nr|r@rstart increment)rSequencerrr)rrvrseqr|rrrrs  zInspector._reflect_col_sequencecsL|j||f|j}|rHfdd|dD}|d|j_|j|dS)Ncs$g|]}|kr|kr|qSrr)rZpk)rurrrrrAsz)Inspector._reflect_pk..constrained_columnsr@)r[rcrrr@Z_reload)rr>r rdrurrZpk_consZpk_colsr)rurrrrks  zInspector._reflect_pkc  sZ|j||f|j} x@| D]6} | d} fdd| dD} |rPt| |s|rdt| |rdq| d}| d}| d}g}|dk r|rtj||jf||j|d| xl|D]}| d |||gqWnH|rtj||jf|jtj |d | x |D]}| d ||gqWd | kr.| d }ni}| tj | || fd d i|qWdS)Nr@cs"g|]}|kr|jn|qSr)r )rc)rurrrAsz)Inspector._reflect_fk..rreferred_schemarBreferred_columns)r autoload_withrt.)rr rtoptionsZ link_to_nameT)rIrcrH intersectionrDrZTabler}r$rjoinZ BLANK_SCHEMAappend_constraintZForeignKeyConstraint)rr>r rdrurqrrrsrtrfrOZfkey_dconnamerrrBrZrefspeccolumnrr)rurrls^       zInspector._reflect_fkZascZdescZ nulls_firstZ nulls_lastc Cs`|||}xL|D]B} | d} | d} | di} | d} | dd}| di}| d}|rt| |std |d | fq|rqg}x| D]}y||kr||n|j|}Wn*tk rtd |||fwYnX| |d }x"|j D]\}}||kr||}qW| |qWt j | f|d |it t|d| fgqWdS)Nr@ column_namescolumn_sortinguniquerXindexryZduplicates_constraintz5Omitting %s key for (%s), key covers omitted columns.z, z5%s key '%s' was not located in columns for table '%s'rZ_table)r\rrHissubsetr warnrrKeyError_index_sort_exprsrrZIndexrerKr)rr>r rdrurqrrrfZindexesZindex_dr@columnsrrZflavorry duplicatesZidx_colsrZidx_colZ c_sortingroprrrrmsH        zInspector._reflect_indexesc Csy|||}Wntk r$dSXx|D]} | d} | d} | d} |rrt| |srtdd| q,| rxq,g} x\| D]T}y||kr||n|j|}Wn&t k rtd||fYqX| |qW| t j | d| iq,WdS)Nr@rZduplicates_indexzDOmitting unique constraint key for (%s), key covers omitted columns.z, zDunique constraint key '%s' was not located in columns for table '%s')r]NotImplementedErrorrrHrr rrrrrrrZUniqueConstraint)rr>r rdrurqrrrf constraintsconst_drrrZconstrained_colsrZconstrained_colrrrrn:s6    z%Inspector._reflect_unique_constraintsc CsJy|||}Wntk r$dSXx|D]} |tjf| q,WdS)N)r_rrrZCheckConstraint) rr>r rdrurqrrrfrrrrrroms  z$Inspector._reflect_check_constraintscCs8y|||}Wntk r$dSX|dd|_dS)Nr)r^rrrx)rr>r rdrfZ comment_dictrrrrps z Inspector._reflect_table_comment)N)N)N)N)N)N)N)N)N)N)N)N)N)N)N)rTN)>r __module__ __qualname____doc__r Z deprecatedr% classmethodr+r#r-r,r2rZ _inspectsrr3rr4rr5 contextlibcontextmanagerr7r9propertyr:r;r<r=r?rQrRrSrTrUrVrWrYr[rIr\r]r^r_Z deprecated_20rbr`rjrrkrlr Zasc_opZdesc_opZnulls_first_opZ nulls_last_oprrmrnrorprrrrr"<sn     7  A  $ )   "  B P :3r")rrbaserrrrrr r r r rZ sql.type_apir rZ decoratorr!Z_self_inspectsobjectr"rrrrs