U ovg?@stddlmZddlmZddlmZddlmZddlmZddlm Z dd l m Z dd l m Z dd l m Z dd l mZdd l mZddl mZddlmZddlmZddlmZededZerddlmZGddde jZGdddeZddZGdddejeZGdddeZGdd d eZ Gd!d"d"eZ!Gd#d$d$eZ"Gd%d&d&eZ#Gd'd(d(eZ$d)S)*) annotations)Any) TYPE_CHECKING)TypeVar)types)ARRAY) coercions)elements) expression) functions)roles)schema)ColumnCollectionConstraint)TEXT)InternalTraversal_T)bound)_TraverseInternalsTypec@sreZdZUdZdZdZdejfdejfdejfgZ de d<dd Z dd d Z d dZ ejfddZeddZd S)aggregate_order_byaRepresent a PostgreSQL aggregate order by expression. E.g.:: from sqlalchemy.dialects.postgresql import aggregate_order_by expr = func.array_agg(aggregate_order_by(table.c.a, table.c.b.desc())) stmt = select(expr) would represent the expression: .. sourcecode:: sql SELECT array_agg(a ORDER BY b DESC) FROM table; Similarly:: expr = func.string_agg( table.c.a, aggregate_order_by(literal_column("','"), table.c.a) ) stmt = select(expr) Would represent: .. sourcecode:: sql SELECT string_agg(a, ',' ORDER BY a) FROM table; .. versionchanged:: 1.2.13 - the ORDER BY argument may be multiple terms .. seealso:: :class:`_functions.array_agg` postgresqltargettypeorder_byr_traverse_internalscGsjttj||_|jj|_t|}|dkr4tdn2|dkrRttj|d|_nt j |dtji|_dS)Nrz)at least one ORDER BY element is requiredrZ_literal_as_text_role) r expectrExpressionElementRolerrlen TypeErrorrr Z ClauseList)selfrrZ_lobr!F/tmp/pip-unpacked-wheel-uqd9otp_/sqlalchemy/dialects/postgresql/ext.py__init__Ns  zaggregate_order_by.__init__NcCs|SNr!)r Zagainstr!r!r" self_group^szaggregate_order_by.self_groupcKs |j|jfSr$rr)r kwargsr!r!r" get_childrenaszaggregate_order_by.get_childrencKs$||jf||_||jf||_dSr$r&)r clonekwr!r!r"_copy_internalsdsz"aggregate_order_by._copy_internalscCs|jj|jjSr$)r _from_objectsrr r!r!r"r,hsz aggregate_order_by._from_objects)N)__name__ __module__ __qualname____doc____visit_name__Zstringify_dialectrZdp_clauseelementZdp_typer__annotations__r#r%r(r Z_cloner+propertyr,r!r!r!r"r s $  rcsPeZdZdZdZdZdZdZe dddd d Z fd d Z dd dZ Z S)ExcludeConstraintzA table-level EXCLUDE constraint. Defines an EXCLUDE constraint as described in the `PostgreSQL documentation`__. __ https://www.postgresql.org/docs/current/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE Zexclude_constraintNFrwherez:class:`.ExcludeConstraint`z$:paramref:`.ExcludeConstraint.where`cOsg}g}i|_t|\}}tttj||D]V\\}}} } } | dk rP|| |dk r^|jn| } | dk rt| |j| <||| | fq.||_t j |f|| d| d| dd| dd|_ | d} | dk rt tj| |_| d i|_dS) a Create an :class:`.ExcludeConstraint` object. E.g.:: const = ExcludeConstraint( (Column("period"), "&&"), (Column("group"), "="), where=(Column("group") != "some group"), ops={"group": "my_operator_class"}, ) The constraint is normally embedded into the :class:`_schema.Table` construct directly, or added later using :meth:`.append_constraint`:: some_table = Table( "some_table", metadata, Column("id", Integer, primary_key=True), Column("period", TSRANGE()), Column("group", String), ) some_table.append_constraint( ExcludeConstraint( (some_table.c.period, "&&"), (some_table.c.group, "="), where=some_table.c.group != "some group", name="some_table_excl_const", ops={"group": "my_operator_class"}, ) ) The exclude constraint defined in this example requires the ``btree_gist`` extension, that can be created using the command ``CREATE EXTENSION btree_gist;``. :param \*elements: A sequence of two tuples of the form ``(column, operator)`` where "column" is either a :class:`_schema.Column` object, or a SQL expression element (e.g. ``func.int8range(table.from, table.to)``) or the name of a column as string, and "operator" is a string containing the operator to use (e.g. `"&&"` or `"="`). In order to specify a column name when a :class:`_schema.Column` object is not available, while ensuring that any necessary quoting rules take effect, an ad-hoc :class:`_schema.Column` or :func:`_expression.column` object should be used. The ``column`` may also be a string SQL expression when passed as :func:`_expression.literal_column` or :func:`_expression.text` :param name: Optional, the in-database name of this constraint. :param deferrable: Optional bool. If set, emit DEFERRABLE or NOT DEFERRABLE when issuing DDL for this constraint. :param initially: Optional string. If set, emit INITIALLY when issuing DDL for this constraint. :param using: Optional string. If set, emit USING when issuing DDL for this constraint. Defaults to 'gist'. :param where: Optional SQL expression construct or literal SQL string. If set, emit WHERE when issuing DDL for this constraint. :param ops: Optional dictionary. Used to define operator classes for the elements; works the same way as that of the :ref:`postgresql_ops ` parameter specified to the :class:`_schema.Index` construct. .. versionadded:: 1.3.21 .. seealso:: :ref:`postgresql_operator_classes` - general description of how PostgreSQL operator classes are specified. Nname deferrable initially)r7r8r9usingZgistr6ops) operatorszipr Z expect_col_expression_collectionrZDDLConstraintColumnRoleappendr7 _render_exprsrr#getr:rZStatementOptionRoler6r;)r r r*columnsZ render_exprsZ expressionsr<exprcolumnZstrnameZ add_elementoperatorr7r6r!r!r"r#~s@_    zExcludeConstraint.__init__c s&tfdd|jD|_dS)Ncs0g|](\}}}t|ts|nj|||fqSr!) isinstancestrc).0rBr7rDtabler!r" s z1ExcludeConstraint._set_parent..)super _set_parentr?)r rJr* __class__rIr"rMs  zExcludeConstraint._set_parentc sJfddjD}j|jjjjjd}|jj|S)Ncs&g|]\}}}t|j|fqSr!)rZ_copy_expressionparent)rHrB_rDr target_tabler!r"rKsz+ExcludeConstraint._copy..)r7r8r9r6r:) r?rOr7r8r9r6r:dispatch_update)r rSr*r rGr!rRr"_copys zExcludeConstraint._copy)N)r.r/r0r1r2r6 inherit_cacheZcreate_drop_stringify_dialectr Z_document_text_coercionr#rMrV __classcell__r!r!rNr"r5ms   r5cOst|d<tjj||S)zPostgreSQL-specific form of :class:`_functions.array_agg`, ensures return type is :class:`_postgresql.ARRAY` and not the plain :class:`_types.ARRAY`, unless an explicit ``type_`` is passed. Z_default_array_type)rr func array_agg)argr*r!r!r"rZ$srZcs eZdZdZfddZZS) _regconfig_fnTcsnt|}t|dkrBtjtj|dtddtj d}|g}ng}fdd|D}t j |||dS)Nrrr7)r7apply_propagate_attrstype_c s(g|] }tjtj|tdddqSr7N)r7r]r rrrgetattrrHrGr-r!r"rK@s z*_regconfig_fn.__init__..) listrr rrrpoprar REGCONFIGrLr#)r argsr' initial_arg addtl_argsrNr-r"r#2s    z_regconfig_fn.__init__)r.r/r0rWr#rXr!r!rNr"r\/sr\c@seZdZdZdZejZdS) to_tsvectoraThe PostgreSQL ``to_tsvector`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_postgresql.TSVECTOR`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.to_tsvector` will be used automatically when invoking ``sqlalchemy.func.to_tsvector()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 TN)r.r/r0r1rWrZTSVECTORrr!r!r!r"riLsric@seZdZdZdZejZdS) to_tsqueryaThe PostgreSQL ``to_tsquery`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_postgresql.TSQUERY`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.to_tsquery` will be used automatically when invoking ``sqlalchemy.func.to_tsquery()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 TNr.r/r0r1rWrTSQUERYrr!r!r!r"rjbsrjc@seZdZdZdZejZdS)plainto_tsqueryaThe PostgreSQL ``plainto_tsquery`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_postgresql.TSQUERY`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.plainto_tsquery` will be used automatically when invoking ``sqlalchemy.func.plainto_tsquery()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 TNrkr!r!r!r"rmxsrmc@seZdZdZdZejZdS)phraseto_tsqueryaThe PostgreSQL ``phraseto_tsquery`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_postgresql.TSQUERY`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.phraseto_tsquery` will be used automatically when invoking ``sqlalchemy.func.phraseto_tsquery()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 TNrkr!r!r!r"rnsrnc@seZdZdZdZejZdS)websearch_to_tsqueryaThe PostgreSQL ``websearch_to_tsquery`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_postgresql.TSQUERY`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.websearch_to_tsquery` will be used automatically when invoking ``sqlalchemy.func.websearch_to_tsquery()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 TNrkr!r!r!r"rosrocs(eZdZdZdZeZfddZZS) ts_headlineaThe PostgreSQL ``ts_headline`` SQL function. This function applies automatic casting of the REGCONFIG argument to use the :class:`_postgresql.REGCONFIG` datatype automatically, and applies a return type of :class:`_types.TEXT`. Assuming the PostgreSQL dialect has been imported, either by invoking ``from sqlalchemy.dialects import postgresql``, or by creating a PostgreSQL engine using ``create_engine("postgresql...")``, :class:`_postgresql.ts_headline` will be used automatically when invoking ``sqlalchemy.func.ts_headline()``, ensuring the correct argument and return type handlers are used at compile and execution time. .. versionadded:: 2.0.0rc1 Tcst|}t|dkrd}n,t|dtjrB|djjtjkrBd}nd}|rxt j t j | dtddtjd}|g}ng}fdd |D}tj|||dS) NFrTrr7)r]r7r^c s(g|] }tjtj|tdddqSr_r`rbr-r!r"rKs z(ts_headline.__init__..)rcrrEr ColumnElementrZ_type_affinityrrlr rrrrdrarerLr#)r rfr'Z has_regconfigrgrhrNr-r"r#s.    zts_headline.__init__) r.r/r0r1rWrrr#rXr!r!rNr"rpsrpN)% __future__rtypingrrrrarrayrZsqlr r r r rrZ sql.schemarZ sql.sqltypesrZ sql.visitorsrrrrrrr5rZZGenericFunctionr\rirjrmrnrorpr!r!r!r"s8                 M8