U
    ovg^/                     @  s  d dl mZ d dlmZ d dlmZ d dlmZ d dlmZ d dlmZ ddlm	Z	 d	d
l
mZ d	dl
mZ d	dl
mZ d	dl
mZ d	dl
mZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z  ddlm!Z! ddlm"Z" ddlm#Z# ddl$m%Z% ddl&m'Z' d Z(d!d"d#d$d%Z)G d&d" d"eZG d'd( d(e Z*G d)d* d*e*Z+G d+d, d,e*Z,d-S ).    )annotations)Any)List)Optional)Tuple)Union   )ext   )_OnConflictConstraintT)_OnConflictIndexElementsT)_OnConflictIndexWhereT)_OnConflictSetT)_OnConflictWhereT   )util)	coercions)roles)schema)_DMLTableArgument)_exclusive_against)_generative)ColumnCollection)ReadOnlyColumnCollectionInsert)ClauseElement)ColumnElement)KeyedColumnElement)
TextClause)alias)Self)r   insertr   r   )tablereturnc                 C  s   t | S )as  Construct a PostgreSQL-specific variant :class:`_postgresql.Insert`
    construct.

    .. container:: inherited_member

        The :func:`sqlalchemy.dialects.postgresql.insert` function creates
        a :class:`sqlalchemy.dialects.postgresql.Insert`.  This class is based
        on the dialect-agnostic :class:`_sql.Insert` construct which may
        be constructed using the :func:`_sql.insert` function in
        SQLAlchemy Core.

    The :class:`_postgresql.Insert` construct includes additional methods
    :meth:`_postgresql.Insert.on_conflict_do_update`,
    :meth:`_postgresql.Insert.on_conflict_do_nothing`.

    r   )r#    r%   F/tmp/pip-unpacked-wheel-uqd9otp_/sqlalchemy/dialects/postgresql/dml.pyr"   *   s    r"   c                
   @  s|   e Zd ZdZdZdZejddddZe	ddd	id
Z
ee
ddddddddddZee
ddddddddZdS )r   zPostgreSQL-specific implementation of INSERT.

    Adds methods for PG-specific syntaxes such as ON CONFLICT.

    The :class:`_postgresql.Insert` object is created using the
    :func:`sqlalchemy.dialects.postgresql.insert` function.

    
postgresqlFz6ReadOnlyColumnCollection[str, KeyedColumnElement[Any]])r$   c                 C  s   t | jddjS )ak  Provide the ``excluded`` namespace for an ON CONFLICT statement

        PG's ON CONFLICT clause allows reference to the row that would
        be inserted, known as ``excluded``.  This attribute provides
        all columns in this row to be referenceable.

        .. tip::  The :attr:`_postgresql.Insert.excluded` attribute is an
            instance of :class:`_expression.ColumnCollection`, which provides
            an interface the same as that of the :attr:`_schema.Table.c`
            collection described at :ref:`metadata_tables_and_columns`.
            With this collection, ordinary names are accessible like attributes
            (e.g. ``stmt.excluded.some_column``), but special names and
            dictionary method names should be accessed using indexed access,
            such as ``stmt.excluded["column name"]`` or
            ``stmt.excluded["values"]``.   See the docstring for
            :class:`_expression.ColumnCollection` for further examples.

        .. seealso::

            :ref:`postgresql_insert_on_conflict` - example of how
            to use :attr:`_expression.Insert.excluded`

        excluded)name)r    r#   columns)selfr%   r%   r&   r(   K   s    zInsert.excluded_post_values_clausezCThis Insert construct already has an ON CONFLICT clause established)ZmsgsNr   r   r   r   r   r!   )
