o "hw&@sdZddlmZddlZddlmZddlmZddlmZddlm Z ddl m Z dd l m Z dd l m Z dd l mZdd l mZdd l mZddl mZddl mZddl mZddl mZddl mZddl mZddl mZddl mZddlmZddlmZddlmZddlmZddlmZddlm Z ddlm!Z!ddlm"Z#dd l$m%Z%dd!l&m'Z'dd"l&m(Z(dd#l)m*Z*dd$l+m,Z,dd%l m-Z-dd&l.m/Z/er dd'l0m1Z1dd(l0m2Z2dd)l0m3Z3dd*l0m4Z4dd+l0m5Z5dd,l0m6Z6dd-l0m7Z7dd.l0m8Z8dd/l0m9Z9ed0Z:e j;dLd;d<Ze GdDdEdEeZ?ej@GdFdGdGejAdGZBe/GdHdIdIZCeGdJdKdKZDdS)NaProvides 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.. ) annotationsN) dataclass)auto)Flag)unique)Any)Callable) Collection)Dict) Generator)Iterable)List)Optional)Sequence)Set)Tuple) TYPE_CHECKING)TypeVar)Union) Connection)Engine)exc) inspection)sql)util) operators)schema)_ad_hoc_cache_key_from_args) quoted_name) TextClause) TypeEngine)InternalTraversal) topological)final)Dialect)ReflectedCheckConstraint)ReflectedColumn)ReflectedForeignKeyConstraint)ReflectedIndex)ReflectedPrimaryKeyConstraint)ReflectedTableComment)ReflectedUniqueConstraint)TableKey_RfnCallable[..., _R]selfr&conrargsrkwreturncs|dd}|dur|||g|Ri|Sddh|jtdd|Dtfdd|Df}||}|durK|||g|Ri|}|||<|S)N info_cache unreflectablecss6|]}t|trt|trt||jfn|VqdSN) isinstancestrr quote).0ar?q/var/www/project2/testadmin.ninositsolution.com/venv/lib/python3.10/site-packages/sqlalchemy/engine/reflection.py ]s zcache..c3s<|]\}}|vr|t|trt||jfn|fVqdSr9)r:r r;r<)r=kvexcluder?r@rAbs)get__name__tupleitemsr0r2r3r4r5r7keyretr?rDr@cacheOs"   rM traverse_argsTuple[str, InternalTraversal]0Callable[[Callable[..., _R]], Callable[..., _R]]cstjdfd d }|S)Nr0r1r2r&r3rr4rr5r6r/csr|dd}|dur|||g|Ri|St|jf|}||}|dur7|||g|Ri|}|||<|S)Nr7)rFrrGrJrNr?r@gors  zflexi_cache..go r0r1r2r&r3rr4rr5rr6r/)r decorator)rNrRr?rQr@ flexi_cacheosrUc@s>eZdZdZeZ eZ eZ eeBZ eeBeBZ dS) ObjectKindaEnumerator that indicates which kind of object to return when calling the ``get_multi`` methods. This is a Flag enum, so custom combinations can be passed. For example, to reflect tables and plain views ``ObjectKind.TABLE | ObjectKind.VIEW`` may be used. .. note:: Not all dialect may support all kind of object. If a dialect does not support a particular object an empty dict is returned. In case a dialect supports an object, but the requested method is not applicable for the specified kind the default value will be returned for each reflected object. For example reflecting check constraints of view return a dict with all the views with empty lists as values. N) rG __module__ __qualname____doc__rTABLEVIEWMATERIALIZED_VIEWANY_VIEWANYr?r?r?r@rVs rVc@s(eZdZdZeZ eZ eeBZdS) ObjectScopez]Enumerator that indicates which scope to use when calling the ``get_multi`` methods. N)rGrWrXrYrDEFAULT TEMPORARYr^r?r?r?r@r_sr_c@sheZdZUdZded<ded<ded<ded <d ed <ed d dddZedddZ dddZ dddZ dddZ dddZ eed d dd!d"Zeedd#d$Zeedd%d&Zejdd(d)Zejdd+d,Zedd.d/Zdd3d4Z 5dIdd7d8Z 5dIdd;d<Z 5dIdd>d?Z 5dIddAdBZddDdEZ 5dIddGdHZ! IdddMdNZ"ddOdPZ#ddQdRZ$ 5dIddTdUZ%d5d5e&j'e(j)fdd]d^Z* 5dIdd_d`Z+ 5dIddadbZ, 5dIddcddZ- 5dIddfdgZ. 5dIddidjZ/ddmdnZ0d5d5e&j'e(j)fddpdqZ1 5dIddsdtZ2d5d5e&j'e(j)fddvdwZ3 5dIddydzZ4d5d5e&j'e(j)fdd|d}Z5 5dIdddZ6d5d5e&j'e(j)fdddZ7 5dIdddZ8d5d5e&j'e(j)fdddZ9 5dIdddZ:d5d5e&j'e(j)fdddZ; 5dIdddZdddZ?dddZ@dddZAeBjCeBjDeBjEeBjFdZGdddZHdddZIdddZJdddZK 5 5 5 5ddddZLd5S) Inspectora=Performs database schema inspection. The Inspector acts as a proxy to the reflection methods of the :class:`~sqlalchemy.engine.interfaces.Dialect`, providing a consistent interface as well as caching support for previously fetched metadata. A :class:`_reflection.Inspector` object is usually created via the :func:`_sa.inspect` function, which may be passed an :class:`_engine.Engine` or a :class:`_engine.Connection`:: from sqlalchemy import inspect, create_engine engine = create_engine("...") insp = inspect(engine) Where above, the :class:`~sqlalchemy.engine.interfaces.Dialect` associated with the engine may opt to return an :class:`_reflection.Inspector` subclass that provides additional methods specific to the dialect's target database. Union[Engine, Connection]bindrenginebool_op_context_requires_connectr&dialectzDict[Any, Any]r7z1.4aThe __init__() method on :class:`_reflection.Inspector` is deprecated and will be removed in a future release. Please use the :func:`.sqlalchemy.inspect` function on an :class:`_engine.Engine` or :class:`_engine.Connection` in order to acquire an :class:`_reflection.Inspector`.cCs||dS)aInitialize a new :class:`_reflection.Inspector`. :param bind: a :class:`~sqlalchemy.engine.Connection`, which is typically an instance of :class:`~sqlalchemy.engine.Engine` or :class:`~sqlalchemy.engine.Connection`. For a dialect-specific instance of :class:`_reflection.Inspector`, see :meth:`_reflection.Inspector.from_engine` N) _init_legacyr2rdr?r?r@__init__szInspector.__init__initCallable[..., Any]r6cCs,t|jdr |jj}||}||||S)N inspector)hasattrrhrn__new__)clsrlrdr2r?r?r@ _constructs   zInspector._constructNonecCs&t|dr ||dS||dS)Nexec_driver_sql)ro_init_connection _init_enginerjr?r?r@ris zInspector._init_legacycCs2||_|_|d|_|jj|_i|_dS)NT)rdreconnectclosergrhr7)r2rer?r?r@rvs    zInspector._init_engine connectionrcCs(||_|j|_d|_|jj|_i|_dS)NF)rdrergrhr7)r2ryr?r?r@rus   zInspector._init_connectioncCs|jdS)zreset the cache for this :class:`.Inspector`. Inspection methods that have data cached will emit SQL queries when next called to get new data. .. versionadded:: 2.0 N)r7clearr2r?r?r@ clear_cache s zInspector.clear_cacheaThe from_engine() method on :class:`_reflection.Inspector` is deprecated and will be removed in a future release. Please use the :func:`.sqlalchemy.inspect` function on an :class:`_engine.Engine` or :class:`_engine.Connection` in order to acquire an :class:`_reflection.Inspector`.cCs||j|S)aZConstruct a new dialect-specific Inspector object from the given engine or connection. :param bind: a :class:`~sqlalchemy.engine.Connection` or :class:`~sqlalchemy.engine.Engine`. This method differs from direct a direct constructor call of :class:`_reflection.Inspector` in that the :class:`~sqlalchemy.engine.interfaces.Dialect` is given a chance to provide a dialect-specific :class:`_reflection.Inspector` instance, which may provide additional methods. See the example at :class:`_reflection.Inspector`. )rrri)rqrdr?r?r@ from_engineszInspector.from_enginecCttj|Sr9)rbrrrvrdr?r?r@ _engine_insp7zInspector._engine_inspcCr~r9)rbrrrurr?r?r@_connection_insp;rzInspector._connection_insp!Generator[Connection, None, None]ccsL|jr |j}n|j}z|VW|jr|dSdS|jr%|ww)aReturn a context that optimizes for multiple operations on a single transaction. This essentially allows connect()/close() to be called if we detected that we're against an :class:`_engine.Engine` and not a :class:`_engine.Connection`. N)rgrdrwrx)r2connr?r?r@_operation_context?s   zInspector._operation_context Generator[Inspector, None, None]ccsN|}||jj|}|j|_|VWddS1s wYdS)zReturn an :class:`_reflection.Inspector` from this one that will run all operations on a single connection. N)rrr __class__rur7)r2rsub_inspr?r?r@_inspection_contextTs  "zInspector._inspection_context Optional[str]cCs|jjS)zReturn the default schema name presented by the dialect for the current engine's database user. E.g. this is typically ``public`` for PostgreSQL and ``dbo`` for SQL Server. )rhdefault_schema_namer{r?r?r@ras zInspector.default_schema_namer5r List[str]cKF|}|jj|fd|ji|WdS1swYdS)zReturn all schema names. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. r7N)rrhget_schema_namesr7r2r5rr?r?r@rls $zInspector.get_schema_namesNrcKH|}|jj||fd|ji|WdS1swYdS)aReturn all table names within a particular schema. The names are expected to be real tables only, not views. Views are instead returned using the :meth:`_reflection.Inspector.get_view_names` and/or :meth:`_reflection.Inspector.get_materialized_view_names` methods. :param schema: Schema name. If ``schema`` is left at ``None``, the database's default schema is used, else the named schema is searched. If the database does not support named schemas, behavior is undefined if ``schema`` is not passed as ``None``. For special quoting, use :class:`.quoted_name`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. seealso:: :meth:`_reflection.Inspector.get_sorted_table_and_fkc_names` :attr:`_schema.MetaData.sorted_tables` r7N)rrhget_table_namesr7r2rr5rr?r?r@rys $zInspector.get_table_names table_namer;cKJ|}|jj|||fd|ji|WdS1swYdS)aReturn True if the backend has a table, view, or temporary table of the given name. :param table_name: name of the table to check :param schema: schema name to query, if not the default schema. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionadded:: 1.4 - the :meth:`.Inspector.has_table` method replaces the :meth:`_engine.Engine.has_table` method. .. versionchanged:: 2.0:: :meth:`.Inspector.has_table` now formally supports checking for additional table-like objects: * any type of views (plain or materialized) * temporary tables of any kind Previously, these two checks were not formally specified and different dialects would vary in their behavior. The dialect testing suite now includes tests for all of these object types and should be supported by all SQLAlchemy-included dialects. Support among third party dialects may be lagging, however. r7N)rrh has_tabler7r2rrr5rr?r?r@rs $zInspector.has_table sequence_namecKr)aReturn True if the backend has a sequence with the given name. :param sequence_name: name of the sequence to check :param schema: schema name to query, if not the default schema. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionadded:: 1.4 r7N)rrh has_sequencer7)r2rrr5rr?r?r@rs $zInspector.has_sequence index_namecKsL|}|jj||||fd|ji|WdS1swYdS)aCheck the existence of a particular index name in the database. :param table_name: the name of the table the index belongs to :param index_name: the name of the index to check :param schema: schema name to query, if not the default schema. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionadded:: 2.0 r7N)rrh has_indexr7)r2rrrr5rr?r?r@rs $zInspector.has_index schema_namecKr)aTReturn True if the backend has a schema with the given name. :param schema_name: name of the schema to check :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionadded:: 2.0 r7N)rrh has_schemar7)r2rr5rr?r?r@rs $zInspector.has_schema;List[Tuple[Optional[str], List[Tuple[str, Optional[str]]]]]cKsdd|j|fdDS)agReturn 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. :param schema: schema name to query, if not the default schema. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. seealso:: :meth:`_reflection.Inspector.get_table_names` :func:`.sort_tables_and_constraints` - similar method which works with an already-given :class:`_schema.MetaData`. cSs.g|]\}}|r |dnddd|DfqS)rNcSsg|] \\}}}||fqSr?r?)r=_tnamefksr?r?r@ szGInspector.get_sorted_table_and_fkc_names...r?)r= table_key fk_collectionr?r?r@rs z.)consider_schemas)%sort_tables_on_foreign_key_dependency)r2rr5r?r?r@get_sorted_table_and_fkc_namess  z(Inspector.get_sorted_table_and_fkc_namesr9rCollection[Optional[str]]gList[Tuple[Optional[Tuple[Optional[str], str]], List[Tuple[Tuple[Optional[str], str], Optional[str]]]]]c s^ttttf}t}tig}|D]F}|j|fi|}|||D]1\\}} } dd| D|| f<| D]} | | dksI|| dkrX|| d| df|| ffq;q(qz tt ||} Wn6t j y} z)| j D]|fdddDqqtt ||} WYd} ~ nd} ~ wwfd d | D}|dtfgS) aReturn dependency-sorted table and foreign key constraint names referred to within multiple schemas. This method may be compared to :meth:`.Inspector.get_sorted_table_and_fkc_names`, which works on one schema at a time; here, the method is a generalization that will consider multiple schemas at once including that it will resolve for cross-schema foreign keys. .. versionadded:: 2.0 cSsh|]}|dqS)namer?r=fkr?r?r@ IszBInspector.sort_tables_on_foreign_key_dependency..referred_tablereferred_schemac3s|] }d|fVqdS)rNr?)r=fkc)edger?r@rA`s  zBInspector.sort_tables_on_foreign_key_dependency..rNcsDg|]\ffddfddDDfqS)csg|]}f|fqSr?r?rschnamerr?r@rks zNInspector.sort_tables_on_foreign_key_dependency...css|]\}}|VqdSr9r?)r=rrr?r?r@rAms zMInspector.sort_tables_on_foreign_key_dependency...) difference)r=)fknames_for_tableremaining_fkcsrr@rhs  zCInspector.sort_tables_on_foreign_key_dependency..)rrr;setget_multi_foreign_keysextendrIaddlistr$sortrCircularDependencyErroredgesremoveupdate)r2rr5 SchemaTabtuplestnamesr schema_fkeysrrfkeysfkeycandidate_sorterrrLr?)rrrr@r(sP          z/Inspector.sort_tables_on_foreign_key_dependencycKr)aReturn a list of temporary table names for the current bind. This method is unsupported by most dialects; currently only Oracle Database, PostgreSQL and SQLite implements it. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. r7N)rrhget_temp_table_namesr7rr?r?r@rvs $zInspector.get_temp_table_namescKr)anReturn a list of temporary view names for the current bind. This method is unsupported by most dialects; currently only PostgreSQL and SQLite implements it. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. r7N)rrhget_temp_view_namesr7rr?r?r@rs $zInspector.get_temp_view_namesDict[str, Any]cKr)azReturn a dictionary of options specified when the table of the given name was created. This currently includes some options that apply to MySQL and Oracle Database 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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dict with the table options. The returned keys depend on the dialect in use. Each one is prefixed with the dialect name. .. seealso:: :meth:`Inspector.get_multi_table_options` r7N)rrhget_table_optionsr7rr?r?r@r $zInspector.get_table_options filter_namesOptional[Sequence[str]]kindrVscoper_Dict[TableKey, Dict[str, Any]]c KsV|}|jj|f|||||jd|}t|WdS1s$wYdS)aReturn a dictionary of options specified when the tables in the given schema were created. The tables can be filtered by passing the names to use to ``filter_names``. This currently includes some options that apply to MySQL and Oracle tables. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if options of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are dictionaries with the table options. The returned keys in each dict depend on the dialect in use. Each one is prefixed with the dialect name. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_table_options` rrrrr7N)rrhget_multi_table_optionsr7dict)r2rrrrr5rresr?r?r@rs - $z!Inspector.get_multi_table_optionscKr)aReturn all non-materialized view names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionchanged:: 2.0 For those dialects that previously included the names of materialized views in this list (currently PostgreSQL), this method no longer returns the names of materialized views. the :meth:`.Inspector.get_materialized_view_names` method should be used instead. .. seealso:: :meth:`.Inspector.get_materialized_view_names` r7N)rrhget_view_namesr7rr?r?r@rs $zInspector.get_view_namescKr)aReturn all materialized view names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. .. versionadded:: 2.0 .. seealso:: :meth:`.Inspector.get_view_names` r7N)rrhget_materialized_view_namesr7rr?r?r@r s $z%Inspector.get_materialized_view_namescKr)akReturn all sequence names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. r7N)rrhget_sequence_namesr7rr?r?r@r$s $zInspector.get_sequence_names view_namecKr)aReturn definition for the plain or materialized view called ``view_name``. :param view_name: Name of the view. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. r7N)rrhget_view_definitionr7)r2rrr5rr?r?r@r6s $zInspector.get_view_definitionList[ReflectedColumn]cKsZ|}|jj|||fd|ji|}Wdn1swY|r+||g|S)aJReturn information about columns in ``table_name``. Given a string ``table_name`` and an optional string ``schema``, return column information as a list of :class:`.ReflectedColumn`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: list of dictionaries, each representing the definition of a database column. .. seealso:: :meth:`Inspector.get_multi_columns`. r7N)rrh get_columnsr7_instantiate_types)r2rrr5rcol_defsr?r?r@rJs  zInspector.get_columnsdataIterable[List[ReflectedColumn]]cCs4|D]}|D]}|d}t|ts||d<qqdS)Ntype)r:r")r2rrcol_defcoltyper?r?r@rls  zInspector._instantiate_types%Dict[TableKey, List[ReflectedColumn]]c Ks`|}t|jj|f|||||jd|}Wdn1s"wY|||S)aWReturn information about columns in all objects in the given schema. The objects can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedColumn`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if columns of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are list of dictionaries, each representing the definition of a database column. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_columns` rN)rrrhget_multi_columnsr7rvalues)r2rrrrr5rtable_col_defsr?r?r@rvs" , zInspector.get_multi_columnsr+cKr)a`Return information about primary key constraint in ``table_name``. Given a string ``table_name``, and an optional string `schema`, return primary key information as a :class:`.ReflectedPrimaryKeyConstraint`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary representing the definition of a primary key constraint. .. seealso:: :meth:`Inspector.get_multi_pk_constraint` r7N)rrhget_pk_constraintr7rr?r?r@rs $zInspector.get_pk_constraint-Dict[TableKey, ReflectedPrimaryKeyConstraint]c KR|}t|jj|f|||||jd|WdS1s"wYdS)auReturn information about primary key constraints in all tables in the given schema. The tables can be filtered by passing the names to use to ``filter_names``. For each table the value is a :class:`.ReflectedPrimaryKeyConstraint`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if primary keys of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are dictionaries, each representing the definition of a primary key constraint. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_pk_constraint` rN)rrrhget_multi_pk_constraintr7r2rrrrr5rr?r?r@rs +$z!Inspector.get_multi_pk_constraint#List[ReflectedForeignKeyConstraint]cKr)agReturn 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 :class:`.ReflectedForeignKeyConstraint`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a list of dictionaries, each representing the a foreign key definition. .. seealso:: :meth:`Inspector.get_multi_foreign_keys` r7N)rrhget_foreign_keysr7rr?r?r@rrzInspector.get_foreign_keys3Dict[TableKey, List[ReflectedForeignKeyConstraint]]c Kr)aoReturn information about foreign_keys in all tables in the given schema. The tables can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedForeignKeyConstraint`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if foreign keys of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are list of dictionaries, each representing a foreign key definition. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_foreign_keys` rN)rrrhrr7rr?r?r@r% -$z Inspector.get_multi_foreign_keysList[ReflectedIndex]cKr)a=Return information about indexes in ``table_name``. Given a string ``table_name`` and an optional string `schema`, return index information as a list of :class:`.ReflectedIndex`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a list of dictionaries, each representing the definition of an index. .. seealso:: :meth:`Inspector.get_multi_indexes` r7N)rrh get_indexesr7rr?r?r@r_s $zInspector.get_indexes$Dict[TableKey, List[ReflectedIndex]]c Kr)aPReturn information about indexes in in all objects in the given schema. The objects can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedIndex`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if indexes of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are list of dictionaries, each representing the definition of an index. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_indexes` rN)rrrhget_multi_indexesr7rr?r?r@r}s ,$zInspector.get_multi_indexesList[ReflectedUniqueConstraint]cKr)a~Return 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 :class:`.ReflectedUniqueConstraint`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a list of dictionaries, each representing the definition of an unique constraint. .. seealso:: :meth:`Inspector.get_multi_unique_constraints` r7N)rrhget_unique_constraintsr7rr?r?r@rrz Inspector.get_unique_constraints/Dict[TableKey, List[ReflectedUniqueConstraint]]c Kr)aReturn information about unique constraints in all tables in the given schema. The tables can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedUniqueConstraint`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if constraints of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are list of dictionaries, each representing the definition of an unique constraint. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_unique_constraints` rN)rrrhget_multi_unique_constraintsr7rr?r?r@rrz&Inspector.get_multi_unique_constraintsr,cKr)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 :class:`.ReflectedTableComment`. Raises ``NotImplementedError`` for a dialect that does not support comments. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary, with the table comment. .. versionadded:: 1.2 .. seealso:: :meth:`Inspector.get_multi_table_comment` r7N)rrhget_table_commentr7rr?r?r@rs $zInspector.get_table_comment%Dict[TableKey, ReflectedTableComment]c Kr)aReturn information about the table comment in all objects in the given schema. The objects can be filtered by passing the names to use to ``filter_names``. For each table the value is a :class:`.ReflectedTableComment`. Raises ``NotImplementedError`` for a dialect that does not support comments. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if comments of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are dictionaries, representing the table comments. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_table_comment` rN)rrrhget_multi_table_commentr7rr?r?r@r1s /$z!Inspector.get_multi_table_commentList[ReflectedCheckConstraint]cKr)ayReturn 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 :class:`.ReflectedCheckConstraint`. :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`. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a list of dictionaries, each representing the definition of a check constraints. .. seealso:: :meth:`Inspector.get_multi_check_constraints` r7N)rrhget_check_constraintsr7rr?r?r@rmrzInspector.get_check_constraints.Dict[TableKey, List[ReflectedCheckConstraint]]c Kr)aReturn information about check constraints in all tables in the given schema. The tables can be filtered by passing the names to use to ``filter_names``. For each table the value is a list of :class:`.ReflectedCheckConstraint`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`. :param filter_names: optionally return information only for the objects listed here. :param kind: a :class:`.ObjectKind` that specifies the type of objects to reflect. Defaults to ``ObjectKind.TABLE``. :param scope: a :class:`.ObjectScope` that specifies if constraints of default, temporary or any tables should be reflected. Defaults to ``ObjectScope.DEFAULT``. :param \**kw: Additional keyword argument to pass to the dialect specific implementation. See the documentation of the dialect in use for more information. :return: a dictionary where the keys are two-tuple schema,table-name and the values are list of dictionaries, each representing the definition of a check constraints. The schema is ``None`` if no schema is provided. .. versionadded:: 2.0 .. seealso:: :meth:`Inspector.get_check_constraints` rN)rrrhget_multi_check_constraintsr7rr?r?r@rrz%Inspector.get_multi_check_constraintsr?Ttablesa_schema.Tableinclude_columnsOptional[Collection[str]]exclude_columnsCollection[str] resolve_fks _extend_onOptional[Set[sa_schema.Table]] _reflect_infoOptional[_ReflectionInfo]c s|dur|vr dS||jj}| }|} Wdn1s'wYj} fdd|jD} | | f} |dusF| |jvrX|j| f| gt j t j |dj }| |j vrb|j | | |jvrlt| |jr||j| } | r|| d}i}|j| D] }d}|||||q|s|| | st| ||| ||||| |||||| ||| |||| ||| |||| ||| |||| ||| | 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. Ncs$i|]}|jvr|j|qSr?)dialect_kwargsrFr=rBrr?r@ s   z+Inspector.reflect_table..)rrrr FT)rrdrhrschema_for_objectrreflection_optionscolumns_get_reflection_inforVr^r_r r8rNoSuchTableError table_optionsrF_validate_dialect_kwargs_reflect_columnr _reflect_pk _reflect_fk_reflect_indexes_reflect_unique_constraints_reflect_check_constraints_reflect_table_comment)r2rrrrrr rhrrrrrtbl_opts found_tablecols_by_orig_namecol_dr?r r@ reflect_tables!                zInspector.reflect_tabler r(r Dict[str, sa_schema.Column[Any]]csd}|jj|||j||d}|r||vs%|r'||vr'dSd}fdddD} dvr?| dg} ddurwd} | dusRJt| tr_tj| dd } nt| tj sptjt | dd } n| } | | d vrtj d id } | | d vrtjd id }| |tj||g| Ri| ||<}|j|jvrd|_|j|dd dS)Nrrcsi|] }|vr||qSr?r?r r r?r@rts  z-Inspector._reflect_column..)nullable autoincrementr<inforKcommentdialect_optionsdefaultT) _reflectedcomputedidentity)replace_existingr?)metadatadispatchcolumn_reflectrrFr:r! sa_schema DefaultClause FetchedValuertextappendComputedIdentityColumnrK primary_key append_column)r2rr rrr orig_namerrcol_kwcolargs default_textr)r+r,colr?r#r@r]sZ           zInspector._reflect_column_ReflectionInforr.csZ|j|}|r+fdd|dD}|d|j_|dd|j_|j|dSdS)Ncs$g|]}|vr|vr|qSr?r?)r=pkrrr?r@rs z)Inspector._reflect_pk..constrained_columnsrr') pk_constraintrFr9rr'_reload)r2r rrrrpk_conspk_colsr?rBr@rs  zInspector._reflect_pkrc s|j|g} | D]} | d} fdd| dD} |r#t| |s,|r-t| |r-q | d}| d}| d}g}|durc|rRtj||jf||j||d| |D] }| d |||gqTn#|rwtj||jf|jtj ||d | |D] }| d ||gqyd | vr| d }ni}z| tj | || fd | d d|Wq tjytd|jd| dd | dYq wdS)Nrcs"g|] }|vr |jn|qSr?)rK)r=crr?r@rsz)Inspector._reflect_fk..rCrrreferred_columns)r autoload_withrr .)rKrrr optionsTr') link_to_namer'zOn reflected table z0, skipping reflection of foreign key constraint z-; one or more subject columns within name(s) z, z are not present in the table) foreign_keysrFr intersectionrr1Tabler.rdr5join BLANK_SCHEMAappend_constraintForeignKeyConstraintrConstraintColumnNotFoundErrorrwarnr)r2r rrrrrrrrrfkey_dconnamerCrrrJrefspeccolumnrMr?rIr@rs         zInspector._reflect_fk)ascdesc nulls_first nulls_lastc Cs|j|g}|D]} | d} | d} | d} | di} | d}| dd}| di}| d }|r=t| |s=q |r@q g}t| D]i\}}|durk| sctd |d | d |d dn\t| |}n?z||vru||}n|j |}Wnt yt|d|d|j YqFw| |dD]}||j vr|j |}||}q| |qFtj| g|R||d|q dS)Nr column_names expressionscolumn_sortingrrindexr(duplicates_constraintz Skipping  z because key rz5 reflected as None but no 'expressions' were returnedz key z& was not located in columns for table r?)_tabler)indexesrFrissubset enumeraterrWrr4rHKeyErrorr_index_sort_exprsr5r1Index)r2r rrrrrrrgindex_drrrarbrflavorr( duplicates idx_elementsrcrH idx_elementoptionopr?r?r@rsp             zInspector._reflect_indexesc Cs|j|g}|D]d} | d} | d} | d} | d} | di}|r-t| |s-q | r0q g}| D]*}z||vr?||n|j|}WntyXtd||jfYq4w| |q4| t j || | d|q dS)Nrr`r'duplicates_indexr(zDunique constraint key '%s' was not located in columns for table '%s')rr') unique_constraintsrFrrhrHrjrrWrr5rTr1UniqueConstraint)r2r rrrrrr constraintsconst_drYrr'ror(constrained_colsrHconstrained_colr?r?r@r_sH      z%Inspector._reflect_unique_constraintsc Cs2|j|g}|D] } |tjdi| q dS)Nr?)check_constraintsrFrTr1CheckConstraint) r2r rrrrrrrwrxr?r?r@rs z$Inspector._reflect_check_constraintscCs"|j|}|r|d|_dSdSNr4) table_commentrFr')r2r rrr comment_dictr?r?r@rs z Inspector._reflect_table_comment availablec s|d<r|rtdkrtt|ndid<}dddddfd d}t|jdd|j|j|j|jdd|jdd|jdd|j dd|d }|rh| ||S|S)Nrdr8TF)optionalcheck_filter_names_from_methmethrrrfrr6csdusdksj|js}nd}zr/|dd|i}|r)|s,dW|SW|SW|Si}W|StyB|s=i}Y|Sw)Ng?rFr?)rh_overrides_defaultrGNotImplementedError)rrr_fnrrfraction has_resultr5r2r?r@runs0     z+Inspector._get_reflection_info..run)r)r) rrDrOrgrur~r{rr8)rrrrfrrfr6r) lenr@rrrrrrrrr) r2rrrr r5r8rr&r?rr@rs< #   zInspector._get_reflection_info)rdrc)rlrmrdrcr6rb)rdrcr6rs)rerr6rs)ryrr6rs)r6rs)rdrr6rb)rdrr6rb)r6r)r6r)r6r)r5rr6r)rrr5rr6r)rr;rrr5rr6rf)rr;rrr5rr6rf) rr;rr;rrr5rr6rf)rr;r5rr6rf)rrr5rr6r)r9)rrr5rr6r)rr;rrr5rr6r) rrrrrrVrr_r5rr6r)rr;rrr5rr6r;)rr;rrr5rr6r)rrr6rs) rrrrrrVrr_r5rr6r)rr;rrr5rr6r+) rrrrrrVrr_r5rr6r)rr;rrr5rr6r) rrrrrrVrr_r5rr6r)rr;rrr5rr6r) rrrrrrVrr_r5rr6r)rr;rrr5rr6r) rrrrrrVrr_r5rr6r)rr;rrr5rr6r,) rrrrrrVrr_r5rr6r)rr;rrr5rr6r) rrrrrrVrr_r5rr6r)r?TNN)rrrrrrrrfrrr r r6rs) rrr r(rrrrrr"r6rs) r r@rr.rrrr"rrr6rs)r r@rr.rrrr"rrrrrrfrrrrr6rs)r r@rr.rrrr"rrrrrrr6rs) r r@rr.rrrrr6rs)NNNN) rrrrrrr r r5rr6r@)MrGrWrXrY__annotations__r deprecatedrk classmethodrrrirvrur|r}r _inspectsrrrr contextlibcontextmanagerrrpropertyrrrrrrrrrrrrrVrZr_r`rrrrrrrrrrrrrrrrrrrrr!rrrrasc_opdesc_opnulls_first_op nulls_last_oprkrrrrrr?r?r?r@rbs               " "   / N  ! :     "  <  9 ! ;   : ! ; $ = ! >   H Z  B 0  rbc@seZdZdZedddZedddZedd d Zedd dZed ddZ ed!ddZ ed"ddZ ed#ddZ dS)$ReflectionDefaultsz5provides blank default values for reflection methods.r6rcCgSr9r?rqr?r?r@rzReflectionDefaults.columnsr+cCs dgdS)N)rrCr?rr?r?r@rDsz ReflectionDefaults.pk_constraintrcCrr9r?rr?r?r@rOrzReflectionDefaults.foreign_keysrcCrr9r?rr?r?r@rg rzReflectionDefaults.indexesrcCrr9r?rr?r?r@rurz%ReflectionDefaults.unique_constraintsrcCrr9r?rr?r?r@r{rz$ReflectionDefaults.check_constraintsrcCsiSr9r?rr?r?r@rrz ReflectionDefaults.table_optionsr,cCsddiSr}r?rr?r?r@r~sz ReflectionDefaults.table_commentN)r6r)r6r+)r6r)r6r)r6r)r6r)r6r)r6r,) rGrWrXrYrrrDrOrgrur{rr~r?r?r?r@rs$       rc@s`eZdZUded<ded<ded<ded<d ed <d ed <d ed<ded<ded<dddZdS)r@rrz7Dict[TableKey, Optional[ReflectedPrimaryKeyConstraint]]rDrrOrrgrruz/Dict[TableKey, Optional[ReflectedTableComment]]r~rr{rrz+Dict[TableKey, exc.UnreflectableTableError]r8otherr6rscCsJ|jD]\}}t||}|dur"|durt|||q||qdSr9)__dict__rIgetattrsetattrr)r2rrBrCovr?r?r@r,s  z_ReflectionInfo.updateN)rr@r6rs)rGrWrXrrr?r?r?r@r@s r@rS)rNrOr6rP)ErY __future__rr dataclassesrenumrrrtypingrrr r r r r rrrrrrrbaserrrrrrrrr1 sql.cache_keyr sql.elementsr r! sql.type_apir" sql.visitorsr#r$ util.typingr% interfacesr&r'r(r)r*r+r,r-r.r/rTrMrUrVr__self_inspects Inspectablerbrr@r?r?r?r@s                                              O'