6M]HJ d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z
dd
l m Z dd lm
Z
dd lmZ ej d
Z G d de ZdS )a Provides 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..
) Connectable )exc)
inspection)sql)util) operators)schema)
TypeEngine)
deprecated) topologicalc 6 | dd }|
| ||g|R i |S | j t d |D t d | D f}| | }| | ||g|R i |}|||< |S )N
info_cachec 3 N K | ] }t |t j |V !d S N)
isinstancer string_types).0as p/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib64/python3.11/site-packages/sqlalchemy/engine/reflection.py zcache../ s4
B
BAAt/@!A!A
Ba
B
B
B
B
B
B c 3 0 K | ]\ }}|d k ||fV dS )r N )r kvs r r zcache..0 s4
A
AAqL/@/@q!f/@/@/@/@
A
Ar )get__name__tupleitems)fnselfconargskwr keyrets r cacher( ( s d++Jr$)d)))b)))
B
B
B
B
BBB
A
A
A
A
AAA C
..
C
{bs(T(((R((
3 Jr c e Zd ZdZd Zed Z ej e d Z
e d Z d Z
ej d d*d
Zd+d Zd Zd
Zd+dZd+dZd+dZd+dZ edd d+d Zd+dZd+dZd+dZ d+dZ d+dZ d+dZ d,d Z d Z!d Z"d Z#d! Z$d"e%j& fd#e%j' fd$e%j( fd%e%j) fgZ*d& Z+d' Z,d( Z-d) Z.d S )- 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::
from sqlalchemy import inspect, create_engine
engine = create_engine('...')
insp = inspect(engine)
The inspection method above is equivalent to using the
:meth:`_reflection.Inspector.from_engine` method, i.e.::
engine = create_engine('...')
insp = Inspector.from_engine(engine)
Where above, the :class:`~sqlalchemy.engine.interfaces.Dialect` may opt
to return an :class:`_reflection.Inspector`
subclass that provides additional
methods specific to the dialect's target database.
c || _ t |d r
|j | _ n|| _ | j |u r&| | j j | _ i | _ dS )a Initialize a new :class:`_reflection.Inspector`.
:param bind: a :class:`~sqlalchemy.engine.Connectable`,
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`
engineN)bindhasattrr, connectclosedialectr )r" r- s r __init__zInspector.__init__U so 4 " " +DKK DK ;$ LLNN " " "{* r c ~ t |j d r|j | S t | S )a Construct a new dialect-specific Inspector object from the given
engine or connection.
:param bind: a :class:`~sqlalchemy.engine.Connectable`,
which is typically an instance of
:class:`~sqlalchemy.engine.Engine` or
:class:`~sqlalchemy.engine.Connection`.
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`.
inspector)r. r1 r4 r* )clsr- s r from_enginezInspector.from_engineq s: ( 4< - - 0<))$// / r c 6 t | S r )r* r6 )r- s r _inspzInspector._insp s $$T***r c | j j S )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.
)r1 default_schema_namer" s r r: z Inspector.default_schema_name s |//r c | t | j d r&| j | j | j S g S )zReturn all schema names.get_schema_namesr )r. r1 r= r- r r; s r r= zInspector.get_schema_names sH 4 foreign_keyreferred_table) r. r1 rA r- r r, table_namesget_foreign_keysappendlistr
sort)r" r
r? tnamestuplestnamefkeys r rA zInspector.get_table_names s N 4 c g | ]
}|d S )namer )r fks r
z. s +G+G+G2BvJ+G+G+Gr rC c 3 , K | ]}d |fV dS )r Nr )r fkcedges r r z;Inspector.get_sorted_table_and_fkc_names.. s< & &'*T!WcN& & & & & &r r Nc J g | ] }|| f S r )
difference)r rK fknames_for_tableremaining_fkcss r rQ z.
sB
%e,77GG H
r )r. r1 rA r- r r, rD setrE addrG r
rH r CircularDependencyErroredgesremoveupdate) r" r
rI rJ rK fkeysrL candidate_sorterrrT rW rX s @@@r get_sorted_table_and_fkc_namesz(Inspector.get_sorted_table_and_fkc_names s) 0 4???
@ D !+"266"B"B C CNN* D D D
d### %% & & & &.?Q.H& & & "+"266"B"B C CNNNNNN D
'
D ((
) *+ +s "D F A.FF c N | j | j | j S )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
r> )r1 get_temp_table_namesr- r r; s r rd z Inspector.get_temp_table_names s, |00 I$/ 1
r c N | j | j | j S )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
r> )r1 get_temp_view_namesr- r r; s r rf z Inspector.get_temp_view_names s, |// I$/ 0
r c r t | j d r! | j j | j ||fd| j i|S i S )a Return 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_optionsr )r. r1 rh r- r r"
table_namer
r% s r rh zInspector.get_table_options) sY 4/MO
r c P | j | j || j S )zReturn all view names in `schema`.
:param schema: Optional, retrieve names from a non-default schema.
For special quoting, use :class:`.quoted_name`.
r> )r1 get_view_namesr- r )r" r
s r rl zInspector.get_view_names= s. |** Iv$/ +
r c R | j | j ||| j S )zReturn definition for `view_name`.
:param schema: Optional, retrieve names from a non-default schema.
For special quoting, use :class:`.quoted_name`.
r> )r1 get_view_definitionr- r )r" view_namer
s r rn z Inspector.get_view_definitionI s0 |// Iy&T_ 0
r c | j j | j ||fd| j i|}|D ],}|d }t |t
s
| |d< -|S )a Return 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.
* ``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.
r type)r1 get_columnsr- r r r )r" rj r
r% col_defscol_defcoltypes r rr zInspector.get_columnsU s| b ,4<+ Iz6
6:o
IK
, ,G foG gz22
,")'))r z0.7zThe :meth:`_reflection.Inspector.get_primary_keys` method is deprecated and will be removed in a future release. Please refer to the :meth:`_reflection.Inspector.get_pk_constraint` method.c P | j j | j ||fd| j i|d S )zReturn information about primary keys in `table_name`.
Given a string `table_name`, and an optional string `schema`, return
primary key information as a list of column names.
r constrained_columnsr1 get_pk_constraintr- r ri s r get_primary_keyszInspector.get_primary_keys sE .t|- Iz6
6:o
IK
! !r c D | j j | j ||fd| j i|S )a Return 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`.
r rx ri s r ry zInspector.get_pk_constraint s= ( .t|- Iz6
6:o
IK
r c D | j j | j ||fd| j i|S )a Return 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`.
r )r1 rE r- r ri s r rE zInspector.get_foreign_keys s= > -t|, Iz6
6:o
IK
r c D | j j | j ||fd| j i|S )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 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``, ``nullsfirst``, ``nullslast``.
.. 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`.
r )r1 get_indexesr- r ri s r r~ zInspector.get_indexes s> H (t|' Iz6
6:o
IK
r c D | j j | j ||fd| j i|S )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 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`.
r )r1 get_unique_constraintsr- r ri s r r z Inspector.get_unique_constraints s= * 3t|2 Iz6
6:o
IK
r c D | j j | j ||fd| j i|S )a Return 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
r )r1 get_table_commentr- r ri s r r zInspector.get_table_comment s= .t|- Iz6
6:o
IK
r c D | j j | j ||fd| j i|S )ac Return 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
r )r1 get_check_constraintsr- r ri s r r z Inspector.get_check_constraints2 s= : 2t|1 Iz6
6:o
IK
r r Tc
||v rdS | | j j }| j }j }t fd|j D } | j ||fi j }
|
r |
t j r^t |t r| |j }t |t r| |j }d} i } | j ||fi j D ] }
d} | |
||| | st% j j | ||| | | ||| |||| | ||| ||| | ||| ||| | ||| ||| | ||| dS )a Given 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.engine.reflection import Inspector
engine = create_engine('...')
meta = MetaData()
user_table = Table('user', meta)
insp = Inspector.from_engine(engine)
insp.reflecttable(user_table, None)
: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.
Nc 3 b K | ])}|j v |j | fV *d S r )dialect_kwargsr )r r tables r r z)Inspector.reflecttable.. sS "
"
E((( $((++ ,(((("
"
r FT)rZ r- r1 schema_for_objectrO dictreflection_optionsrh r _validate_dialect_kwargsr py2kr strdecodeencodingrr _reflect_columnr NoSuchTableError _reflect_pk _reflect_fk_reflect_indexes_reflect_unique_constraints_reflect_check_constraints_reflect_table_comment)r" r include_columnsexclude_columns resolve_fks
_extend_onr1 r
rj r tbl_opts found_tablecols_by_orig_namecol_ds ` r reflecttablezInspector.reflecttableS s : !
""u%%%)#,,U33Z
" "
"
"
"
/"
"
"
*4)
"'"6
5
* *8 4 4 4 9 A&#&&
9 w'788*c**
A ' . .w/? @ @
%T%
"'"6
E K !
3&uz22 2 '8/
((
''
## '9
r c d }|j | | d }|r||vs|r||v rd S d }t fddD } dv r| d g }
d d } t | t j j rt j
| d } nHt | t j s.t j
t
j d d } |
| d v r,t j d i d } |
| d
v r| |
t j ||g|
R i | x||< }
|
j |j v rd|
_ | |
d S ) NrO rq c 3 4 K | ]}|v || fV d S r r )r r r s r r z,Inspector._reflect_column.. sA
Ezz aM zzz
r )nullable
autoincrementquoteinfor& commentdialect_optionsdefaultT)
_reflectedcomputedsequencer )dispatchcolumn_reflectr r^ r r r elements
TextClause sa_schema
DefaultClause FetchedValuetextrF Computed_reflect_col_sequenceColumnr& primary_key
append_column)r" r r r r r orig_namerO ru col_kwcolargsr r cols ` r r zInspector._reflect_column s/ &M
%%dE5999 V} O ; ; !< $ 7 7 F-
% % MM% 12 3 3 3 99Y +I&G'3<#:;;
#1'dKKK )?@@
#1HU9 -..4
NN7 # # # )>>E*,=>>H NN8 $ $ $ & &ug 6 6 6-6-= '.
#.
.
.
'-.
.
)$s 7e' ' ' "CO
C r c d|v r]|d }t j |d dd }d|v r
|d |_ d|v r
|d |_ | | d S d S )Nr rO r start increment)r Sequencer r rF )r" r r seqr s r r z Inspector._reflect_col_sequence s{
#C )#f+q!<.( s> ***r /H/H ""%/H/H/Hr rw rO )ry r r r rO _reload)r" rj r
r r r pk_conspk_colss `` r r zInspector._reflect_pk! s )$(
"'"6
/ !"78 G &-[[%8%8E "
% %g . . . . . / /r c | j ||fi |j } | D ]J}
|
d } fd|
d D } |r#t | | rD|
d }
|
d }|
d }g }|
U|r"t j ||j fd|
| j |d| |D ]-}| d |
||g .n]|r,t j ||j fd| j t j
|d
| |D ],}| d ||g -d |
v r |
d }ni }| t j | || fd di| Ld S )
NrO c 6 g | ]}|v r
| j n|S r )r& )r cr s r rQ z)Inspector._reflect_fk..G sB # # # -.1B,B,B!!$((# # #r rw referred_schemarC referred_columnsT)autoloadr
autoload_withr .)r r r
r options link_to_name)
rE r rY intersectionr Tablemetadatar- rF join BLANK_SCHEMAappend_constraintForeignKeyConstraint)r" rj r
r r r r r r r_ fkey_dconnamerw r rC r refspeccolumnr s ` r r zInspector._reflect_fk5 sa &%
"'"6
8 8 F VnG# # # # 56# # #
3':#;#;#H#H $ $
$%6 7O #$4 5N %&8 9 G * O& "& .&*i#-
- / FNN/>6!JKK
O& "&&*i ( 5#-
- / G GFNN388^V,D#E#EFFFFF"" + # #.' "&
a8 8 r ascdesc
nullsfirst nullslastc | || }|D ]} | d }
| d } | di } | d }
| dd }| di }| d }|rQt | | s/t j d |d
d | d |rg }| D ]} ||v r|| n |j | }n-# t $ r t j |d
|d|d Y Fw xY w| |d }| j D ]\ }}||v r || }|
| t j |
g|R d|it t | d|
fgz d S )NrO column_namescolumn_sortinguniquerq indexr duplicates_constraintz Omitting z
key for (, z ), key covers omitted columns.z key '(' was not located in columns for table ''r _table)r~ r rY issubsetr warnr r KeyError_index_sort_exprsrF r Indexr rG r )r" rj r
r r r r r indexesindex_drO columnsr r flavorr
duplicatesidx_colsr idx_col c_sortingr ops r r zInspector._reflect_indexes sa "":v66 , , G6?D n-G $[[)92 > >N X&F [[11F %kk*;R @ @O %<==J
s7||'<'<_'M'M
vvtyy 1 1 1 13
H
)
) 111 *!,, "WQZ G
I4:FFAAAzzzK H + . .q" 5 5 ! 3 . .EArI~~"$"W++(((( O
tO 1 1 3 34468J7KKLL
O, , s (D'D,+D,c
Z | || }n# t $ r Y d S w xY w|D ]} | d }
| d } | d } |rMt | | s+t j dd | z v| ryg }
| D ]\} ||v r|| n |j | }|
| 2# t $ r t j d|d|d Y Yw xY w| t j
|
d|
i d S ) NrO r duplicates_indexzDOmitting unique constraint key for (%s), key covers omitted columns.r zunique constraint key 'r r )r NotImplementedErrorr rY r r r r r rF r r r UniqueConstraint)r" rj r
r r r r r constraintsconst_dr r r constrained_colsr constrained_cols r r z%Inspector._reflect_unique_constraints s 55j&IIKK" FF # G foG n-G %788J
s7||'<'<_'M'M
248IIg4F4FG
"
=
= = 111 *!,, "WQZ $ %++O<<<<
II45AAzzzC
# #*,<K7KK
; s
'',C%DDc | || }n# t $ r Y d S w xY w|D ]&} | t j di | 'd S )Nr )r r r r CheckConstraint)
r" rj r
r r r r r r r s
r r z$Inspector._reflect_check_constraints s 44ZHHKK" FF # J JG # #I$=$H$H$H$H I I I I J Js
''c | || }| dd |_ d S # t $ r Y d S w xY w)Nr )r r r r )r" rj r
r r comment_dicts r r z Inspector._reflect_table_comment s] ; 11*fEEL ) , ,VT : :EMMM # FF s 5
AA)NNr )r TN)/r
__module__ __qualname____doc__r2 classmethodr6 r _inspectsr r8 propertyr: r= r deprecated_paramsrA rb rd rf rh rl rn rr r rz ry rE r~ r r r r r r r r r asc_opdesc_op
nullsfirst_op nullslast_opr r r r r r r r r* r* 9 s 6 8 [ . Z+&&+ + '&+ 0 0 X0 T
) ) )
)V6+ 6+ 6+ 6+p
(
9 9 9 9v Z
B ! ! ! !
0!
!
!
!
F&
&
&
&
P
2
(
J
D
D
D
D
L;! ;! ;!z % % %/ / /(F F FR
! "# y./ i,- 8 8 8t1 1 1fJ J J&; ; ; ; ;r r* N)r baser r r r r r r
r sql.type_apir r r
decoratorr( objectr* r r r r s ( % % % % % % % % % % % %
S; S; S; S; S; S; S; S; S; S;r