constraintindex_elementsindex_whereset_wherer$   c                 C  s   t |||||| _| S )a$  
        Specifies a DO UPDATE SET action for ON CONFLICT clause.

        Either the ``constraint`` or ``index_elements`` argument is
        required, but only one of these can be specified.

        :param constraint:
         The name of a unique or exclusion constraint on the table,
         or the constraint object itself if it has a .name attribute.

        :param index_elements:
         A sequence consisting of string column names, :class:`_schema.Column`
         objects, or other column expression objects that will be used
         to infer a target index.

        :param index_where:
         Additional WHERE criterion that can be used to infer a
         conditional target index.

        :param set\_:
         A dictionary or other mapping object
         where the keys are either names of columns in the target table,
         or :class:`_schema.Column` objects or other ORM-mapped columns
         matching that of the target table, and expressions or literals
         as values, specifying the ``SET`` actions to take.

         .. versionadded:: 1.4 The
            :paramref:`_postgresql.Insert.on_conflict_do_update.set_`
            parameter supports :class:`_schema.Column` objects from the target
            :class:`_schema.Table` as keys.

         .. warning:: This dictionary does **not** take into account
            Python-specified default UPDATE values or generation functions,
            e.g. those specified using :paramref:`_schema.Column.onupdate`.
            These values will not be exercised for an ON CONFLICT style of
            UPDATE, unless they are manually specified in the
            :paramref:`.Insert.on_conflict_do_update.set_` dictionary.

        :param where:
         Optional argument. An expression object representing a ``WHERE``
         clause that restricts the rows affected by ``DO UPDATE SET``. Rows not
         meeting the ``WHERE`` condition will not be updated (effectively a
         ``DO NOTHING`` for those rows).


        .. seealso::

            :ref:`postgresql_insert_on_conflict`

        )OnConflictDoUpdater,   r+   r-   r.   r/   r0   r1   r%   r%   r&   on_conflict_do_updatep   s    <    zInsert.on_conflict_do_update)r-   r.   r/   r$   c                 C  s   t |||| _| S )a	  
        Specifies a DO NOTHING action for ON CONFLICT clause.

        The ``constraint`` and ``index_elements`` arguments
        are optional, but only one of these can be specified.

        :param constraint:
         The name of a unique or exclusion constraint on the table,
         or the constraint object itself if it has a .name attribute.

        :param index_elements:
         A sequence consisting of string column names, :class:`_schema.Column`
         objects, or other column expression objects that will be used
         to infer a target index.

        :param index_where:
         Additional WHERE criterion that can be used to infer a
         conditional target index.

        .. seealso::

            :ref:`postgresql_insert_on_conflict`

        )OnConflictDoNothingr,   r+   r-   r.   r/   r%   r%   r&   on_conflict_do_nothing   s       zInsert.on_conflict_do_nothing)NNNNN)NNN)__name__
__module____qualname____doc__stringify_dialectZinherit_cacher   Zmemoized_propertyr(   r   Z_on_conflict_exclusiver   r4   r7   r%   r%   r%   r&   r   >   s2   	      ?   c                   @  s>   e Zd ZU dZded< ded< ded< dd	d
ddddZdS )OnConflictClauser'   zOptional[str]constraint_targetz.Optional[List[Union[str, schema.Column[Any]]]]inferred_target_elementsz/Optional[Union[ColumnElement[Any], TextClause]]inferred_target_whereclauseNr   r   r   r-   r.   r/   c                 C  s.  |d k	r2t |ts2t |tjtjfr2t|dp0|}|d k	r|d k	rJtdt |trh|| _d | _	d | _
nTt |tjr|j}|jd d}n0t |tjr|j}|j}n|j}|jd d}|d k	rd | _dd |D | _	|d k	rtt |tjrtjntj|nd | _
n|d kr*d  | _ | _	| _
d S )Nr)   z8'constraint' and 'index_elements' are mutually exclusiver'   r1   c                 S  s   g | ]}t tj|qS r%   )r   expectr   ZDDLConstraintColumnRole).0columnr%   r%   r&   
<listcomp>  s   z-OnConflictClause.__init__.<locals>.<listcomp>)
isinstancestrr   Z
Constraintr	   ZExcludeConstraintgetattr
ValueErrorr>   r?   r@   ZIndexZexpressionsZdialect_optionsgetr*   r1   r   rB   r   ZStatementOptionRoleWhereHavingRoler6   r%   r%   r&   __init__   s\    





	
zOnConflictClause.__init__)NNN)r8   r9   r:   r<   __annotations__rL   r%   r%   r%   r&   r=      s   
   r=   c                   @  s   e Zd ZdZdS )r5   r7   N)r8   r9   r:   __visit_name__r%   r%   r%   r&   r5     s   r5   c                      sB   e Zd ZU dZded< ded< dddd	d
dd fddZ  ZS )r2   r4   z0List[Tuple[Union[schema.Column[Any], str], Any]]update_values_to_setzOptional[ColumnElement[Any]]update_whereclauseNr   r   r   r   r   )r-   r.   r/   r0   r1   c                   s   t  j|||d | jd kr.| jd kr.tdt|trF|sbtdnt|trZt|}ntddd | D | _	|d k	rt
tj|nd | _d S )NrA   zVEither constraint or index_elements, but not both, must be specified unless DO NOTHINGz*set parameter dictionary must not be emptyzqset parameter must be a non-empty dictionary or a ColumnCollection such as the `.c.` collection of a Table objectc                 S  s"   g | ]\}}t tj||fqS r%   )r   rB   r   ZDMLColumnRole)rC   keyvaluer%   r%   r&   rE   K  s   z/OnConflictDoUpdate.__init__.<locals>.<listcomp>)superrL   r?   r>   rI   rF   dictr   itemsrO   r   rB   r   rK   rP   r3   	__class__r%   r&   rL   )  s6    



zOnConflictDoUpdate.__init__)NNNNN)r8   r9   r:   rN   rM   rL   __classcell__r%   r%   rV   r&   r2   #  s   
     r2   N)-
__future__r   typingr   r   r   r   r    r	   _typingr   r   r   r   r   r   Zsqlr   r   r   Zsql._typingr   Zsql.baser   r   r   r   Zsql.dmlr   ZStandardInsertZsql.elementsr   r   r   r   Zsql.expressionr    Zutil.typingr!   __all__r"   r=   r5   r2   r%   r%   r%   r&   <module>   sD    H