o g @sdZddlmZddlmZddlmZddlZddlm Z ddlm Z ddlm Z dd lm Z dd lm Z dd lmZdd lmZd dlmZd dlmZd dlmZd dlmZd dlmZd dlmZd dlmZd dlmZd dlmZd dlm Z d dlm!Z!d dlm"Z"d dlm#Z#d dlm$Z$d dl%m&Z&d dl%m'Z'd dl%m(Z(d dl%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%m0Z0d d'l%m1Z1d d(l%m2Z2d d)l%m3Z3d d*l%m4Z4d d+l%m5Z5d d,l%m6Z6d d-l%m7Z7d d.l%m8Z8d d/l%m9Z9d d0l%m:Z:d d1l%m;Z;d d2l%mZ>d5d6lm?Z?d5d7lm@Z@d5d8lmAZAd5d9lmBZBd5d:lmCZCd5d;lDmEZEd5dlDmHZHd5d?lDmIZId5d@lDmJZJd5dAlDmKZKd5dBlLmMZMd5dClBmNZNd5dDlBmOZOd5dElBmPZPd5dFlBmQZQd5dGlBmRZRd5dHlBmSZSd5dIlBmTZTd5d:lBmCZUd5dJlVmWZWd5dKlXmYZYd5dLl%mZZZd5dMl%m[Z[d5dNl%m\Z\d5dOl%m]Z]d5dPl%m^Z^d5dQl%m_Z_d5dRl%m`Z`d5dSl%maZad5dTl%mbZbd5dUl%mcZcd5dVl%mdZdd5dWl%meZed5dXl%mfZfd5dYlgmhZheidZejjZkhd[ZleTjmejmeTjne.eTjoe#eTjpjqejreTjpejpeTjse9iZtid\ejmd]ed^ejpd_ejud`ejvdaejwdbejxdcejyddejzdeej{dfej|dgej}dhej~diejdjejdkejdle`idmeZdnecdoefdpe\dqeTjdreTjdseddteadue_dvebdwe-dxe+dye,dzeed{e)d|e)d}e/id~e0de1de2de:de^de=de=de=de<de<de]de<de*de[de.de>ZGdddePjZGdddePjZGdddePjZGdddePjZGdddehZGdddehZGdddeZGdddeZGdddeJjZGdddeFjZGdddeEjZGdddeEjZGdddeFjZdS)a .. dialect:: postgresql :name: PostgreSQL :normal_support: 9.6+ :best_effort: 9+ .. _postgresql_sequences: Sequences/SERIAL/IDENTITY ------------------------- PostgreSQL supports sequences, and SQLAlchemy uses these as the default means of creating new primary key values for integer-based primary key columns. When creating tables, SQLAlchemy will issue the ``SERIAL`` datatype for integer-based primary key columns, which generates a sequence and server side default corresponding to the column. To specify a specific named sequence to be used for primary key generation, use the :func:`~sqlalchemy.schema.Sequence` construct:: Table( "sometable", metadata, Column( "id", Integer, Sequence("some_id_seq", start=1), primary_key=True ), ) When SQLAlchemy issues a single INSERT statement, to fulfill the contract of having the "last insert identifier" available, a RETURNING clause is added to the INSERT statement which specifies the primary key columns should be returned after the statement completes. The RETURNING functionality only takes place if PostgreSQL 8.2 or later is in use. As a fallback approach, the sequence, whether specified explicitly or implicitly via ``SERIAL``, is executed independently beforehand, the returned value to be used in the subsequent insert. Note that when an :func:`~sqlalchemy.sql.expression.insert()` construct is executed using "executemany" semantics, the "last inserted identifier" functionality does not apply; no RETURNING clause is emitted nor is the sequence pre-executed in this case. PostgreSQL 10 and above IDENTITY columns ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PostgreSQL 10 and above have a new IDENTITY feature that supersedes the use of SERIAL. The :class:`_schema.Identity` construct in a :class:`_schema.Column` can be used to control its behavior:: from sqlalchemy import Table, Column, MetaData, Integer, Computed metadata = MetaData() data = Table( "data", metadata, Column( "id", Integer, Identity(start=42, cycle=True), primary_key=True ), Column("data", String), ) The CREATE TABLE for the above :class:`_schema.Table` object would be: .. sourcecode:: sql CREATE TABLE data ( id INTEGER GENERATED BY DEFAULT AS IDENTITY (START WITH 42 CYCLE), data VARCHAR, PRIMARY KEY (id) ) .. versionchanged:: 1.4 Added :class:`_schema.Identity` construct in a :class:`_schema.Column` to specify the option of an autoincrementing column. .. note:: Previous versions of SQLAlchemy did not have built-in support for rendering of IDENTITY, and could use the following compilation hook to replace occurrences of SERIAL with IDENTITY:: from sqlalchemy.schema import CreateColumn from sqlalchemy.ext.compiler import compiles @compiles(CreateColumn, "postgresql") def use_identity(element, compiler, **kw): text = compiler.visit_create_column(element, **kw) text = text.replace("SERIAL", "INT GENERATED BY DEFAULT AS IDENTITY") return text Using the above, a table such as:: t = Table( "t", m, Column("id", Integer, primary_key=True), Column("data", String) ) Will generate on the backing database as: .. sourcecode:: sql CREATE TABLE t ( id INT GENERATED BY DEFAULT AS IDENTITY, data VARCHAR, PRIMARY KEY (id) ) .. _postgresql_ss_cursors: Server Side Cursors ------------------- Server-side cursor support is available for the psycopg2, asyncpg dialects and may also be available in others. Server side cursors are enabled on a per-statement basis by using the :paramref:`.Connection.execution_options.stream_results` connection execution option:: with engine.connect() as conn: result = conn.execution_options(stream_results=True).execute( text("select * from table") ) Note that some kinds of SQL statements may not be supported with server side cursors; generally, only SQL statements that return rows should be used with this option. .. deprecated:: 1.4 The dialect-level server_side_cursors flag is deprecated and will be removed in a future release. Please use the :paramref:`_engine.Connection.stream_results` execution option for unbuffered cursor support. .. seealso:: :ref:`engine_stream_results` .. _postgresql_isolation_level: Transaction Isolation Level --------------------------- Most SQLAlchemy dialects support setting of transaction isolation level using the :paramref:`_sa.create_engine.isolation_level` parameter at the :func:`_sa.create_engine` level, and at the :class:`_engine.Connection` level via the :paramref:`.Connection.execution_options.isolation_level` parameter. For PostgreSQL dialects, this feature works either by making use of the DBAPI-specific features, such as psycopg2's isolation level flags which will embed the isolation level setting inline with the ``"BEGIN"`` statement, or for DBAPIs with no direct support by emitting ``SET SESSION CHARACTERISTICS AS TRANSACTION ISOLATION LEVEL `` ahead of the ``"BEGIN"`` statement emitted by the DBAPI. For the special AUTOCOMMIT isolation level, DBAPI-specific techniques are used which is typically an ``.autocommit`` flag on the DBAPI connection object. To set isolation level using :func:`_sa.create_engine`:: engine = create_engine( "postgresql+pg8000://scott:tiger@localhost/test", isolation_level="REPEATABLE READ", ) To set using per-connection execution options:: with engine.connect() as conn: conn = conn.execution_options(isolation_level="REPEATABLE READ") with conn.begin(): ... # work with transaction There are also more options for isolation level configurations, such as "sub-engine" objects linked to a main :class:`_engine.Engine` which each apply different isolation level settings. See the discussion at :ref:`dbapi_autocommit` for background. Valid values for ``isolation_level`` on most PostgreSQL dialects include: * ``READ COMMITTED`` * ``READ UNCOMMITTED`` * ``REPEATABLE READ`` * ``SERIALIZABLE`` * ``AUTOCOMMIT`` .. seealso:: :ref:`dbapi_autocommit` :ref:`postgresql_readonly_deferrable` :ref:`psycopg2_isolation_level` :ref:`pg8000_isolation_level` .. _postgresql_readonly_deferrable: Setting READ ONLY / DEFERRABLE ------------------------------ Most PostgreSQL dialects support setting the "READ ONLY" and "DEFERRABLE" characteristics of the transaction, which is in addition to the isolation level setting. These two attributes can be established either in conjunction with or independently of the isolation level by passing the ``postgresql_readonly`` and ``postgresql_deferrable`` flags with :meth:`_engine.Connection.execution_options`. The example below illustrates passing the ``"SERIALIZABLE"`` isolation level at the same time as setting "READ ONLY" and "DEFERRABLE":: with engine.connect() as conn: conn = conn.execution_options( isolation_level="SERIALIZABLE", postgresql_readonly=True, postgresql_deferrable=True, ) with conn.begin(): ... # work with transaction Note that some DBAPIs such as asyncpg only support "readonly" with SERIALIZABLE isolation. .. versionadded:: 1.4 added support for the ``postgresql_readonly`` and ``postgresql_deferrable`` execution options. .. _postgresql_reset_on_return: Temporary Table / Resource Reset for Connection Pooling ------------------------------------------------------- The :class:`.QueuePool` connection pool implementation used by the SQLAlchemy :class:`.Engine` object includes :ref:`reset on return ` behavior that will invoke the DBAPI ``.rollback()`` method when connections are returned to the pool. While this rollback will clear out the immediate state used by the previous transaction, it does not cover a wider range of session-level state, including temporary tables as well as other server state such as prepared statement handles and statement caches. The PostgreSQL database includes a variety of commands which may be used to reset this state, including ``DISCARD``, ``RESET``, ``DEALLOCATE``, and ``UNLISTEN``. To install one or more of these commands as the means of performing reset-on-return, the :meth:`.PoolEvents.reset` event hook may be used, as demonstrated in the example below. The implementation will end transactions in progress as well as discard temporary tables using the ``CLOSE``, ``RESET`` and ``DISCARD`` commands; see the PostgreSQL documentation for background on what each of these statements do. The :paramref:`_sa.create_engine.pool_reset_on_return` parameter is set to ``None`` so that the custom scheme can replace the default behavior completely. The custom hook implementation calls ``.rollback()`` in any case, as it's usually important that the DBAPI's own tracking of commit/rollback will remain consistent with the state of the transaction:: from sqlalchemy import create_engine from sqlalchemy import event postgresql_engine = create_engine( "postgresql+pyscopg2://scott:tiger@hostname/dbname", # disable default reset-on-return scheme pool_reset_on_return=None, ) @event.listens_for(postgresql_engine, "reset") def _reset_postgresql(dbapi_connection, connection_record, reset_state): if not reset_state.terminate_only: dbapi_connection.execute("CLOSE ALL") dbapi_connection.execute("RESET ALL") dbapi_connection.execute("DISCARD TEMP") # so that the DBAPI itself knows that the connection has been # reset dbapi_connection.rollback() .. versionchanged:: 2.0.0b3 Added additional state arguments to the :meth:`.PoolEvents.reset` event and additionally ensured the event is invoked for all "reset" occurrences, so that it's appropriate as a place for custom "reset" handlers. Previous schemes which use the :meth:`.PoolEvents.checkin` handler remain usable as well. .. seealso:: :ref:`pool_reset_on_return` - in the :ref:`pooling_toplevel` documentation .. _postgresql_alternate_search_path: Setting Alternate Search Paths on Connect ------------------------------------------ The PostgreSQL ``search_path`` variable refers to the list of schema names that will be implicitly referenced when a particular table or other object is referenced in a SQL statement. As detailed in the next section :ref:`postgresql_schema_reflection`, SQLAlchemy is generally organized around the concept of keeping this variable at its default value of ``public``, however, in order to have it set to any arbitrary name or names when connections are used automatically, the "SET SESSION search_path" command may be invoked for all connections in a pool using the following event handler, as discussed at :ref:`schema_set_default_connections`:: from sqlalchemy import event from sqlalchemy import create_engine engine = create_engine("postgresql+psycopg2://scott:tiger@host/dbname") @event.listens_for(engine, "connect", insert=True) def set_search_path(dbapi_connection, connection_record): existing_autocommit = dbapi_connection.autocommit dbapi_connection.autocommit = True cursor = dbapi_connection.cursor() cursor.execute("SET SESSION search_path='%s'" % schema_name) cursor.close() dbapi_connection.autocommit = existing_autocommit The reason the recipe is complicated by use of the ``.autocommit`` DBAPI attribute is so that when the ``SET SESSION search_path`` directive is invoked, it is invoked outside of the scope of any transaction and therefore will not be reverted when the DBAPI connection has a rollback. .. seealso:: :ref:`schema_set_default_connections` - in the :ref:`metadata_toplevel` documentation .. _postgresql_schema_reflection: Remote-Schema Table Introspection and PostgreSQL search_path ------------------------------------------------------------ .. admonition:: Section Best Practices Summarized keep the ``search_path`` variable set to its default of ``public``, without any other schema names. Ensure the username used to connect **does not** match remote schemas, or ensure the ``"$user"`` token is **removed** from ``search_path``. For other schema names, name these explicitly within :class:`_schema.Table` definitions. Alternatively, the ``postgresql_ignore_search_path`` option will cause all reflected :class:`_schema.Table` objects to have a :attr:`_schema.Table.schema` attribute set up. The PostgreSQL dialect can reflect tables from any schema, as outlined in :ref:`metadata_reflection_schemas`. In all cases, the first thing SQLAlchemy does when reflecting tables is to **determine the default schema for the current database connection**. It does this using the PostgreSQL ``current_schema()`` function, illustated below using a PostgreSQL client session (i.e. using the ``psql`` tool): .. sourcecode:: sql test=> select current_schema(); current_schema ---------------- public (1 row) Above we see that on a plain install of PostgreSQL, the default schema name is the name ``public``. However, if your database username **matches the name of a schema**, PostgreSQL's default is to then **use that name as the default schema**. Below, we log in using the username ``scott``. When we create a schema named ``scott``, **it implicitly changes the default schema**: .. sourcecode:: sql test=> select current_schema(); current_schema ---------------- public (1 row) test=> create schema scott; CREATE SCHEMA test=> select current_schema(); current_schema ---------------- scott (1 row) The behavior of ``current_schema()`` is derived from the `PostgreSQL search path `_ variable ``search_path``, which in modern PostgreSQL versions defaults to this: .. sourcecode:: sql test=> show search_path; search_path ----------------- "$user", public (1 row) Where above, the ``"$user"`` variable will inject the current username as the default schema, if one exists. Otherwise, ``public`` is used. When a :class:`_schema.Table` object is reflected, if it is present in the schema indicated by the ``current_schema()`` function, **the schema name assigned to the ".schema" attribute of the Table is the Python "None" value**. Otherwise, the ".schema" attribute will be assigned the string name of that schema. With regards to tables which these :class:`_schema.Table` objects refer to via foreign key constraint, a decision must be made as to how the ``.schema`` is represented in those remote tables, in the case where that remote schema name is also a member of the current ``search_path``. By default, the PostgreSQL dialect mimics the behavior encouraged by PostgreSQL's own ``pg_get_constraintdef()`` builtin procedure. This function returns a sample definition for a particular foreign key constraint, omitting the referenced schema name from that definition when the name is also in the PostgreSQL schema search path. The interaction below illustrates this behavior: .. sourcecode:: sql test=> CREATE TABLE test_schema.referred(id INTEGER PRIMARY KEY); CREATE TABLE test=> CREATE TABLE referring( test(> id INTEGER PRIMARY KEY, test(> referred_id INTEGER REFERENCES test_schema.referred(id)); CREATE TABLE test=> SET search_path TO public, test_schema; test=> SELECT pg_catalog.pg_get_constraintdef(r.oid, true) FROM test-> pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n test-> ON n.oid = c.relnamespace test-> JOIN pg_catalog.pg_constraint r ON c.oid = r.conrelid test-> WHERE c.relname='referring' AND r.contype = 'f' test-> ; pg_get_constraintdef --------------------------------------------------- FOREIGN KEY (referred_id) REFERENCES referred(id) (1 row) Above, we created a table ``referred`` as a member of the remote schema ``test_schema``, however when we added ``test_schema`` to the PG ``search_path`` and then asked ``pg_get_constraintdef()`` for the ``FOREIGN KEY`` syntax, ``test_schema`` was not included in the output of the function. On the other hand, if we set the search path back to the typical default of ``public``: .. sourcecode:: sql test=> SET search_path TO public; SET The same query against ``pg_get_constraintdef()`` now returns the fully schema-qualified name for us: .. sourcecode:: sql test=> SELECT pg_catalog.pg_get_constraintdef(r.oid, true) FROM test-> pg_catalog.pg_class c JOIN pg_catalog.pg_namespace n test-> ON n.oid = c.relnamespace test-> JOIN pg_catalog.pg_constraint r ON c.oid = r.conrelid test-> WHERE c.relname='referring' AND r.contype = 'f'; pg_get_constraintdef --------------------------------------------------------------- FOREIGN KEY (referred_id) REFERENCES test_schema.referred(id) (1 row) SQLAlchemy will by default use the return value of ``pg_get_constraintdef()`` in order to determine the remote schema name. That is, if our ``search_path`` were set to include ``test_schema``, and we invoked a table reflection process as follows:: >>> from sqlalchemy import Table, MetaData, create_engine, text >>> engine = create_engine("postgresql+psycopg2://scott:tiger@localhost/test") >>> with engine.connect() as conn: ... conn.execute(text("SET search_path TO test_schema, public")) ... metadata_obj = MetaData() ... referring = Table("referring", metadata_obj, autoload_with=conn) The above process would deliver to the :attr:`_schema.MetaData.tables` collection ``referred`` table named **without** the schema:: >>> metadata_obj.tables["referred"].schema is None True To alter the behavior of reflection such that the referred schema is maintained regardless of the ``search_path`` setting, use the ``postgresql_ignore_search_path`` option, which can be specified as a dialect-specific argument to both :class:`_schema.Table` as well as :meth:`_schema.MetaData.reflect`:: >>> with engine.connect() as conn: ... conn.execute(text("SET search_path TO test_schema, public")) ... metadata_obj = MetaData() ... referring = Table( ... "referring", ... metadata_obj, ... autoload_with=conn, ... postgresql_ignore_search_path=True, ... ) We will now have ``test_schema.referred`` stored as schema-qualified:: >>> metadata_obj.tables["test_schema.referred"].schema 'test_schema' .. sidebar:: Best Practices for PostgreSQL Schema reflection The description of PostgreSQL schema reflection behavior is complex, and is the product of many years of dealing with widely varied use cases and user preferences. But in fact, there's no need to understand any of it if you just stick to the simplest use pattern: leave the ``search_path`` set to its default of ``public`` only, never refer to the name ``public`` as an explicit schema name otherwise, and refer to all other schema names explicitly when building up a :class:`_schema.Table` object. The options described here are only for those users who can't, or prefer not to, stay within these guidelines. .. seealso:: :ref:`reflection_schema_qualified_interaction` - discussion of the issue from a backend-agnostic perspective `The Schema Search Path `_ - on the PostgreSQL website. INSERT/UPDATE...RETURNING ------------------------- The dialect supports PG 8.2's ``INSERT..RETURNING``, ``UPDATE..RETURNING`` and ``DELETE..RETURNING`` syntaxes. ``INSERT..RETURNING`` is used by default for single-row INSERT statements in order to fetch newly generated primary key identifiers. To specify an explicit ``RETURNING`` clause, use the :meth:`._UpdateBase.returning` method on a per-statement basis:: # INSERT..RETURNING result = ( table.insert().returning(table.c.col1, table.c.col2).values(name="foo") ) print(result.fetchall()) # UPDATE..RETURNING result = ( table.update() .returning(table.c.col1, table.c.col2) .where(table.c.name == "foo") .values(name="bar") ) print(result.fetchall()) # DELETE..RETURNING result = ( table.delete() .returning(table.c.col1, table.c.col2) .where(table.c.name == "foo") ) print(result.fetchall()) .. _postgresql_insert_on_conflict: INSERT...ON CONFLICT (Upsert) ------------------------------ Starting with version 9.5, PostgreSQL allows "upserts" (update or insert) of rows into a table via the ``ON CONFLICT`` clause of the ``INSERT`` statement. A candidate row will only be inserted if that row does not violate any unique constraints. In the case of a unique constraint violation, a secondary action can occur which can be either "DO UPDATE", indicating that the data in the target row should be updated, or "DO NOTHING", which indicates to silently skip this row. Conflicts are determined using existing unique constraints and indexes. These constraints may be identified either using their name as stated in DDL, or they may be inferred by stating the columns and conditions that comprise the indexes. SQLAlchemy provides ``ON CONFLICT`` support via the PostgreSQL-specific :func:`_postgresql.insert()` function, which provides the generative methods :meth:`_postgresql.Insert.on_conflict_do_update` and :meth:`~.postgresql.Insert.on_conflict_do_nothing`: .. sourcecode:: pycon+sql >>> from sqlalchemy.dialects.postgresql import insert >>> insert_stmt = insert(my_table).values( ... id="some_existing_id", data="inserted value" ... ) >>> do_nothing_stmt = insert_stmt.on_conflict_do_nothing(index_elements=["id"]) >>> print(do_nothing_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO NOTHING {stop} >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... constraint="pk_my_table", set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT ON CONSTRAINT pk_my_table DO UPDATE SET data = %(param_1)s .. seealso:: `INSERT .. ON CONFLICT `_ - in the PostgreSQL documentation. Specifying the Target ^^^^^^^^^^^^^^^^^^^^^ Both methods supply the "target" of the conflict using either the named constraint or by column inference: * The :paramref:`_postgresql.Insert.on_conflict_do_update.index_elements` argument specifies a sequence containing string column names, :class:`_schema.Column` objects, and/or SQL expression elements, which would identify a unique index: .. sourcecode:: pycon+sql >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... index_elements=["id"], set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s {stop} >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... index_elements=[my_table.c.id], set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s * When using :paramref:`_postgresql.Insert.on_conflict_do_update.index_elements` to infer an index, a partial index can be inferred by also specifying the use the :paramref:`_postgresql.Insert.on_conflict_do_update.index_where` parameter: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values(user_email="a@b.com", data="inserted data") >>> stmt = stmt.on_conflict_do_update( ... index_elements=[my_table.c.user_email], ... index_where=my_table.c.user_email.like("%@gmail.com"), ... set_=dict(data=stmt.excluded.data), ... ) >>> print(stmt) {printsql}INSERT INTO my_table (data, user_email) VALUES (%(data)s, %(user_email)s) ON CONFLICT (user_email) WHERE user_email LIKE %(user_email_1)s DO UPDATE SET data = excluded.data * The :paramref:`_postgresql.Insert.on_conflict_do_update.constraint` argument is used to specify an index directly rather than inferring it. This can be the name of a UNIQUE constraint, a PRIMARY KEY constraint, or an INDEX: .. sourcecode:: pycon+sql >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... constraint="my_table_idx_1", set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT ON CONSTRAINT my_table_idx_1 DO UPDATE SET data = %(param_1)s {stop} >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... constraint="my_table_pk", set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT ON CONSTRAINT my_table_pk DO UPDATE SET data = %(param_1)s {stop} * The :paramref:`_postgresql.Insert.on_conflict_do_update.constraint` argument may also refer to a SQLAlchemy construct representing a constraint, e.g. :class:`.UniqueConstraint`, :class:`.PrimaryKeyConstraint`, :class:`.Index`, or :class:`.ExcludeConstraint`. In this use, if the constraint has a name, it is used directly. Otherwise, if the constraint is unnamed, then inference will be used, where the expressions and optional WHERE clause of the constraint will be spelled out in the construct. This use is especially convenient to refer to the named or unnamed primary key of a :class:`_schema.Table` using the :attr:`_schema.Table.primary_key` attribute: .. sourcecode:: pycon+sql >>> do_update_stmt = insert_stmt.on_conflict_do_update( ... constraint=my_table.primary_key, set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s The SET Clause ^^^^^^^^^^^^^^^ ``ON CONFLICT...DO UPDATE`` is used to perform an update of the already existing row, using any combination of new values as well as values from the proposed insertion. These values are specified using the :paramref:`_postgresql.Insert.on_conflict_do_update.set_` parameter. This parameter accepts a dictionary which consists of direct values for UPDATE: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values(id="some_id", data="inserted value") >>> do_update_stmt = stmt.on_conflict_do_update( ... index_elements=["id"], set_=dict(data="updated value") ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s .. warning:: The :meth:`_expression.Insert.on_conflict_do_update` method does **not** take into account Python-side 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:`_postgresql.Insert.on_conflict_do_update.set_` dictionary. Updating using the Excluded INSERT Values ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In order to refer to the proposed insertion row, the special alias :attr:`~.postgresql.Insert.excluded` is available as an attribute on the :class:`_postgresql.Insert` object; this object is a :class:`_expression.ColumnCollection` which alias contains all columns of the target table: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values( ... id="some_id", data="inserted value", author="jlh" ... ) >>> do_update_stmt = stmt.on_conflict_do_update( ... index_elements=["id"], ... set_=dict(data="updated value", author=stmt.excluded.author), ... ) >>> print(do_update_stmt) {printsql}INSERT INTO my_table (id, data, author) VALUES (%(id)s, %(data)s, %(author)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s, author = excluded.author Additional WHERE Criteria ^^^^^^^^^^^^^^^^^^^^^^^^^ The :meth:`_expression.Insert.on_conflict_do_update` method also accepts a WHERE clause using the :paramref:`_postgresql.Insert.on_conflict_do_update.where` parameter, which will limit those rows which receive an UPDATE: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values( ... id="some_id", data="inserted value", author="jlh" ... ) >>> on_update_stmt = stmt.on_conflict_do_update( ... index_elements=["id"], ... set_=dict(data="updated value", author=stmt.excluded.author), ... where=(my_table.c.status == 2), ... ) >>> print(on_update_stmt) {printsql}INSERT INTO my_table (id, data, author) VALUES (%(id)s, %(data)s, %(author)s) ON CONFLICT (id) DO UPDATE SET data = %(param_1)s, author = excluded.author WHERE my_table.status = %(status_1)s Skipping Rows with DO NOTHING ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``ON CONFLICT`` may be used to skip inserting a row entirely if any conflict with a unique or exclusion constraint occurs; below this is illustrated using the :meth:`~.postgresql.Insert.on_conflict_do_nothing` method: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values(id="some_id", data="inserted value") >>> stmt = stmt.on_conflict_do_nothing(index_elements=["id"]) >>> print(stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT (id) DO NOTHING If ``DO NOTHING`` is used without specifying any columns or constraint, it has the effect of skipping the INSERT for any unique or exclusion constraint violation which occurs: .. sourcecode:: pycon+sql >>> stmt = insert(my_table).values(id="some_id", data="inserted value") >>> stmt = stmt.on_conflict_do_nothing() >>> print(stmt) {printsql}INSERT INTO my_table (id, data) VALUES (%(id)s, %(data)s) ON CONFLICT DO NOTHING .. _postgresql_match: Full Text Search ---------------- PostgreSQL's full text search system is available through the use of the :data:`.func` namespace, combined with the use of custom operators via the :meth:`.Operators.bool_op` method. For simple cases with some degree of cross-backend compatibility, the :meth:`.Operators.match` operator may also be used. .. _postgresql_simple_match: Simple plain text matching with ``match()`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The :meth:`.Operators.match` operator provides for cross-compatible simple text matching. For the PostgreSQL backend, it's hardcoded to generate an expression using the ``@@`` operator in conjunction with the ``plainto_tsquery()`` PostgreSQL function. On the PostgreSQL dialect, an expression like the following:: select(sometable.c.text.match("search string")) would emit to the database: .. sourcecode:: sql SELECT text @@ plainto_tsquery('search string') FROM table Above, passing a plain string to :meth:`.Operators.match` will automatically make use of ``plainto_tsquery()`` to specify the type of tsquery. This establishes basic database cross-compatibility for :meth:`.Operators.match` with other backends. .. versionchanged:: 2.0 The default tsquery generation function used by the PostgreSQL dialect with :meth:`.Operators.match` is ``plainto_tsquery()``. To render exactly what was rendered in 1.4, use the following form:: from sqlalchemy import func select(sometable.c.text.bool_op("@@")(func.to_tsquery("search string"))) Which would emit: .. sourcecode:: sql SELECT text @@ to_tsquery('search string') FROM table Using PostgreSQL full text functions and operators directly ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Text search operations beyond the simple use of :meth:`.Operators.match` may make use of the :data:`.func` namespace to generate PostgreSQL full-text functions, in combination with :meth:`.Operators.bool_op` to generate any boolean operator. For example, the query:: select(func.to_tsquery("cat").bool_op("@>")(func.to_tsquery("cat & rat"))) would generate: .. sourcecode:: sql SELECT to_tsquery('cat') @> to_tsquery('cat & rat') The :class:`_postgresql.TSVECTOR` type can provide for explicit CAST:: from sqlalchemy.dialects.postgresql import TSVECTOR from sqlalchemy import select, cast select(cast("some text", TSVECTOR)) produces a statement equivalent to: .. sourcecode:: sql SELECT CAST('some text' AS TSVECTOR) AS anon_1 The ``func`` namespace is augmented by the PostgreSQL dialect to set up correct argument and return types for most full text search functions. These functions are used automatically by the :attr:`_sql.func` namespace assuming the ``sqlalchemy.dialects.postgresql`` package has been imported, or :func:`_sa.create_engine` has been invoked using a ``postgresql`` dialect. These functions are documented at: * :class:`_postgresql.to_tsvector` * :class:`_postgresql.to_tsquery` * :class:`_postgresql.plainto_tsquery` * :class:`_postgresql.phraseto_tsquery` * :class:`_postgresql.websearch_to_tsquery` * :class:`_postgresql.ts_headline` Specifying the "regconfig" with ``match()`` or custom operators ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PostgreSQL's ``plainto_tsquery()`` function accepts an optional "regconfig" argument that is used to instruct PostgreSQL to use a particular pre-computed GIN or GiST index in order to perform the search. When using :meth:`.Operators.match`, this additional parameter may be specified using the ``postgresql_regconfig`` parameter, such as:: select(mytable.c.id).where( mytable.c.title.match("somestring", postgresql_regconfig="english") ) Which would emit: .. sourcecode:: sql SELECT mytable.id FROM mytable WHERE mytable.title @@ plainto_tsquery('english', 'somestring') When using other PostgreSQL search functions with :data:`.func`, the "regconfig" parameter may be passed directly as the initial argument:: select(mytable.c.id).where( func.to_tsvector("english", mytable.c.title).bool_op("@@")( func.to_tsquery("english", "somestring") ) ) produces a statement equivalent to: .. sourcecode:: sql SELECT mytable.id FROM mytable WHERE to_tsvector('english', mytable.title) @@ to_tsquery('english', 'somestring') It is recommended that you use the ``EXPLAIN ANALYZE...`` tool from PostgreSQL to ensure that you are generating queries with SQLAlchemy that take full advantage of any indexes you may have created for full text search. .. seealso:: `Full Text Search `_ - in the PostgreSQL documentation FROM ONLY ... ------------- The dialect supports PostgreSQL's ONLY keyword for targeting only a particular table in an inheritance hierarchy. This can be used to produce the ``SELECT ... FROM ONLY``, ``UPDATE ONLY ...``, and ``DELETE FROM ONLY ...`` syntaxes. It uses SQLAlchemy's hints mechanism:: # SELECT ... FROM ONLY ... result = table.select().with_hint(table, "ONLY", "postgresql") print(result.fetchall()) # UPDATE ONLY ... table.update(values=dict(foo="bar")).with_hint( "ONLY", dialect_name="postgresql" ) # DELETE FROM ONLY ... table.delete().with_hint("ONLY", dialect_name="postgresql") .. _postgresql_indexes: PostgreSQL-Specific Index Options --------------------------------- Several extensions to the :class:`.Index` construct are available, specific to the PostgreSQL dialect. Covering Indexes ^^^^^^^^^^^^^^^^ The ``postgresql_include`` option renders INCLUDE(colname) for the given string names:: Index("my_index", table.c.x, postgresql_include=["y"]) would render the index as ``CREATE INDEX my_index ON table (x) INCLUDE (y)`` Note that this feature requires PostgreSQL 11 or later. .. versionadded:: 1.4 .. _postgresql_partial_indexes: Partial Indexes ^^^^^^^^^^^^^^^ Partial indexes add criterion to the index definition so that the index is applied to a subset of rows. These can be specified on :class:`.Index` using the ``postgresql_where`` keyword argument:: Index("my_index", my_table.c.id, postgresql_where=my_table.c.value > 10) .. _postgresql_operator_classes: Operator Classes ^^^^^^^^^^^^^^^^ PostgreSQL allows the specification of an *operator class* for each column of an index (see https://www.postgresql.org/docs/current/interactive/indexes-opclass.html). The :class:`.Index` construct allows these to be specified via the ``postgresql_ops`` keyword argument:: Index( "my_index", my_table.c.id, my_table.c.data, postgresql_ops={"data": "text_pattern_ops", "id": "int4_ops"}, ) Note that the keys in the ``postgresql_ops`` dictionaries are the "key" name of the :class:`_schema.Column`, i.e. the name used to access it from the ``.c`` collection of :class:`_schema.Table`, which can be configured to be different than the actual name of the column as expressed in the database. If ``postgresql_ops`` is to be used against a complex SQL expression such as a function call, then to apply to the column it must be given a label that is identified in the dictionary by name, e.g.:: Index( "my_index", my_table.c.id, func.lower(my_table.c.data).label("data_lower"), postgresql_ops={"data_lower": "text_pattern_ops", "id": "int4_ops"}, ) Operator classes are also supported by the :class:`_postgresql.ExcludeConstraint` construct using the :paramref:`_postgresql.ExcludeConstraint.ops` parameter. See that parameter for details. .. versionadded:: 1.3.21 added support for operator classes with :class:`_postgresql.ExcludeConstraint`. Index Types ^^^^^^^^^^^ PostgreSQL provides several index types: B-Tree, Hash, GiST, and GIN, as well as the ability for users to create their own (see https://www.postgresql.org/docs/current/static/indexes-types.html). These can be specified on :class:`.Index` using the ``postgresql_using`` keyword argument:: Index("my_index", my_table.c.data, postgresql_using="gin") The value passed to the keyword argument will be simply passed through to the underlying CREATE INDEX command, so it *must* be a valid index type for your version of PostgreSQL. .. _postgresql_index_storage: Index Storage Parameters ^^^^^^^^^^^^^^^^^^^^^^^^ PostgreSQL allows storage parameters to be set on indexes. The storage parameters available depend on the index method used by the index. Storage parameters can be specified on :class:`.Index` using the ``postgresql_with`` keyword argument:: Index("my_index", my_table.c.data, postgresql_with={"fillfactor": 50}) PostgreSQL allows to define the tablespace in which to create the index. The tablespace can be specified on :class:`.Index` using the ``postgresql_tablespace`` keyword argument:: Index("my_index", my_table.c.data, postgresql_tablespace="my_tablespace") Note that the same option is available on :class:`_schema.Table` as well. .. _postgresql_index_concurrently: Indexes with CONCURRENTLY ^^^^^^^^^^^^^^^^^^^^^^^^^ The PostgreSQL index option CONCURRENTLY is supported by passing the flag ``postgresql_concurrently`` to the :class:`.Index` construct:: tbl = Table("testtbl", m, Column("data", Integer)) idx1 = Index("test_idx1", tbl.c.data, postgresql_concurrently=True) The above index construct will render DDL for CREATE INDEX, assuming PostgreSQL 8.2 or higher is detected or for a connection-less dialect, as: .. sourcecode:: sql CREATE INDEX CONCURRENTLY test_idx1 ON testtbl (data) For DROP INDEX, assuming PostgreSQL 9.2 or higher is detected or for a connection-less dialect, it will emit: .. sourcecode:: sql DROP INDEX CONCURRENTLY test_idx1 When using CONCURRENTLY, the PostgreSQL database requires that the statement be invoked outside of a transaction block. The Python DBAPI enforces that even for a single statement, a transaction is present, so to use this construct, the DBAPI's "autocommit" mode must be used:: metadata = MetaData() table = Table("foo", metadata, Column("id", String)) index = Index("foo_idx", table.c.id, postgresql_concurrently=True) with engine.connect() as conn: with conn.execution_options(isolation_level="AUTOCOMMIT"): table.create(conn) .. seealso:: :ref:`postgresql_isolation_level` .. _postgresql_index_reflection: PostgreSQL Index Reflection --------------------------- The PostgreSQL database creates a UNIQUE INDEX implicitly whenever the UNIQUE CONSTRAINT construct is used. When inspecting a table using :class:`_reflection.Inspector`, the :meth:`_reflection.Inspector.get_indexes` and the :meth:`_reflection.Inspector.get_unique_constraints` will report on these two constructs distinctly; in the case of the index, the key ``duplicates_constraint`` will be present in the index entry if it is detected as mirroring a constraint. When performing reflection using ``Table(..., autoload_with=engine)``, the UNIQUE INDEX is **not** returned in :attr:`_schema.Table.indexes` when it is detected as mirroring a :class:`.UniqueConstraint` in the :attr:`_schema.Table.constraints` collection . Special Reflection Options -------------------------- The :class:`_reflection.Inspector` used for the PostgreSQL backend is an instance of :class:`.PGInspector`, which offers additional methods:: from sqlalchemy import create_engine, inspect engine = create_engine("postgresql+psycopg2://localhost/test") insp = inspect(engine) # will be a PGInspector print(insp.get_enums()) .. autoclass:: PGInspector :members: .. _postgresql_table_options: PostgreSQL Table Options ------------------------ Several options for CREATE TABLE are supported directly by the PostgreSQL dialect in conjunction with the :class:`_schema.Table` construct: * ``INHERITS``:: Table("some_table", metadata, ..., postgresql_inherits="some_supertable") Table("some_table", metadata, ..., postgresql_inherits=("t1", "t2", ...)) * ``ON COMMIT``:: Table("some_table", metadata, ..., postgresql_on_commit="PRESERVE ROWS") * ``PARTITION BY``:: Table( "some_table", metadata, ..., postgresql_partition_by="LIST (part_column)", ) .. versionadded:: 1.2.6 * ``TABLESPACE``:: Table("some_table", metadata, ..., postgresql_tablespace="some_tablespace") The above option is also available on the :class:`.Index` construct. * ``USING``:: Table("some_table", metadata, ..., postgresql_using="heap") .. versionadded:: 2.0.26 * ``WITH OIDS``:: Table("some_table", metadata, ..., postgresql_with_oids=True) * ``WITHOUT OIDS``:: Table("some_table", metadata, ..., postgresql_with_oids=False) .. seealso:: `PostgreSQL CREATE TABLE options `_ - in the PostgreSQL documentation. .. _postgresql_constraint_options: PostgreSQL Constraint Options ----------------------------- The following option(s) are supported by the PostgreSQL dialect in conjunction with selected constraint constructs: * ``NOT VALID``: This option applies towards CHECK and FOREIGN KEY constraints when the constraint is being added to an existing table via ALTER TABLE, and has the effect that existing rows are not scanned during the ALTER operation against the constraint being added. When using a SQL migration tool such as `Alembic `_ that renders ALTER TABLE constructs, the ``postgresql_not_valid`` argument may be specified as an additional keyword argument within the operation that creates the constraint, as in the following Alembic example:: def update(): op.create_foreign_key( "fk_user_address", "address", "user", ["user_id"], ["id"], postgresql_not_valid=True, ) The keyword is ultimately accepted directly by the :class:`_schema.CheckConstraint`, :class:`_schema.ForeignKeyConstraint` and :class:`_schema.ForeignKey` constructs; when using a tool like Alembic, dialect-specific keyword arguments are passed through to these constructs from the migration operation directives:: CheckConstraint("some_field IS NOT NULL", postgresql_not_valid=True) ForeignKeyConstraint( ["some_id"], ["some_table.some_id"], postgresql_not_valid=True ) .. versionadded:: 1.4.32 .. seealso:: `PostgreSQL ALTER TABLE options `_ - in the PostgreSQL documentation. .. _postgresql_table_valued_overview: Table values, Table and Column valued functions, Row and Tuple objects ----------------------------------------------------------------------- PostgreSQL makes great use of modern SQL forms such as table-valued functions, tables and rows as values. These constructs are commonly used as part of PostgreSQL's support for complex datatypes such as JSON, ARRAY, and other datatypes. SQLAlchemy's SQL expression language has native support for most table-valued and row-valued forms. .. _postgresql_table_valued: Table-Valued Functions ^^^^^^^^^^^^^^^^^^^^^^^ Many PostgreSQL built-in functions are intended to be used in the FROM clause of a SELECT statement, and are capable of returning table rows or sets of table rows. A large portion of PostgreSQL's JSON functions for example such as ``json_array_elements()``, ``json_object_keys()``, ``json_each_text()``, ``json_each()``, ``json_to_record()``, ``json_populate_recordset()`` use such forms. These classes of SQL function calling forms in SQLAlchemy are available using the :meth:`_functions.FunctionElement.table_valued` method in conjunction with :class:`_functions.Function` objects generated from the :data:`_sql.func` namespace. Examples from PostgreSQL's reference documentation follow below: * ``json_each()``: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func >>> stmt = select( ... func.json_each('{"a":"foo", "b":"bar"}').table_valued("key", "value") ... ) >>> print(stmt) {printsql}SELECT anon_1.key, anon_1.value FROM json_each(:json_each_1) AS anon_1 * ``json_populate_record()``: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func, literal_column >>> stmt = select( ... func.json_populate_record( ... literal_column("null::myrowtype"), '{"a":1,"b":2}' ... ).table_valued("a", "b", name="x") ... ) >>> print(stmt) {printsql}SELECT x.a, x.b FROM json_populate_record(null::myrowtype, :json_populate_record_1) AS x * ``json_to_record()`` - this form uses a PostgreSQL specific form of derived columns in the alias, where we may make use of :func:`_sql.column` elements with types to produce them. The :meth:`_functions.FunctionElement.table_valued` method produces a :class:`_sql.TableValuedAlias` construct, and the method :meth:`_sql.TableValuedAlias.render_derived` method sets up the derived columns specification: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func, column, Integer, Text >>> stmt = select( ... func.json_to_record('{"a":1,"b":[1,2,3],"c":"bar"}') ... .table_valued( ... column("a", Integer), ... column("b", Text), ... column("d", Text), ... ) ... .render_derived(name="x", with_types=True) ... ) >>> print(stmt) {printsql}SELECT x.a, x.b, x.d FROM json_to_record(:json_to_record_1) AS x(a INTEGER, b TEXT, d TEXT) * ``WITH ORDINALITY`` - part of the SQL standard, ``WITH ORDINALITY`` adds an ordinal counter to the output of a function and is accepted by a limited set of PostgreSQL functions including ``unnest()`` and ``generate_series()``. The :meth:`_functions.FunctionElement.table_valued` method accepts a keyword parameter ``with_ordinality`` for this purpose, which accepts the string name that will be applied to the "ordinality" column: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func >>> stmt = select( ... func.generate_series(4, 1, -1) ... .table_valued("value", with_ordinality="ordinality") ... .render_derived() ... ) >>> print(stmt) {printsql}SELECT anon_1.value, anon_1.ordinality FROM generate_series(:generate_series_1, :generate_series_2, :generate_series_3) WITH ORDINALITY AS anon_1(value, ordinality) .. versionadded:: 1.4.0b2 .. seealso:: :ref:`tutorial_functions_table_valued` - in the :ref:`unified_tutorial` .. _postgresql_column_valued: Column Valued Functions ^^^^^^^^^^^^^^^^^^^^^^^ Similar to the table valued function, a column valued function is present in the FROM clause, but delivers itself to the columns clause as a single scalar value. PostgreSQL functions such as ``json_array_elements()``, ``unnest()`` and ``generate_series()`` may use this form. Column valued functions are available using the :meth:`_functions.FunctionElement.column_valued` method of :class:`_functions.FunctionElement`: * ``json_array_elements()``: .. sourcecode:: pycon+sql >>> from sqlalchemy import select, func >>> stmt = select( ... func.json_array_elements('["one", "two"]').column_valued("x") ... ) >>> print(stmt) {printsql}SELECT x FROM json_array_elements(:json_array_elements_1) AS x * ``unnest()`` - in order to generate a PostgreSQL ARRAY literal, the :func:`_postgresql.array` construct may be used: .. sourcecode:: pycon+sql >>> from sqlalchemy.dialects.postgresql import array >>> from sqlalchemy import select, func >>> stmt = select(func.unnest(array([1, 2])).column_valued()) >>> print(stmt) {printsql}SELECT anon_1 FROM unnest(ARRAY[%(param_1)s, %(param_2)s]) AS anon_1 The function can of course be used against an existing table-bound column that's of type :class:`_types.ARRAY`: .. sourcecode:: pycon+sql >>> from sqlalchemy import table, column, ARRAY, Integer >>> from sqlalchemy import select, func >>> t = table("t", column("value", ARRAY(Integer))) >>> stmt = select(func.unnest(t.c.value).column_valued("unnested_value")) >>> print(stmt) {printsql}SELECT unnested_value FROM unnest(t.value) AS unnested_value .. seealso:: :ref:`tutorial_functions_column_valued` - in the :ref:`unified_tutorial` Row Types ^^^^^^^^^ Built-in support for rendering a ``ROW`` may be approximated using ``func.ROW`` with the :attr:`_sa.func` namespace, or by using the :func:`_sql.tuple_` construct: .. sourcecode:: pycon+sql >>> from sqlalchemy import table, column, func, tuple_ >>> t = table("t", column("id"), column("fk")) >>> stmt = ( ... t.select() ... .where(tuple_(t.c.id, t.c.fk) > (1, 2)) ... .where(func.ROW(t.c.id, t.c.fk) < func.ROW(3, 7)) ... ) >>> print(stmt) {printsql}SELECT t.id, t.fk FROM t WHERE (t.id, t.fk) > (:param_1, :param_2) AND ROW(t.id, t.fk) < ROW(:ROW_1, :ROW_2) .. seealso:: `PostgreSQL Row Constructors `_ `PostgreSQL Row Constructor Comparison `_ Table Types passed to Functions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ PostgreSQL supports passing a table as an argument to a function, which is known as a "record" type. SQLAlchemy :class:`_sql.FromClause` objects such as :class:`_schema.Table` support this special form using the :meth:`_sql.FromClause.table_valued` method, which is comparable to the :meth:`_functions.FunctionElement.table_valued` method except that the collection of columns is already established by that of the :class:`_sql.FromClause` itself: .. sourcecode:: pycon+sql >>> from sqlalchemy import table, column, func, select >>> a = table("a", column("id"), column("x"), column("y")) >>> stmt = select(func.row_to_json(a.table_valued())) >>> print(stmt) {printsql}SELECT row_to_json(a) AS row_to_json_1 FROM a .. versionadded:: 1.4.0b2 ) annotations) defaultdict) lru_cacheN)Any)cast)List)Optional)Tuple) TYPE_CHECKING)Union)arraylib)json) pg_catalog)ranges) _regconfig_fn)aggregate_order_by)HSTORE)CreateDomainType)CreateEnumType)DOMAIN)DropDomainType) DropEnumType)ENUM) NamedType)_DECIMAL_TYPES) _FLOAT_TYPES) _INT_TYPES)BIT)BYTEA)CIDR)CITEXT)INET)INTERVAL)MACADDR)MACADDR8)MONEY)OID)PGBit)PGCidr)PGInet) PGInterval) PGMacAddr) PGMacAddr8)PGUuid)REGCLASS) REGCONFIG)TIME) TIMESTAMP)TSVECTOR)exc)schema)select)sql)util)characteristics)default) interfaces) ObjectKind) ObjectScope) reflection)URL)ReflectionDefaults) bindparam) coercions)compiler)elements) expression)roles)sqltypes)InsertmanyvaluesSentinelOpts)InternalTraversal)BIGINT)BOOLEAN)CHAR)DATE)DOUBLE_PRECISION)FLOAT)INTEGER)NUMERIC)REAL)SMALLINT)TEXT)UUID)VARCHAR) TypedDictz ^(?:btree|hash|gist|gin|[\w_]+)$>fasdoinisofonortoallandanyascendfornewnotoffoldbothcaserdescelsefromfullintojoinleftlikenullonlyoversomethentrueuserwhenwitharraycheckcrossfalsefetchgrantgroupilikeinnerlimitorderouterrighttableunionusingwherebinarycolumncreateexceptfreezehavingisnulloffsetr7uniquewindowanalyseanalyzebetweencollater;foreignleadingnaturalnotnullplacingprimarysimilarverbosedistinctoverlapstrailingvariadic initially intersect localtime returning symmetric asymmetric constraint deferrable references current_date current_role current_time current_user session_user authorizationcurrent_schemalocaltimestampcurrent_catalogcurrent_timestamp_arrayhstorerjsonb int4range int8rangenumrange daterangetsrange tstzrangeint4multirangeint8multirange nummultirangedatemultirange tsmultirangetstzmultirangeintegerbigintsmallintzcharacter varying characterz"char"nametextnumericfloatrealinetcidrcitextuuidbit bit varyingmacaddrmacaddr8moneyoidregclassdouble precision timestamptimestamp with time zonetimestamp without time zonetime with time zonetime without time zonedatetimebyteabooleanintervaltsvectorcsLeZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ dNddZ dNddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zfd2d3Zd4d5Zd6d7Zd8d9Zd:d;Zdd?Z!d@dAZ"dBdCZ#dDdEZ$dFdGZ%dHdIZ&dJdKZ'dLdMZ(Z)S)O PGCompilercK|j|fi|SN_assert_pg_ts_extselfelementkwre/var/www/html/ecg_monitoring/venv/lib/python3.10/site-packages/sqlalchemy/dialects/postgresql/base.pyvisit_to_tsvector_funcz!PGCompiler.visit_to_tsvector_funccKrrrrrrrvisit_to_tsquery_funcrz PGCompiler.visit_to_tsquery_funccKrrrrrrrvisit_plainto_tsquery_funcrz%PGCompiler.visit_plainto_tsquery_funccKrrrrrrrvisit_phraseto_tsquery_funcrz&PGCompiler.visit_phraseto_tsquery_funccKrrrrrrrvisit_websearch_to_tsquery_funcrz*PGCompiler.visit_websearch_to_tsquery_funccKrrrrrrrvisit_ts_headline_funcrz!PGCompiler.visit_ts_headline_funccKsBt|tstd|jd|jd|j|j|fi|S)NzCan't compile "z()" full text search function construct that does not originate from the "sqlalchemy.dialects.postgresql" package. Please ensure "import sqlalchemy.dialects.postgresql" is called before constructing "sqlalchemy.func.zD()" to ensure registration of the correct argument and return types.) isinstancerr5 CompileErrorrfunction_argspecrrrrrs   zPGCompiler._assert_pg_ts_extcCs6|jtjur |jr tj}|d|jjj||jdS)Nz::)identifier_preparer) _type_affinityrHStringlength STRINGTYPEdialecttype_compiler_instanceprocesspreparer)rtype_ dbapi_typesqltextrrrrender_bind_castszPGCompiler.render_bind_castcKsd|j|fi|S)Nz ARRAY[%s])visit_clauselistrrrr visit_arrayszPGCompiler.visit_arraycK,d|j|jfi||j|jfi|fS)Nz%s:%s)rstartstoprrrr visit_slicezPGCompiler.visit_slicecKs|j|dfi|S)Nz # )_generate_generic_binaryrroperatorrrrrvisit_bitwise_xor_op_binaryz&PGCompiler.visit_bitwise_xor_op_binaryFcKZ|s|jjtjurd|d<|jt||jfi|Sd|d<|j||s&dndfi|S)NT _cast_appliedeager_groupingz -> z ->> typerrHJSONrr8rrrrrrrrrrvisit_json_getitem_op_binary s z'PGCompiler.visit_json_getitem_op_binarycKr)NTrrz #> z #>> rrrrr!visit_json_path_getitem_op_binarys z,PGCompiler.visit_json_path_getitem_op_binarycKs,d|j|jfi||j|jfi|fS)Nz%s[%s])rrsrrrrrvisit_getitem_binary)rzPGCompiler.visit_getitem_binarycKr)Nz%s ORDER BY %s)rtargetorder_byrrrrvisit_aggregate_order_by/rz#PGCompiler.visit_aggregate_order_bycKs|d|jvr(||jdtj}|r(d|j|jfi|||j|jfi|fSd|j|jfi||j|jfi|fS)Npostgresql_regconfigz%s @@ plainto_tsquery(%s, %s)z%s @@ plainto_tsquery(%s)) modifiersrender_literal_valuerHrrrsr)rrrr regconfigrrrvisit_match_op_binary5s  z PGCompiler.visit_match_op_binarycKs|jj|fi|Sr)r_compiler_dispatchrrrr$visit_ilike_case_insensitive_operandErz/PGCompiler.visit_ilike_case_insensitive_operandcKZ|jdd}d|j|jfi||j|jfi|f|dur*d||tjSdS)Nescapez %s ILIKE %s ESCAPE r'getrrsrr(rHrrrrrr.rrrvisit_ilike_op_binaryHsz PGCompiler.visit_ilike_op_binarycKr-)Nr.z%s NOT ILIKE %sr/r0r1r3rrrvisit_not_ilike_op_binaryTsz$PGCompiler.visit_not_ilike_op_binarycCs|jd}|dur|j|d|fi|S|dkr%|j|d|fi|Sd|j|jfi||||tj|j|jfi|fS)Nflagsz %s iz %s* z%s %s CONCAT('(?', %s, ')', %s))r'rrrsr(rHrr)rbase_oprrrr6rrr _regexp_match_s&  zPGCompiler._regexp_matchcK|d|||S)N~r9rrrrvisit_regexp_match_op_binarypz'PGCompiler.visit_regexp_match_op_binarycKr:)Nz!~r<rrrr visit_not_regexp_match_op_binarysr>z+PGCompiler.visit_not_regexp_match_op_binarycKs^|j|jfi|}|j|jfi|}|jd}|dur#d||fSd||||tjfS)Nr6zREGEXP_REPLACE(%s, %s)zREGEXP_REPLACE(%s, %s, %s))rrsrr'r(rHr)rrrrstringpattern_replacer6rrrvisit_regexp_replace_op_binaryvs  z)PGCompiler.visit_regexp_replace_op_binaryc s&ddfdd|p tgDfS)NzSELECT %s WHERE 1!=1, c3s.|]}djj|jrtn|VqdS)zCAST(NULL AS %s)N)rrr_isnullrQ).0r rrr s z2PGCompiler.visit_empty_set_expr..)rrrQ)r element_typesrrrFrvisit_empty_set_exprs  zPGCompiler.visit_empty_set_exprcs&t||}|jjr|dd}|S)N\z\\)superr(r_backslash_escapesreplace)rvaluer  __class__rrr(s zPGCompiler.render_literal_valuecKsd||S)Nz string_agg%s)r)rfnrrrrvisit_aggregate_strings_funcz'PGCompiler.visit_aggregate_strings_funccKsd|j|S)Nz nextval('%s'))rformat_sequence)rseqrrrrvisit_sequencer>zPGCompiler.visit_sequencecKsfd}|jdur|d|j|jfi|7}|jdur1|jdur#|d7}|d|j|jfi|7}|S)Nr0z LIMIT z LIMIT ALLz OFFSET ) _limit_clauser_offset_clauserr7rrrrr limit_clauses   zPGCompiler.limit_clausecCs"|dkr td|d|S)NONLYzUnrecognized hint: %rzONLY )upperr5r)rr rhintiscrudrrrformat_from_hint_texts z PGCompiler.format_from_hint_textc s>|js|jr|jrddfdd|jDdSdSdS)Nz DISTINCT ON (rCcsg|] }j|fiqSrrrEcolrrrr sz4PGCompiler.get_select_precolumns..z) z DISTINCT r0) _distinct _distinct_onrr)rr7rrrcrget_select_precolumnss   z PGCompiler.get_select_precolumnsc s|jjr|jjr d}n d}n |jjrd}nd}|jjr?t}|jjD] }|t|q#|dd fdd|D7}|jj rG|d 7}|jj rO|d 7}|S) Nz FOR KEY SHAREz FOR SHAREz FOR NO KEY UPDATEz FOR UPDATEz OF rCc3s(|]}j|fdddVqdS)TF)ashint use_schemaNr`)rErrcrrrGs  z/PGCompiler.for_update_clause..z NOWAITz SKIP LOCKED) _for_update_argread key_sharer]r9 OrderedSetupdatesql_utilsurface_selectables_onlyrrnowait skip_locked)rr7rtmptablescrrcrfor_update_clauses&  zPGCompiler.for_update_clausecKsx|j|jjdfi|}|j|jjdfi|}t|jjdkr6|j|jjdfi|}d|||fSd||fS)Nrr zSUBSTRING(%s FROM %s FOR %s)zSUBSTRING(%s FROM %s))rclauseslen)rfuncrsrrrrrvisit_substring_funcs  zPGCompiler.visit_substring_funcc sx|jdurdj|j}|S|jdur8ddfdd|jD}|jdur6|dj|jddd7}|Sd }|S) NzON CONSTRAINT %s(%s)rCc3s6|]}t|trj|nj|dddVqdS)F include_tableriN)rstrrquoterrErurFrrrGs z1PGCompiler._on_conflict_target.. WHERE %sFr~r0)constraint_targetr#truncate_and_render_constraint_nameinferred_target_elementsrrinferred_target_whereclauser)rclauser target_textrrFr_on_conflict_targets*    zPGCompiler._on_conflict_targetcKs"|j|fi|}|rd|SdS)NzON CONFLICT %s DO NOTHINGzON CONFLICT DO NOTHING)r)r on_conflictrrrrrvisit_on_conflict_do_nothing sz'PGCompiler.visit_on_conflict_do_nothingcKs|}|j|fi|}g}t|j}|jdd}|jj}|D]T} | j} | |vr.|| } n | |vr8|| } nqt | rHt j d| | j d} nt | t j rZ| j jrZ| } | j | _ |j| dd} |j| j} |d| | fq|rtd|jjjdd d |Df|D]+\}}t |tr|j|n|j|dd} |jttj|dd} |d| | fqd|}|jdur|d |j|jd dd 7}d||fS)N selectable)r F)ri%s = %szFAdditional column names not matching any column keys in table '%s': %srCcss|]}d|VqdS)z'%s'NrrrrrrG@sz9PGCompiler.visit_on_conflict_do_update..rTr~zON CONFLICT %s DO UPDATE SET %s) rdictupdate_values_to_setstackrrukeypoprC _is_literalrE BindParameterrrrD_cloner self_grouprrrappendr9warncurrent_executablerritemsrexpectrGExpressionElementRoleupdate_whereclause)rrrrraction_set_opsset_parametersinsert_statementcolsrucol_keyrN value_textkey_textkv action_textrrrvisit_on_conflict_do_updates`          z&PGCompiler.visit_on_conflict_do_updatec (dd<ddfdd|DS)NTasfromzFROM rCc3&|]}|jfdiVqdS fromhintsNr+rEt from_hintsrrrrrG[  z0PGCompiler.update_from_clause..rr)r update_stmt from_table extra_fromsrrrrrupdate_from_clauseWs zPGCompiler.update_from_clausec r)z9Render the DELETE .. USING clause specific to PostgreSQL.TrzUSING rCc3rrrrrrrrGerz6PGCompiler.delete_extra_from_clause..r)r delete_stmtrrrrrrrdelete_extra_from_clause`s z#PGCompiler.delete_extra_from_clausecKsvd}|jdur|d|j|jfi|7}|jdur9|d|j|jfi||jdr,dnd|jdr4dndf7}|S) Nr0z OFFSET (%s) ROWSz FETCH FIRST (%s)%s ROWS %spercentz PERCENT with_tiesz WITH TIESr[)rXr _fetch_clause_fetch_clause_optionsrYrrr fetch_clausejs    zPGCompiler.fetch_clauseF)*__name__ __module__ __qualname__rrrrrrrr rrrr r!r"r%r*r,r4r5r9r=r?rBrIr(rRrVrZr_rgrvr|rrrrrr __classcell__rrrOrrsR        !E  rcseZdZddZddZfddZfddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZfddZdd Zd!d"Zd#d$ZZS)% PGDDLCompilercKs^|j|}|j|j}t|tjr|j}|j duo|jj }|j r_||j j ur_|jjs2t|tjs_|s_|jdusDt|jtjr_|jjr_t|tjrO|d7}n/t|tjrZ|d7}n$|d7}n|d|jjj|j||jd7}||}|dur~|d|7}|jdur|d||j7}|r|d||j 7}|js|s|d7}|S|jr|r|d7}|S) Nz BIGSERIALz SMALLSERIALz SERIAL )type_expressionrz DEFAULT z NOT NULLz NULL)r format_columnr dialect_implrrrH TypeDecoratorimplidentitysupports_identity_columns primary_keyr_autoincrement_columnsupports_smallserial SmallIntegerr;r6Sequenceoptional BigIntegerrrget_column_default_stringcomputednullable)rrkwargscolspec impl_type has_identityr;rrrget_column_specificationsX                  z&PGDDLCompiler.get_column_specificationcCs|jdd}|r dSdS)N postgresql not_valid NOT VALIDr0dialect_options)rrrrrr_define_constraint_validitys z)PGDDLCompiler._define_constraint_validityc s`|jr!t|jdj}t|tjr!t|jtjr!|jj s!t dt |}|||7}|S)NrzPostgreSQL dialect cannot produce the CHECK constraint for ARRAY of non-native ENUM; please specify create_constraint=False on this Enum datatype.) _type_boundlistcolumnsrrrHARRAY item_typeEnum native_enumr5rrKvisit_check_constraintr)rrrtyprrOrrrs   z$PGDDLCompiler.visit_check_constraintc st|}|||7}|Sr)rKvisit_foreign_key_constraintr)rrrrrOrrrs z*PGDDLCompiler.visit_foreign_key_constraintc s0|j}dj|dfdd|jDfS)NzCREATE TYPE %s AS ENUM (%s)rCc3s&|]}jjt|ddVqdS)T literal_bindsN) sql_compilerrr8literal)rEerFrrrGrz7PGDDLCompiler.visit_create_enum_type..)rr format_typerrenums)rrrr rrFrvisit_create_enum_types z$PGDDLCompiler.visit_create_enum_typecKs|j}d|j|S)Nz DROP TYPE %srrr)rdroprr rrrvisit_drop_enum_typesz"PGDDLCompiler.visit_drop_enum_typecKs|j}g}|jdur|d|j|j|jdur*||j}|d||jdur>|j|j}|d||j rF|d|j dur^|j j |j ddd}|d|d d |j |d |j |jd d |S) NzCOLLATE zDEFAULT z CONSTRAINT zNOT NULLFTrrzCHECK ()zCREATE DOMAIN z AS r)r collationrrrr;render_default_stringconstraint_namernot_nullrrrr type_compiler data_typerr)rrrdomainoptionsr;rrrrrvisit_create_domain_types2       z&PGDDLCompiler.visit_create_domain_typecKs|j}d|j|S)Nz DROP DOMAIN r)rrrrrrrvisit_drop_domain_typesz$PGDDLCompiler.visit_drop_domain_typec  sj|jd}jr|d7}|d7}jjr)jdd}|r)|d7}|jr0|d7}|djd d  j f7}jdd }|rW|d j |t  7}jdd |ddfddjD7}jdd}|rfdd|D}|ddfdd|D7}jdd}|dur|d7}n|d ur|d7}jdd} | r|dddd| D7}jdd} | r|d| 7}jdd} | durttj| } jj| d dd } |d!| 7}|S)"NzCREATE zUNIQUE zINDEX r concurrently CONCURRENTLY zIF NOT EXISTS z %s ON %s Finclude_schemarz USING %s opsr}rCcsXg|](}jjt|tjs|n|dddt|dr'|jvr'd|jndqS)FTrrrr0)rrrrF ColumnClauserhasattrr)rEexpr)r rrrrd# s     z4PGDDLCompiler.visit_create_index..includecs&g|]}t|trjj|n|qSr)rrrrura)indexrrrd9 z INCLUDE (%s)csg|]}|jqSr)rrrrrrrd> snulls_not_distinctTz NULLS NOT DISTINCTz NULLS DISTINCTr}z WITH (%s)cSsg|]}d|qS)rr)rEstorage_parameterrrrrdM s tablespacez TABLESPACE %srrz WHERE )rr_verify_index_tablerr#_supports_create_index_concurrentlyr if_not_exists_prepared_index_name format_tablervalidate_sql_phrase IDX_USINGlowerrr expressionsrrrCrrGDDLExpressionRolerr) rrrrrr includeclause inclusionsr withclausetablespace_name whereclausewhere_compiledr)rr rrrvisit_create_index s        z PGDDLCompiler.visit_create_indexcKs6|jdd}|durd}|S|durd}|Sd}|S)NrrTzNULLS NOT DISTINCT FzNULLS DISTINCT r0r)rrrrnulls_not_distinct_paramrrr!define_unique_constraint_distincte sz/PGDDLCompiler.define_unique_constraint_distinctcKsP|j}d}|jjr|jdd}|r|d7}|jr|d7}||j|dd7}|S)Nz DROP INDEX rrrz IF EXISTS Tr)rr!_supports_drop_index_concurrentlyr if_existsr)rrrrrrrrrvisit_drop_indexq szPGDDLCompiler.visit_drop_indexc Ksd}|jdur|d|j|7}g}d|d<d|d<|jD]-\}}}|jj|fi|t|dr?|j|jvr?d|j|jnd}| d ||fq|d |j |j t  d |f7}|jdurq|d |jj|jdd 7}|||7}|S)Nr0zCONSTRAINT %s FrTrrrz %s WITH %szEXCLUDE USING %s (%s)rCz WHERE (%s)r)rrformat_constraint _render_exprsrrr rr rrrrrrrrdefine_constraint_deferrability) rrrrrEr ropexclude_elementrrrvisit_exclude_constraint s<      z&PGDDLCompiler.visit_exclude_constraintcsg}|jd}|d}|dur-t|ttfs|f}|ddfdd|Dd|dr:|d |d|d rG|d |d |d d urS|dn |d dur^|d|drs|ddd}|d||dr|d}|dj |d|S)Nrinheritsz INHERITS ( rCc3s|] }j|VqdSr)rr)rErrFrrrG sz2PGDDLCompiler.post_create_table..z ) partition_byz PARTITION BY %srz USING %s with_oidsTz WITH OIDSFz WITHOUT OIDS on_commit_rz ON COMMIT %srz TABLESPACE %sr0) rr2rrtuplerrrrMr\rr)rr table_optspg_optsr1on_commit_optionsr"rrFrpost_create_table s<       zPGDDLCompiler.post_create_tablecKs,|jdur tdd|jj|jdddS)NFzPostrgreSQL computed columns do not support 'virtual' persistence; set the 'persisted' flag to None or True for PostgreSQL support.zGENERATED ALWAYS AS (%s) STOREDTr) persistedr5rrrr )r generatedrrrrvisit_computed_column s z#PGDDLCompiler.visit_computed_columnc s<d}|jjdurd|j|jj}tj|fd|i|S)Nz AS %sprefix)rrrrrKvisit_create_sequence)rrrr>rOrrr? s  z#PGDDLCompiler.visit_create_sequencecCsB|j}|jdurtd|d|jdurtd|ddS)Nz%Can't emit COMMENT ON for constraint z: it has no namez: it has no associated table)rrr5rr)r ddl_instancerrrr_can_comment_on_constraint s    z(PGDDLCompiler._can_comment_on_constraintcKs@||d|j|j|j|jj|j|jjt fS)Nz$COMMENT ON CONSTRAINT %s ON %s IS %s) rArr+rrrrr(commentrHr)rrrrrrvisit_set_constraint_comment s   z*PGDDLCompiler.visit_set_constraint_commentcKs,||d|j|j|j|jjfS)Nz&COMMENT ON CONSTRAINT %s ON %s IS NULL)rArr+rrr)rrrrrrvisit_drop_constraint_comment s  z+PGDDLCompiler.visit_drop_constraint_comment)rrrrrrrrrrrr%r'r*r0r:r=r?rArCrDrrrrOrrs&6   c %    rcseZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zd9d:Zd;d<Z d=d>Z!d?d@Z"fdAdBZ#d^dDdEZ$d^dFdGZ%dHdIZ&dJdKZ'dLdMZ(dNdOZ)fdPdQZ*dRdSZ+dTdUZ,dVdWZ-dXdYZ.dZd[Z/d\d]Z0Z1S)_PGTypeCompilercKdS)Nr3rrr rrrrvisit_TSVECTOR zPGTypeCompiler.visit_TSVECTORcKrF)NTSQUERYrrGrrr visit_TSQUERY rIzPGTypeCompiler.visit_TSQUERYcKrF)Nr"rrGrrr visit_INET rIzPGTypeCompiler.visit_INETcKrF)Nr rrGrrr visit_CIDR rIzPGTypeCompiler.visit_CIDRcKrF)Nr!rrGrrr visit_CITEXT rIzPGTypeCompiler.visit_CITEXTcKrF)Nr$rrGrrr visit_MACADDR rIzPGTypeCompiler.visit_MACADDRcKrF)Nr%rrGrrrvisit_MACADDR8 rIzPGTypeCompiler.visit_MACADDR8cKrF)Nr&rrGrrr visit_MONEY rIzPGTypeCompiler.visit_MONEYcKrF)Nr'rrGrrr visit_OID rIzPGTypeCompiler.visit_OIDcKrF)Nr0rrGrrrvisit_REGCONFIG rIzPGTypeCompiler.visit_REGCONFIGcKrF)Nr/rrGrrrvisit_REGCLASS rIzPGTypeCompiler.visit_REGCLASScKs|jsdSdd|jiS)NrPzFLOAT(%(precision)s) precision)rUrGrrr visit_FLOAT szPGTypeCompiler.visit_FLOATcKs|jtfi|Sr)visit_DOUBLE_PRECISIONrrGrrr visit_double rzPGTypeCompiler.visit_doublecKrF)NrKrrGrrr visit_BIGINT# rIzPGTypeCompiler.visit_BIGINTcKrF)NrrrGrrr visit_HSTORE& rIzPGTypeCompiler.visit_HSTOREcKrF)NrrrGrrr visit_JSON) rIzPGTypeCompiler.visit_JSONcKrF)NJSONBrrGrrr visit_JSONB, rIzPGTypeCompiler.visit_JSONBcKrF)NINT4MULTIRANGErrGrrrvisit_INT4MULTIRANGE/ rIz#PGTypeCompiler.visit_INT4MULTIRANGEcKrF)NINT8MULTIRANGErrGrrrvisit_INT8MULTIRANGE2 rIz#PGTypeCompiler.visit_INT8MULTIRANGEcKrF)N NUMMULTIRANGErrGrrrvisit_NUMMULTIRANGE5 rIz"PGTypeCompiler.visit_NUMMULTIRANGEcKrF)NDATEMULTIRANGErrGrrrvisit_DATEMULTIRANGE8 rIz#PGTypeCompiler.visit_DATEMULTIRANGEcKrF)N TSMULTIRANGErrGrrrvisit_TSMULTIRANGE; rIz!PGTypeCompiler.visit_TSMULTIRANGEcKrF)NTSTZMULTIRANGErrGrrrvisit_TSTZMULTIRANGE> rIz#PGTypeCompiler.visit_TSTZMULTIRANGEcKrF)N INT4RANGErrGrrrvisit_INT4RANGEA rIzPGTypeCompiler.visit_INT4RANGEcKrF)N INT8RANGErrGrrrvisit_INT8RANGED rIzPGTypeCompiler.visit_INT8RANGEcKrF)NNUMRANGErrGrrrvisit_NUMRANGEG rIzPGTypeCompiler.visit_NUMRANGEcKrF)N DATERANGErrGrrrvisit_DATERANGEJ rIzPGTypeCompiler.visit_DATERANGEcKrF)NTSRANGErrGrrr visit_TSRANGEM rIzPGTypeCompiler.visit_TSRANGEcKrF)N TSTZRANGErrGrrrvisit_TSTZRANGEP rIzPGTypeCompiler.visit_TSTZRANGEcKrF)NINTrrGrrrvisit_json_int_indexS rIz#PGTypeCompiler.visit_json_int_indexcKrF)NrUrrGrrrvisit_json_str_indexV rIz#PGTypeCompiler.visit_json_str_indexcKrr)visit_TIMESTAMPrGrrrvisit_datetimeY rzPGTypeCompiler.visit_datetimec s4|jr|jjstj|fi|S|j|fi|Sr)rrsupports_native_enumrK visit_enum visit_ENUMrGrOrrr|\ szPGTypeCompiler.visit_enumNcK|dur|jj}||Srrrrrr rrrrrr}b  zPGTypeCompiler.visit_ENUMcKr~rrrrrr visit_DOMAINg rzPGTypeCompiler.visit_DOMAINcK4dt|dddurd|jnd|jrdpddfS)NzTIMESTAMP%s %srU(%d)r0WITHWITHOUT TIME ZONEgetattrrUtimezonerGrrrryl  zPGTypeCompiler.visit_TIMESTAMPcKr)Nz TIME%s %srUrr0rrrrrGrrr visit_TIMEv rzPGTypeCompiler.visit_TIMEcKs8d}|jdur|d|j7}|jdur|d|j7}|S)Nr#rz (%d))fieldsrU)rr rrrrrvisit_INTERVAL s   zPGTypeCompiler.visit_INTERVALcKs4|jrd}|jdur|d|j7}|Sd|j}|S)Nz BIT VARYINGrzBIT(%d))varyingr)rr rcompiledrrr visit_BIT s  zPGTypeCompiler.visit_BITc s,|jr |j|fi|Stj|fi|Sr) native_uuid visit_UUIDrK visit_uuidrGrOrrr szPGTypeCompiler.visit_uuidcKrF)NrVrrGrrrr rIzPGTypeCompiler.visit_UUIDcKrr) visit_BYTEArGrrrvisit_large_binary rz!PGTypeCompiler.visit_large_binarycKrF)NrrrGrrrr rIzPGTypeCompiler.visit_BYTEAcKs>|j|jfi|}tjddd|jdur|jnd|ddS)Nz((?: COLLATE.*)?)$z%s\1z[]r )count)rrresub dimensions)rr rrrrr visit_ARRAY szPGTypeCompiler.visit_ARRAYcKrr)visit_JSONPATHrGrrrvisit_json_path rzPGTypeCompiler.visit_json_pathcKrF)NJSONPATHrrGrrrr rIzPGTypeCompiler.visit_JSONPATHr)2rrrrHrKrLrMrNrOrPrQrRrSrTrVrXrYrZr[r]r_rarcrergrirkrmrorqrsrurwrxrzr|r}rryrrrrrrrrrrrrrrOrrE s^      rEc@s"eZdZeZddZdddZdS)PGIdentifierPreparercCs*|d|jkr|dd|j|j}|S)Nrr r) initial_quoterMescape_to_quote escape_quote)rrNrrr_unquote_identifier s  z(PGIdentifierPreparer._unquote_identifierTcCs\|jstd|jjd||j}||}|js,|r,|dur,||d|}|S)Nz PostgreSQL z type requires a name..) rr5rrPrrschema_for_object omit_schema quote_schema)rr rireffective_schemarrrr s  z PGIdentifierPreparer.format_typeN)T)rrrRESERVED_WORDSreserved_wordsrrrrrrr src@s.eZdZUdZded< ded< ded<dS)ReflectedNamedTypez"Represents a reflected named type.rrr6boolvisibleNrrr__doc____annotations__rrrrr s rc@s$eZdZUdZded< ded<dS)ReflectedDomainConstraintz2Represents a reflect check constraint of a domain.rrrNrrrrrr s rc@sBeZdZUdZded< ded< ded< ded < ded <d S) ReflectedDomainRepresents a reflected enum.rrrr Optional[str]r;zList[ReflectedDomainConstraint] constraintsrNrrrrrr s rc@seZdZUdZded<dS) ReflectedEnumr List[str]labelsNrrrrrr s rc@sZeZdZUded< ddd d Z ddd dZddddZ ddddZ dd ddZdS)! PGInspector PGDialectrN table_namerr6rreturnintcCsB|}|jj||||jdWdS1swYdS)aQReturn the OID for the given table name. :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`.  info_cacheN)_operation_contextr get_table_oidr)rrr6connrrrr  $zPGInspector.get_table_oidList[ReflectedDomain]cC@|}|jj|||jdWdS1swYdS)aReturn a list of DOMAIN objects. Each member is a dictionary containing these fields: * name - name of the domain * schema - the schema name for the domain. * visible - boolean, whether or not this domain is visible in the default search path. * type - the type defined by this domain. * nullable - Indicates if this domain can be ``NULL``. * default - The default value of the domain or ``None`` if the domain has no default. * constraints - A list of dict wit the constraint defined by this domain. Each element constaints two keys: ``name`` of the constraint and ``check`` with the constraint text. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to indicate load domains for all schemas. .. versionadded:: 2.0 rN)rr _load_domainsrrr6rrrr get_domains s $zPGInspector.get_domainsList[ReflectedEnum]cCr)a.Return a list of ENUM objects. Each member is a dictionary containing these fields: * name - name of the enum * schema - the schema name for the enum. * visible - boolean, whether or not this enum is visible in the default search path. * labels - a list of string labels that apply to the enum. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to indicate load enums for all schemas. rN)rr _load_enumsrrrrr get_enums5 s $zPGInspector.get_enumsrcCr)zReturn a list of FOREIGN TABLE names. Behavior is similar to that of :meth:`_reflection.Inspector.get_table_names`, except that the list is limited to those tables that report a ``relkind`` value of ``f``. rN)rr_get_foreign_table_namesrrrrrget_foreign_table_namesJ s $z#PGInspector.get_foreign_table_names type_namerrrcKsB|}|jj||||jdWdS1swYdS)aJReturn if the database has the specified type in the provided schema. :param type_name: the type to check. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to check in all schemas. .. versionadded:: 2.0 rN)rrhas_typer)rrr6rrrrrrZ rzPGInspector.has_typer)rrr6rrr)r6rrr)r6rrr)r6rrr)rrr6rrrrr) rrrrrrrrrrrrrr s    rcs$eZdZddZfddZZS)PGExecutionContextcCs|d|j||S)Nzselect nextval('%s'))_execute_scalarrrT)rrUr rrr fire_sequenceo s  z PGExecutionContext.fire_sequencec s&|jr||jjur|jr|jjr|d|jj|jS|jdus(|jj r|jj rz|j }Wn9t yf|jj }|j }|ddtddt|}|ddtddt|}d||f}||_ }Ynw|jdurt|j|j}nd}|durd||f}nd|f}|||jSt|S)Nz select %srz %s_%s_seqzselect nextval('"%s"."%s"')zselect nextval('"%s"'))rrrserver_default has_argumentrargrr; is_sequencer_postgresql_seq_nameAttributeErrorrmaxry connectionrrKget_insert_default)rrseq_nametabrbrrr5rOrrrx sB       z%PGExecutionContext.get_insert_default)rrrrrrrrrOrrn s rc@(eZdZdZddZddZddZdS) "PGReadOnlyConnectionCharacteristicTcC||ddSNF set_readonlyrr dbapi_connrrrreset_characteristic r>z7PGReadOnlyConnectionCharacteristic.reset_characteristiccC|||dSrrrrrrNrrrset_characteristic r>z5PGReadOnlyConnectionCharacteristic.set_characteristiccC ||Sr) get_readonlyrrrrget_characteristic  z5PGReadOnlyConnectionCharacteristic.get_characteristicNrrr transactionalrrrrrrrr  rc@r) $PGDeferrableConnectionCharacteristicTcCrrset_deferrablerrrrr r>z9PGDeferrableConnectionCharacteristic.reset_characteristiccCrrrrrrrr r>z7PGDeferrableConnectionCharacteristic.set_characteristiccCrr)get_deferrablerrrrr rz7PGDeferrableConnectionCharacteristic.get_characteristicNrrrrrr rrc seZdZdZdZdZdZdZej j Z dZ dZ dZdZdZdZdZdZdZdZejejBejBZdZdZdZdZdZdZ dZ!dZ"e#Z#e$Z$e%Z&e'Z(e)Z*e+Z,e-Z.e/Z0dZ1dZ2dZ3dZ4dZ5e6j7j8Z8e89e:e;dZ8edddddddd feZ`d?d@ZaeWjXddAdBZbeWjXdCdDZcdEdFZdeWjXddGdHZeeWjXdIdJZfeWjXddKdLZgeWjXddMdNZheWjXddOdPZieWjXddQdRZjeWjXddSdTZkeWjXddUdVZldWdXZmdYdZZndd^d_ZoeWjXdd`daZpe\dbdcZqdddeZrestdfZuestdgZvestdhZwddrdsZxdtduZye\dvdwZzeW{dxe|j}fdye|j~fd[e|jfdze|jfd{d|Ze\d}d~ZddZeWjXdddZddZeWjX  dddZe\ddZejddZ dddZeWjXdddZejddZddZeWjX dddZddZeWjXdddZe\ddZddZeWjXdddZe\ddZddZddZe\ddZeWjXdddZe\ddZeWjXdddZddZZS)rrT?Fpyformat)postgresql_readonlypostgresql_deferrableN)rrrr rr}rr)ignore_search_pathrr2r3r4r1rrr)postgresql_ignore_search_pathcKs*tjj|fi|||_||_||_dSr)r;DefaultDialect__init___native_inet_types_json_deserializer_json_serializer)rnative_inet_typesjson_serializerjson_deserializerrrrrr7 s zPGDialect.__init__cs>t||jdk|_|||jdk|_|jdk|_dS)N) rw )rK initializeserver_version_infor_set_backslash_escapesr(rrrrOrrrD s    zPGDialect.initializecCrF)N) SERIALIZABLEzREAD UNCOMMITTEDzREAD COMMITTEDzREPEATABLE READr)rrrrrget_isolation_level_valuesR sz$PGDialect.get_isolation_level_valuescCs.|}|d||d|dS)Nz;SET SESSION CHARACTERISTICS AS TRANSACTION ISOLATION LEVEL COMMIT)cursorexecuteclose)rdbapi_connectionlevelrrrrset_isolation_level\ s  zPGDialect.set_isolation_levelcCs.|}|d|d}||S)Nz show transaction isolation levelr)rrfetchonerr\)rrrvalrrrget_isolation_levele s   zPGDialect.get_isolation_levelcCtrNotImplementedErrorrrrNrrrrl zPGDialect.set_readonlycCrrrr rrrro rzPGDialect.get_readonlycCrrrrrrrrr rzPGDialect.set_deferrablecCrrrr rrrru rzPGDialect.get_deferrableurlr@rUUnion[Tuple[None, None], Tuple[Tuple[Optional[str], ...], Tuple[Optional[int], ...]]]c Cs d}d}d}d|jvrzt|jdttfr&d}tdd|jdD\}}nTt|jdtrzt|jdd}d|jvrzt|dkrzd |d vrzt d |d }|rzd}| dd \}}t rmt|tsfJt|tsmJ|f}t d |rw|fnd}d|jvr|rt dt|jdttfr|jd}nt|jdtrt|jdd}d}|rz tdd|D}Wntyt d|dw|r|st|dks|r|rt|t|krt|dkst|dkrt d|dur|durtdd|D}||fS)NFhostTcSs&g|]}d|vr |dn|dfqS):Nsplit)rEtokenrrrrd rz7PGDialect._split_multihost_from_url..,portr rrz ^([a-zA-Z0-9\-\.]*)(?:\:(\d*))?$rwzTuple[Optional[str], ...]rzzCan't mix 'multihost' formats together; use "host=h1,h2,h3&port=p1,p2,p3" or "host=h1:p1&host=h2:p2&host=h3:p3" separatelycss |] }|r t|ndVqdSrrrExrrrrG sz6PGDialect._split_multihost_from_url..z%Received non-integer port arguments: z%number of hosts and ports don't matchcss|]}dVqdSrr)rEr5rrrrG s)queryrrr6ziprr!ryrmatchrr rr5 ArgumentError ValueError) rrhosts ports_strintegrated_multihosthost_port_matchhpportsrrr_split_multihost_from_urlx s            z#PGDialect._split_multihost_from_urlcCs||jdSr)do_beginrrrxidrrrdo_begin_twophase r>zPGDialect.do_begin_twophasecCs|d|dS)NzPREPARE TRANSACTION '%s')exec_driver_sqlr6rrrdo_prepare_twophase rzPGDialect.do_prepare_twophasecCsJ|r|r |d|d||d||jdS||jdS)NROLLBACKzROLLBACK PREPARED '%s'BEGIN)r9 do_rollbackrrrr7 is_preparedrecoverrrrdo_rollback_twophase s  zPGDialect.do_rollback_twophasecCsJ|r|r |d|d||d||jdS||jdS)Nr;zCOMMIT PREPARED '%s'r<)r9r=r do_commitr>rrrdo_commit_twophase s  zPGDialect.do_commit_twophasecCs|tdS)Nz!SELECT gid FROM pg_prepared_xacts)scalarsr8rrar rrrdo_recover_twophase s zPGDialect.do_recover_twophasecCs|dS)Nzselect current_schema())r9scalarr rrr_get_default_schema_name rSz"PGDialect._get_default_schema_namecKs,ttjjjtjjj|k}t||Sr)r7r pg_namespacerunspnamerrrF)rrr6rr(rrr has_schema s zPGDialect.has_schemacCs|durtj}|tjtjjj|jjk}|tjur$| |jj dk}n|tj ur2| |jj dk}|durH| t |jjtjjj dk}|S| tjjj |k}|S)Nrr)rpg_classrrrHrur relnamespacer>DEFAULTrrelpersistence TEMPORARYpg_table_is_visiblerI)rr(r6scopepg_class_tablerrr_pg_class_filter_scope_schema s$    z'PGDialect._pg_class_filter_scope_schemacCs&|durtj}|jjtt|kSr)rrKrurelkindr8any_rr~)rrelkindsrRrrr_pg_class_relkind_condition sz%PGDialect._pg_class_relkind_conditioncCs>ttjjjtjjjtdk|tj}|j ||t j dS)NrrQ) r7rrKrurelnamerrBrWRELKINDS_ALL_TABLE_LIKErSr>ANY)rr6r(rrr_has_table_query szPGDialect._has_table_querycKs(||||}t||d|iS)Nr)_ensure_has_table_connectionr\rrF)rrrr6rr(rrr has_table) s  zPGDialect.has_tablecKsJttjjjtjjjdktjjj|k}|j||tj d}t | |S)NSrX) r7rrKrurYrrTrSr>r[rrF)rr sequence_namer6rr(rrr has_sequence/ s  zPGDialect.has_sequencecKsttjjjtjtjjjtjjjk tjjj|k}|dur2| t tjjjtjjj dk}n|dkr@| tjjj |k}t | |SNr*)r7rpg_typerutypnamerrrHr typnamespacerpg_type_is_visiblerIrrF)rrrr6rr(rrrr: s"   zPGDialect.has_typecCsF|d}td|}|std|tdd|dddDS) Nzselect pg_catalog.version()zQ.*(?:PostgreSQL|EnterpriseDB) (\d+)\.?(\d+)?(?:\.(\d+))?(?:\.\d+)?(?:devel|beta)?z,Could not determine version from string '%s'cSsg|] }|durt|qSrr%r&rrrrd[ sz6PGDialect._get_server_version_info..r rwr4)r9rFrr*AssertionErrorr6r)rrrmrrr_get_server_version_infoP sz"PGDialect._get_server_version_infocKsnttjjjtjjj|k|tj}|j ||t j d}| |}|dur5t |r2|d|||S)z$Fetch the oid for schema.table_name.rXNr)r7rrKrurrrYrWrZrSr>r[rFr5NoSuchTableError)rrrr6rr( table_oidrrrr] s"  zPGDialect.get_table_oidcKs:ttjjjtjjjdtjjj}|| S)Nzpg_%) r7rrHrurIrnot_liker$rDra)rrrr(rrrget_schema_namesp s  zPGDialect.get_schema_namescCs8ttjjj||}|j|||d}|| SNrX) r7rrKrurYrrWrSrDra)rrr6rVrQr(rrr_get_relnames_for_relkindsy s z$PGDialect._get_relnames_for_relkindscK|j||tjtjdSro)rprRELKINDS_TABLE_NO_FOREIGNr>rMrrr6rrrrget_table_names zPGDialect.get_table_namescKs|j|dtjtjdS)N)r6rVrQ)rprrrr>rO)rrrrrrget_temp_table_names ruzPGDialect.get_temp_table_namescK|j||dtjdS)N)frVrQrpr>r[rsrrrr  z"PGDialect._get_foreign_table_namescKrqro)rpr RELKINDS_VIEWr>rMrsrrrget_view_names ruzPGDialect.get_view_namescKrqro)rprRELKINDS_MAT_VIEWr>rMrsrrrget_materialized_view_names ruz%PGDialect.get_materialized_view_namescKrqro)rprr|r>rOrsrrrget_temp_view_names s zPGDialect.get_temp_view_namescKrw)N)r_ryrzrsrrrget_sequence_names r{zPGDialect.get_sequence_namescKstttjjjtjtjjj|k| tj tj }|j ||t jd}||}|dur?t|r<|d|||S)NrXr)r7rpg_get_viewdefrKrur select_fromrrYrWr|r~rSr>r[rFr5rk)rr view_namer6rr(resrrrget_view_definition s(    zPGDialect.get_view_definitioncCsDz t|||fWSty!t|r|d|d|dw)Nr)rKeyErrorr5rk)rdatarr6rrr_value_or_raise s zPGDialect._value_or_raisecCs|rdd|ifSdifS)NT filter_namesFr)rrrrr_prepare_filter_names s zPGDialect._prepare_filter_nameskindr=Tuple[str, ...]cCsT|tjurtjSd}tj|vr|tj7}tj|vr|tj7}tj|vr(|tj 7}|S)Nr) r=r[rrZTABLERELKINDS_TABLEVIEWr|MATERIALIZED_VIEWr~)rrrVrrr_kind_to_relkinds s       zPGDialect._kind_to_relkindscK0|j|f||gtjtjd|}||||SN)r6rrQr)get_multi_columnsr>r[r=rrrrr6rrrrr get_columns zPGDialect.get_columnsc Cs|jdkr tjjjdntd}|jdkr{ttj dtjjj dkdtj jj dtj jjdtj jjd tj jjd tj jjd tj jjtj tjjj d ktj jjttttttjjjtttjjjttktjd }ntd }tttj jj!tj jj"tj tj jj"tjjjktj jj#tjjj$ktjjj%tjd}|&|}ttjjjdt'tjjj(tjjj)d|tjjj*dtj+jj,dtj-jj.d||tj+/tjt0tj+jj1tjjjktjjj$dktjjj2/tj-t0tj-jj3tjjjktj-jj4tjjj$k|5|6tj+jj,tjjj$} |j7| ||d} |rJ| tj+jj,8t9d} | S)N) r<ralwaysar incrementminvaluemaxvaluecachecycler0identity_optionsr;rrrrrBrrXr):rr pg_attributeru attgeneratedlabelr8rur7rzjson_build_object attidentity pg_sequenceseqstart seqincrementseqminseqmaxseqcacheseqcyclerrseqrelidrpg_get_serial_sequenceattrelidr/rUattnamer' correlatescalar_subquery pg_get_expr pg_attrdefadbinadrelidadnumattnum atthasdefrratttypid atttypmod attnotnullrKrYpg_description description outerjoinand_r attisdroppedobjoidobjsubidrWr$rSin_rB) rr6has_filter_namesrQrr<rr;rVr(rrr_columns_query s       /      )zPGDialect._columns_querycKs||\}}|||||} || |} dd|j|d|ddD} tdd|j|d|ddD} || | | |} | S)NcSs0i|]}|ds|d|dfn|df|qS)rr6rr)rEdrrr s"z/PGDialect.get_multi_columns..rcr)r6rcss:|]}|dr|df|fn |d|df|fVqdS)rrr6Nr)rErecrrrrGs z.PGDialect.get_multi_columns..) rrrmappingsrr2rr_get_columns_infor)rrr6rrQrrrparamsr(rowsdomainsrrrrrrys    zPGDialect.get_multi_columnsz\((.*)\)\s*,\s*z ((?:\[\])*)$rrrdict[str, ReflectedDomain]rdict[str, ReflectedEnum]type_descriptionrsqltypes.TypeEngine[Any]c Csn|pd}|durtd|tjS|j|}|r)|dr)|j|d}nd}|j |}t |dp8dd}|j d|} |j d| } |j | d} di} } | dkrot |dkrmtt|\} }| |f} n&| d krwd } n| d krd} n| d vrd | d<t |dkrt|d| d<n| dvrd| d<t |dkrt|d| d<n| dkrd | d<t |dkrt|d}|f} n| drt} td| }|r|d| d<t |dkrt|d| d<ntt| }||vrt} ||}t|d} |d| d<|ds|d| d<t|d} n{||vrtt} ||}|j|d||d|dd}|d|f} |d| d<|d | d <|d! | d"<d| d#<|d$rh|d$d}|d| d%<|d&| d&<|dss|d| d<n!zt|d}|g|ddR} Wnttfy|} Ynw| std'| |ftjS| | i| }|dkrt|}|S)(aB Attempts to reconstruct a column type defined in ischema_names based on the information available in the format_type. If the `format_type` cannot be associated with a known `ischema_names`, it is treated as a reference to a known PostgreSQL named `ENUM` or `DOMAIN` type. z unknown typeNz-PostgreSQL format_type() returned NULL for %sr rr0rwrr)5r)rrTrrrU)rrrFrrrz interval (.+)rrrrr6rz DOMAIN '%s'rrr;rr create_typerrrz!Did not recognize type '%s' of %s)r9rrHNULLTYPE_format_type_args_patternsearchr_format_type_args_delimr!_format_array_spec_patternryr ischema_namesr2rmapr startswithr#rr*r6quoted_token_parserrr _reflect_typer, IndexErrorrr)rrrrrattype_args_match attype_argsmatch_array_dim array_dimattype schema_typeargsrrUscalecharlen field_matchenum_or_domain_keyenumrrcheck_constraintrrrrs                              zPGDialect._reflect_typecCstt}|D]}|ddurt|||df<q|||df}|j|d||d|dd}|d} |d} |d} |d } t|trV| sP|jdurP|j} | oU|j } |d } | d vrit | | d vd }d} nd}d }| durt d| }|durt |j tjrd}d|dvr|dur|dd|d|d|d} | || | |p| du|dd}|dur||d<| dur| |d<||q|S)Nrrrz column '%s'rr;r<rr)Nr0)r{s)r r;Fz(nextval\(')([^']+)('.*$)Trrwr z"%s"r4rB)rrrr; autoincrementrBrr)rrrArrrrr;rrrr issubclassrrHIntegerrr)rrrrr6rrow_dict table_colscoltyper;rr<rrrrr* column_inforrrr/sv          zPGDialect._get_columns_infocCs^||}ttjjjtjjj||}|j |||d}|r-|tjjj t d}|S)NrXr) rr7rrKrurrYrrWrSrrB)rr6rrQrrVoid_qrrr_table_oids_querys  zPGDialect._table_oids_queryr6rrQc Ks2||\}}|||||} || |} | Sr)rrrra) rrr6rrQrrrrrresultrrr_get_table_oidss  zPGDialect._get_table_oidsc Csttjjjtjjjtjjjtj tjjj  dtj tjjj d dtj jjtj tj jjtjjjktjjjtdktjjjtdd}t|jj|jj|jj|jj|jjtjjjtj|ttjjj|jjktjjj|jjk|jjtdd}t|jjtjt |jj!t"|jj d|jjtj#|jj d $|jj|jj%|jj|jj}|r|j&d kr|tj'|jjtj'jj(k)tj*tj'jj+ d }|S|)t, d }|S|)t- d }|S) Nrr ordcontypeoidsconattrrrindnullsnotdistinctextra).r7r pg_constraintruconrelidconnameconindidr8rzunnestconkeyrgenerate_subscriptsrrrrrrrrBrsubqueryrrrrrrrrr array_aggrrrUmingroup_byr$rpg_index indexrelid add_columnsbool_andrrru)r is_uniquecon_sqattr_sqconstraint_queryrrr_constraint_querys       zPGDialect._constraint_querycks|j|||||fi|}t|} |dk} | r| dd} g| dd<||| dd| D|d} tt} | D]\}}}}}| |||||fq;| D]3\}}| |d}|r{|D]\}}}}| rq||||d|ifVq^||||dfVq^qP|ddddfVqP| sdSdS) Nur cSg|]}|dqSrrrErrrrrd z1PGDialect._reflect_constraint..)rrrnullsnotdistinct)rrrrrrr2)rrrr6rrQrr table_oidsbatchesrbatchr result_by_oidrrrrBr tablenamefor_oidrrrr_reflect_constraints@        zPGDialect._reflect_constraintcKrr)get_multi_pk_constraintr>r[r=rrrrrget_pk_constraint!rzPGDialect.get_pk_constraintc s6|j|d|||fi|}tjfdd|DS)Nr2c3sH|]\}}}}}|f|dur|durgn|||dnfVqdS)N)constrained_columnsrrBr)rErrpk_namerBr5r;r6rrrG7s  z4PGDialect.get_multi_pk_constraint..)r(rA pk_constraint)rrr6rrQrrrrr-rr)-s   z!PGDialect.get_multi_pk_constraintcKs2|j|f||g|tjtjd|}||||S)N)r6rrrQr)get_multi_foreign_keysr>r[r=r)rrrr6rrrrrrget_foreign_keysGs  zPGDialect.get_foreign_keysc Cs8tjd}tjd}||}ttjjjtjjj t j tjjj dttjjj dfdd|jjtjjjtjtjt tjjj tjjjktjjjdk||jj tjjjk||jj|jj ktjtjjjtjjj ktjjjtjjj ||}||||}|r|tjjjtd}|S)Ncls_refnsp_refTelse_rxr) rrKaliasrHrr7rurYrrr8rlris_notpg_get_constraintdefrIrrrrrrr confrelidrLrr$rrWrSrrB) rr6rrQr pg_class_refpg_namespace_refrVr(rrr_foreing_key_query[sj       .zPGDialect._foreing_key_queryc Cs"d}td|d|d|dS)Nz(?:"[^"]+"|[A-Za-z0-9_]+?)z%FOREIGN KEY \((.*?)\) REFERENCES (?:(z)\.)?(z)\(((?:a(?: *, *)?)+)\)[\s]?(MATCH (FULL|PARTIAL|SIMPLE)+)?[\s]?(ON UPDATE (CASCADE|RESTRICT|NO ACTION|SET NULL|SET DEFAULT)+)?[\s]?(ON DELETE (CASCADE|RESTRICT|NO ACTION|SET NULL|SET DEFAULT)+)?[\s]?(DEFERRABLE|NOT DEFERRABLE)?[\s]?(INITIALLY (DEFERRED|IMMEDIATE)+)?)rcompile)rqtokenrrr_fk_regex_patternszPGDialect._fk_regex_patternc" s|j||\}} |||||} || | } |j} tt} tj}| D]\}}}}}|dur7|| ||f<q$| ||f}t | | }|\ }}}}}}}}}}}}}|dur`|dkr^dnd}fddt d|D}|rz||j krw|}n|}n|r|}n |dur||kr|}|}fddt d|D}d d d |fd |fd |fd|fd|ffD} |||||| |d}!||!q$| S)N DEFERRABLETFcg|]}|qSrrr&rrrrdz4PGDialect.get_multi_foreign_keys..rcr@rrAr&rrrrdrBz\s*,\scSs&i|]\}}|dur|dkr||qS)Nz NO ACTIONr)rErrrrrrs z4PGDialect.get_multi_foreign_keys..onupdateondeleterrr*)rr+referred_schemareferred_tablereferred_columnsrrB)rrr;rr>rrrA foreign_keysrrgroupsr!default_schema_namerrr)"rrr6rrQrrrrrr(rFK_REGEXfkeysr;rrcondef conschemarB table_fksrir+rErFrGr5r*rCrDrrrfkey_drrrr/s~            z PGDialect.get_multi_foreign_keyscKrr)get_multi_indexesr>r[r=rrrrr get_indexesrzPGDialect.get_indexescCs4tjd}ttjjjtjjjtj tjjj  dtj tjjj d dtjjjtjjjtdd}t|jj|jj|jjtj|jjdkt|jj|jjddftjjjtd  d |jjdk d |tjttjjj|jjktjjj|jjk|jjtdd }t|jjtj |jjtj t!|jj"|jj d tj t!|jj#|jj d$|jjd}|j%dkrtjjj&}nt' d}|j%dkrtjjj(}nt) d}ttjjj|jj* dtjjj+tj,jj-.d dtjjj/|jj0tj1jj2tjtjjj3.dt4tjjj3tjjjfdd  d|||jj5|jj6 tjtjjjtdtjjj7|tjjj|jj8k7tj1|jj9tj1jj8k|tjjj|jjktj,ttjjjtj,jj-ktjjjtj,jj:ktj,jj;tdk?tjjj|jj*S)Ncls_idxrr rridxrTr3ris_expridx_attrrEelements_is_expridx_cols) r indnkeyattsrr relname_indexhas_constraintfilter_definition)r2rr')@rrKr5r7rrurindrelidr8rzr indkeyrr r indisprimaryrrBr rrlrpg_get_indexdefrrrrUrrrrrrrrrUrrrZrurrrY indisuniquerrr6 indoption reloptionspg_amamnameindpredrrErWrrrrelamr rrUrr~r$)rpg_class_indexidx_sqrcols_sqrZrrrr _index_querys      #         zPGDialect._index_queryc!Ks|j|||||fi|}tt}tj} t|} | r^| dd} g| dd<||jddd| Di} tt} | D] }| |d|q=| D]\}}|| vr\| |||f<qK| |D]}|d}|||f}|d}|d }|d }|rt ||kr||d}|d|}|d|}t d d ||dDsJn|}|}g}||d d}t |rddt ||D|d<||d<n||d<i}t |dD]'\}}d}|d@r|d7}|d@s|d7}n|d@r|d7}|r||||<q|r||d<|dr||d<i}|drtdd|dD|d<|d} | d kr*|d|d!<|d"r5|d"|d#<|jd$krC||d%<||d&<|d'rN|d'|d(<|rU||d)<||q`qK| s|S)*NrrrcSrrrrrrrrdr z/PGDialect.get_multi_indexes..r^r[rErWrZcss|]}| VqdSrr)rErUrrrrGs  z.PGDialect.get_multi_indexes..rb)rrcSsg|] \}}|r dn|qSrr)rEr rUrrrrds  column_namesrrcrr )rmrw) nulls_last) nulls_firstcolumn_sortingr\duplicates_constraintrdcSsg|]}|ddqS)=r r )rEoptionrrrrds postgresql_withrfbtreepostgresql_usingr]postgresql_where)rYinclude_columnspostgresql_includerpostgresql_nulls_not_distinctr)rrrrAindexesrrlrrryrarcr) enumeraterrr)!rrr6rrQrrr"r{r;r#r$rr%rrrrow index_name table_indexes all_elementsall_elements_is_exprrZinc_cols idx_elementsidx_elements_is_exprrsorting col_index col_flags col_sortingrrfrrrrQs                  szPGDialect.get_multi_indexescKrr)get_multi_unique_constraintsr>r[r=rrrrrget_unique_constraints!sz PGDialect.get_unique_constraintscKs|j|d||||fi|}tt}tj} |D]0\} } } } }| dur*| ||| f<q| | | d}|r>|dr>d|di|d<||| f|q|S)Nr)rmrrBr!rzr)r(rrrAunique_constraintsrr)rrr6rrQrrruniquesr;rrcon_namerBruc_dictrrrr/s. z&PGDialect.get_multi_unique_constraintscK0|j|||gftjtjd|}||||SN)rQr)get_multi_table_commentr>r[r=rrrrrget_table_commentVzPGDialect.get_table_commentc Cs||}ttjjjtjjjtj tjt tjjj tjjj ktjjjdktjjjt jdtk||}||||}|rQ|tjjjtd}|S)Nrzpg_catalog.pg_classr)rr7rrKrurYrrrrr8rrrrclassoidrzrr/rrWrSrrBrr6rrQrrVr(rrr_comment_querybs4    zPGDialect._comment_queryc  sD||\}}||||} || |} tjfdd| DS)Nc3s2|]\}}|f|durd|infVqdS)Nrr)rErrBr-rrrGs z4PGDialect.get_multi_table_comment..)rrrrA table_comment) rrr6rrQrrrrr(rrr-rr~s  z!PGDialect.get_multi_table_commentcKrr)get_multi_check_constraintsr>r[r=rrrrrget_check_constraintsrzPGDialect.get_check_constraintsc Cs||}ttjjjtjjjtj tjjj dt tjjj dfddtj jjtjtjttjjj tjjjktjjjdktj tj jjtjjj ktjjjtjjj||}||||}|rv|tjjjtd}|S)NTr3rur)rr7rrKrurYrrr8rlrr6r7rrrrrrrrr$rrWrSrrBrrrr_check_constraint_querysT     %z!PGDialect._check_constraint_querycKs||\}}|||||} || |} tt} tj} | D]g\} }}}|dur4|dur4| | || f<qtjd|tj d}|sIt d|d}ntj dtj d d|d}|||d}|r|i}d |vrld |d <d |vrvd |d <|r|||d<| || f|q| S)Nz,^CHECK *\((.+)\)( NO INHERIT)?( NOT VALID)?$)r6z)Could not parse CHECK constraint text: %rr0z^[\s\n]*\((.+)\)[\s\n]*$z\1r )rr rBrTrz NO INHERIT no_inheritr)rrrrrrAcheck_constraintsrr*DOTALLr9rr<rrrIrr)rrr6rrQrrrrr(rrr;r check_namesrcrBrir entryrZrrrrsL    z%PGDialect.get_multi_check_constraintscCsN|dur|ttjjjtjjjdk}|S|dkr%|tjjj|k}|Srb)rrrgrdrurrHrI)rr(r6rrr_pg_type_filter_schemas z PGDialect._pg_type_filter_schemacCsttjjjtjttjjj t tjjj  dtjjjd}ttjjj dttjjj dtjjj d|jj dtjtjjjtjjjk|tjjj|jjktjjjdktjjjtjjj}|||S)Nrlbl_aggrrr6r)r7rpg_enumru enumtypidr8rzrr enumlabelrrU enumsortorderrrr rdrergrrHrIrrrrfrrtyptyper$r)rr6 lbl_agg_sqr(rrr _enum_query sH   zPGDialect._enum_queryc KsT|jsgS|||}g}|D]\}}}}|||||dur"gn|dq|S)N)rr6rr)r{rrr) rrr6rrrrrrrrrr5szPGDialect._load_enumsc Cshttjjjtjttjjj d dtjtjjj t  dtjjjdktjjjd}ttjjj dttjjjtjjj dtjjj dtjjj d ttjjj  d tjjj d |jj|jjtjjj tjtjjj tjjj k!tjtjjj"tjjj k!|tjjj |jjktjjj#d k$tjjjtjjj}|%||S) NTcondefsconnamesrdomain_constraintsrrrr;rr6r)&r7rrrucontypidr8rzrr7rrrrrUrrr rdrer typbasetype typtypmod typnotnull typdefaultrgrHrIrr pg_collationcollnamerrrfr typcollationrr$r)rr6rr(rrr _domain_queryHsp   $zPGDialect._domain_queryc Ks|||}g}|D]S}td|dd}g}|drEtt|d|dddd} | D]\} } | d d } || | d q2|d |d |d||d|d||dd} || q|S)Nz([^\(]+)rr rrcSs|dS)Nrr)rrrrsz)PGDialect._load_domains..)rr)rrrr6rrr;r)rr6rrrr;rr) rrrrrrsortedr)r)rrr6rrrrrrsorted_constraintsrdef_r domain_recrrrrs0    zPGDialect._load_domainscCs|d}|dk|_dS)Nz show standard_conforming_stringsri)r9rFrL)rr std_stringrrrr s z PGDialect._set_backslash_escapes)NNN)rr@rr)TFr)rr=rr) rrrrrrrrrrrr)rrrrsupports_statement_cachesupports_altermax_identifier_lengthsupports_sane_rowcountr< BindTyping RENDER_CASTS bind_typingr{supports_native_booleansupports_native_uuidrsupports_sequencessequences_optional"preexecute_autoincrement_sequencespostfetch_lastrowiduse_insertmanyvaluesreturns_native_bytesrIANY_AUTOINCREMENTUSE_INSERT_FROM_SELECTRENDER_SELECT_COL_CASTS"insertmanyvalues_implicit_sentinelsupports_commentssupports_constraint_commentssupports_default_valuessupports_default_metavaluesupports_empty_insertsupports_multivalues_insertrdefault_paramstylercolspecsrstatement_compilerr ddl_compilerrEtype_compiler_clsrrrexecution_ctx_clsr inspectorupdate_returningdelete_returninginsert_returningupdate_returning_multifromdelete_returning_multifromr;rconnection_characteristicsrrrr6IndexTableCheckConstraintForeignKeyConstraintUniqueConstraintconstruct_argumentsreflection_optionsrLrr(rrr rrrrrrr4r8r:rArCrErGr?rrJrSrWrr\r^rarrjrrnrprtrvrr}rrrrrrrrrrrr<rrrrrr flexi_cacherJ dp_stringdp_string_list dp_plain_objrrr(r*r)r0r;r9memoized_propertyr>r/rRrlrQrrrrrrrrrrrrrr rrrrOrr s  ,    T                       !   S    \&    9  a     '    .6 *  ; #r)r __future__r collectionsr functoolsrrtypingrrrrr r r r0r rr_jsonrr_rangesextrrrr named_typesrrrrrrrtypesrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r5r6r7r8r9enginer:r;r<r=r>r?r@engine.reflectionrArBrCrDrErFrGrHro sql.compilerrI sql.visitorsrJrKrLrMrNrOrPrQrRrSrTrUrVrW util.typingrXr<IrrrIntervalrr JSONPathTyperUuidrr\rjrlrnrprrrtr^r`rbrdrfrhrr SQLCompilerr DDLCompilerrGenericTypeCompilerrEIdentifierPreparerrrrrr InspectorrDefaultExecutionContextrConnectionCharacteristicrrrrrrrrs H                                                                                     j        !"#$%&'()*+,-./01268z?  n 7