Edit File: reflection.cpython-37.pyc
B ��4]?� � @ s� d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ dd lm Z dd l m Z dd lm Z dd lmZ ejd d� �ZG dd� 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 O s� |� dd �}|d kr&| ||f|�|�S | jtdd� |D ��tdd� |�� D ��f}|� |�}|d kr~| ||f|�|�}|||< |S )N� info_cachec s s | ]}t |tj�r|V qd S )N)� isinstancer � string_types)�.0�a� r �O/opt/alt/python37/lib64/python3.7/site-packages/sqlalchemy/engine/reflection.py� <genexpr>/ s zcache.<locals>.<genexpr>c s s2 | ]*\}}t |tjtj tf �r||fV qd S )N)r r r Z int_types�float)r �k�vr r r r 1 s )�get�__name__�tuple�items)�fn�selfZcon�args�kwr �key�retr r r �cache( s r" c @ s` e Zd ZdZdd� Zedd� �Ze�e �dd� �Z e dd � �Z d d � Z ejd d �dGdd��ZdHdd�Zdd� Zdd� ZdIdd�ZdJdd�ZdKdd �ZdLd d �Zed d �dMd!d"��ZdNd#d$�ZdOd%d&�ZdPd'd(�Z dQd)d*�Z dRd+d,�Z dSd-d.�Z dTd1d2�Z d3d4� Z!d5d6� Z"d7d8� Z#d9d:� Z$d;e%j&fd<e%j'fd=e%j(fd>e%j)fgZ*d?d@� Z+dAdB� Z,dCdD� Z-dEdF� Z.dS )U� Inspectoram 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:`.Inspector` object is usually created via the :func:`.inspect` function:: from sqlalchemy import inspect, create_engine engine = create_engine('...') insp = inspect(engine) The inspection method above is equivalent to using the :meth:`.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:`.Inspector` subclass that provides additional methods specific to the dialect's target database. c C sJ || _ t|d�r|j| _n|| _| j|kr6|�� �� | jj| _i | _dS )aj Initialize a new :class:`.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:`.Inspector`, see :meth:`.Inspector.from_engine` �engineN)�bind�hasattrr$ �connect�close�dialectr )r r% r r r �__init__X s zInspector.__init__c C s t |jd�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:`.Inspector` in that the :class:`~sqlalchemy.engine.interfaces.Dialect` is given a chance to provide a dialect-specific :class:`.Inspector` instance, which may provide additional methods. See the example at :class:`.Inspector`. � inspector)r& r) r+ r# )�clsr% r r r � from_enginet s zInspector.from_enginec C s t �| �S )N)r# r- )r% r r r �_insp� s zInspector._inspc C s | j jS )z�Return 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. )r) �default_schema_name)r r r r r/ � s z Inspector.default_schema_namec C s$ t | jd�r | jj| j| jd�S g S )z!Return all schema names. �get_schema_names)r )r& r) r0 r% r )r r r r r0 � s zInspector.get_schema_names)z1.0z�The :paramref:`get_table_names.order_by` parameter is deprecated and will be removed in a future release. Please refer to :meth:`.Inspector.get_sorted_table_and_fkc_names` for a more comprehensive solution to resolving foreign key cycles between tables.)�order_byNc C s� t | jd�r$| jj| j|| jd�}n | j�|�}|dkr�g }x@|D ]8}x2| �||�D ]"}||d krT|�|d |f� qTW qBW t t � ||��}|S )a� Return all table names in referred to within a particular schema. The names are expected to be real tables only, not views. Views are instead returned using the :meth:`.Inspector.get_view_names` method. :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 order_by: Optional, may be the string "foreign_key" to sort the result on foreign key dependencies. Does not automatically resolve cycles, and will raise :class:`.CircularDependencyError` if cycles exist. .. seealso:: :meth:`.Inspector.get_sorted_table_and_fkc_names` :attr:`.MetaData.sorted_tables` �get_table_names)r Z foreign_key�referred_table) r& r) r2 r% r r$ � table_names�get_foreign_keys�append�listr �sort)r r r1 �tnames�tuples�tname�fkeyr r r r2 � s % zInspector.get_table_namesc sD t | jd�r$| jj| j|| jd�}n | j�|�}t� }t� �i �xZ|D ]R}| �||�}tdd� |D ���|< x*|D ]"}||d krr|� |d |f� qrW qFW yt t � ||��}W np t jk �r } zNx8|jD ].� |�� � ��� fdd��� d D �� q�W t t � ||��}W d d }~X Y nX ��fd d�|D �d t ��fg S ) ax Return 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:`.Inspector.get_table_names` :func:`.sort_tables_and_constraints` - similar method which works with an already-given :class:`.MetaData`. r2 )r c S s g | ] }|d �qS )�namer )r Zfkr r r � <listcomp>� s z<Inspector.get_sorted_table_and_fkc_names.<locals>.<listcomp>r3 c 3 s | ]}� d |fV qdS )r Nr )r Zfkc)�edger r r s z;Inspector.get_sorted_table_and_fkc_names.<locals>.<genexpr>r Nc s g | ]}|� | � ��f�qS r )� difference)r r; )�fknames_for_table�remaining_fkcsr r r> s )r& r) r2 r% r r$ r4 �setr5 �addr7 r r8 r ZCircularDependencyErrorZedges�remove�update) r r r9 r: r; �fkeysr< Zcandidate_sort�errr )r? rA rB r � get_sorted_table_and_fkc_names� s0 " z(Inspector.get_sorted_table_and_fkc_namesc C s | j j| j| jd�S )z�return 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 )r) �get_temp_table_namesr% r )r r r r rJ s z Inspector.get_temp_table_namesc C s | j j| j| jd�S )z�return 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 )r) �get_temp_view_namesr% r )r r r r rK s z Inspector.get_temp_view_namesc K s0 t | jd�r,| jj| j||fd| ji|��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& r) rL r% r )r � table_namer r r r r rL * s zInspector.get_table_optionsc C s | j j| j|| jd�S )z�Return all view names in `schema`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. )r )r) �get_view_namesr% r )r r r r r rN > s zInspector.get_view_namesc C s | j j| j||| jd�S )z�Return definition for `view_name`. :param schema: Optional, retrieve names from a non-default schema. For special quoting, use :class:`.quoted_name`. )r )r) �get_view_definitionr% r )r Z view_namer r r r rO J s z Inspector.get_view_definitionc K sN | j j| j||fd| ji|��}x(|D ] }|d }t|t�s&|� |d< q&W |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. * ``attrs`` - dict containing optional column attributes :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)r) � get_columnsr% r r r )r rM r r Zcol_defsZcol_def�coltyper r r rQ V s zInspector.get_columnsz0.7z�The :meth:`.Inspector.get_primary_keys` method is deprecated and will be removed in a future release. Please refer to the :meth:`.Inspector.get_pk_constraint` method.c K s$ | j j| j||fd| ji|��d S )z�Return 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_columns)r) �get_pk_constraintr% r )r rM r r r r r �get_primary_keys~ s zInspector.get_primary_keysc K s | j j| j||fd| ji|��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 )r) rT r% r )r rM r r r r r rT � s zInspector.get_pk_constraintc K s | j j| j||fd| ji|��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 )r) r5 r% r )r rM r r r r r r5 � s zInspector.get_foreign_keysc K s | j j| j||fd| ji|��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 )r) � get_indexesr% r )r rM r r r r r rV � s $zInspector.get_indexesc K s | j j| j||fd| ji|��S )ao 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 )r) �get_unique_constraintsr% r )r rM r r r r r rW � s z Inspector.get_unique_constraintsc K s | j j| j||fd| ji|��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 )r) �get_table_commentr% r )r rM r r r r r rX s zInspector.get_table_commentc K s | j j| j||fd| ji|��S )a� 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 :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 )r) �get_check_constraintsr% r )r rM r r r r r rY s z Inspector.get_check_constraintsr Tc sl |dk r � |krdS |� � � | jj}| j�� �}� j}t� fdd�|jD ��} | j||f� j�} | rp� � | � t j r�t |t �r�|�|j�}t |t �r�|�|j�}d} i } x0| j||f� j�D ]} d} | �� | ||| � q�W | s�t�� j��| �||� | |� | �||� | |||| � | �||� | ||| � | �||� | ||| � | �||� | ||| � | �||� | � dS )a Given a 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 s( | ] }|� j kr|� j �|�fV qd S )N)�dialect_kwargsr )r r )�tabler r r h s z)Inspector.reflecttable.<locals>.<genexpr>FT)rD r% r) Zschema_for_objectr= �dict�reflection_optionsrL rZ Z_validate_dialect_kwargsr Zpy2kr �str�decode�encodingrQ �_reflect_columnr ZNoSuchTableError� _reflect_pk� _reflect_fk�_reflect_indexes�_reflect_unique_constraints�_reflect_check_constraints�_reflect_table_comment)r r[ �include_columns�exclude_columns� resolve_fks� _extend_onr) r rM r] Ztbl_optsZ found_table�cols_by_orig_name�col_dr )r[ r � reflecttable: s� zInspector.reflecttablec s( � d }|j �| |� � � d }|r,||ks8|r<||kr<d S � d }t� fdd�dD ��} d� krp| �� d � g } � �d�d k rֈ d } t| tjj�r�t j | dd �} n$t| t j �s�t j t� � d �dd �} | � | � d � kr�| �� | � t j||f| �| � ||< } | j|jk�rd| _|�| � d S ) Nr= rP c 3 s" | ]}|� kr|� | fV qd S )Nr )r r )rm r r r � s z,Inspector._reflect_column.<locals>.<genexpr>)ZnullableZ autoincrement�quote�infor �comment�dialect_options�defaultT)Z _reflected�sequence)�dispatchZcolumn_reflectr\ rF r r r �elementsZ TextClause� sa_schemaZ DefaultClauseZ FetchedValue�textr6 �_reflect_col_sequenceZColumnr � primary_keyZ append_column) r r[ rm rh ri rl � orig_namer= rR Zcol_kw�colargsrs �colr )rm r ra � s8 zInspector._reflect_columnc C sT d|krP|d }t �|d dd�}d|kr4|d |_d|krF|d |_|�|� d S )Nrt r= r �start� increment)rw �Sequencer~ r r6 )r rm r| �seqrt r r r ry � s z Inspector._reflect_col_sequencec sL | j ||f|j�}|rH� �fdd�|d D �}|�d�|j_|j�|� d S )Nc s$ g | ] }|� kr|�kr� | �qS r r )r �pk)rl ri r r r> s z)Inspector._reflect_pk.<locals>.<listcomp>rS r= )rT rZ r rz r= Z_reload)r rM r r[ rl ri Zpk_consZpk_colsr )rl ri r rb s zInspector._reflect_pkc sL | j ||f|j�} �x2| D �](} | d } � fdd�| d D �} |rRt| ��|�rRq| d } | d }| d }g }| d k r�|r�tj||jfd| | j|d �|�� xn|D ]}|�d � | ||g�� q�W nJ|r�tj||jfd| jtj |d �|�� x |D ]}|�d � ||g�� q�W d | k�r | d }ni }|� tj | || fd di|��� qW d S )Nr= c s" g | ]}|� kr� | j n|�qS r )r )r �c)rl r r r> + s z)Inspector._reflect_fk.<locals>.<listcomp>rS �referred_schemar3 �referred_columnsT)�autoloadr � autoload_withrk �.)r� r� r rk �optionsZ link_to_name) r5 rZ rC � intersectionrw ZTable�metadatar% r6 �joinZ BLANK_SCHEMA�append_constraintZForeignKeyConstraint)r rM r r[ rl ri rj rk r] rG Zfkey_d�connamerS r� r3 r� Zrefspec�columnr� r )rl r rc s^ zInspector._reflect_fkZasc�descZ nullsfirstZ nullslastc C s` | � ||�}�xL|D �]B} | d } | d } | �di �} | d } | �dd�}| �di �}| �d�}|r�t| ��|�s�t�d |d �| �f � q|r�qg }x�| D ]�}y ||kr�|| n|j| }W n* tk r� t�d |||f � w�Y nX | �|d �}x"| j D ]\}}||kr�||�}q�W |� |� q�W t j | f|�d |it t|�� �d| fg ��� qW d S )Nr= � column_names�column_sorting�uniquerP �indexrr Zduplicates_constraintz5Omitting %s key for (%s), key covers omitted columns.z, z5%s key '%s' was not located in columns for table '%s'r Z_table)rV r rC �issubsetr �warnr� r� �KeyError�_index_sort_exprsr6 rw �Indexr\ r7 r )r rM r r[ rl rh ri r] �indexesZindex_dr= �columnsr� r� Zflavorrr � duplicatesZidx_colsr� Zidx_colZ c_sortingr �opr r r rd g sH zInspector._reflect_indexesc C s� y| � ||�}W n tk r$ d S X x�|D ]�} | d } | d } | �d�} |rrt| ��|�srt�dd�| � � q,| rxq,g } x\| D ]T}y ||kr�|| n|j| }W n& t k r� t�d||f � Y q�X | � |� q�W |� t j | d| i�� q,W d S )Nr= r� Zduplicates_indexzDOmitting unique constraint key for (%s), key covers omitted columns.z, zDunique constraint key '%s' was not located in columns for table '%s')rW �NotImplementedErrorr rC r� r r� r� r� r� r6 r� rw ZUniqueConstraint)r rM r r[ rl rh ri r] � constraints�const_dr� r� r� Zconstrained_colsr� Zconstrained_colr r r re � s6 z%Inspector._reflect_unique_constraintsc C sJ y| � ||�}W n tk r$ d S X x |D ]} |�tjf | �� q,W d S )N)rY r� r� rw ZCheckConstraint) r rM r r[ rl rh ri r] r� r� r r r rf � s z$Inspector._reflect_check_constraintsc C s8 y| � ||�}W n tk r$ d S X |�dd �|_d S )Nrx )rX r� r rq )r rM r r[ r] Z comment_dictr r r rg � s z Inspector._reflect_table_comment)NN)N)N)N)N)N)N)N)N)N)N)N)N)r TN)/r � __module__� __qualname__�__doc__r* � classmethodr- r Z _inspectsr r. �propertyr/ r0 r Zdeprecated_paramsr2 rI rJ rK rL rN rO rQ r rU rT r5 rV rW rX rY rn ra ry rb rc r Zasc_opZdesc_opZ nullsfirst_opZ nullslast_opr� rd re rf rg r r r r r# = sT * 8 ( # ( 9 I :3r# N)r� �baser � r r r r r r rw Z sql.type_apir r r � decoratorr" �objectr# r r r r �<module> s