o gi@sdZddlmZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl mZdd lmZdd lmZdd lmZd d l mZd dl mZd dl mZd dl mZd dl mZd dl mZd dl mZd dlmZd dlmZd dlm Z d dl!m"Z"d dlm#Z#d dlm$Z$d dlm%Z%d dlm&Z&d dlm'Z'd dlm(Z(d dlm)Z)d dlm*Z*d d lm+Z+d dlmZ,d d!l-m.Z.d d"l/m0Z0d d#l1m2Z2d d$l3m4Z4d d%l3m5Z5d d&l3m6Z6d d'l3m7Z7d d(l3m8Z8d d)l3m9Z9d d*l3m:Z:d d+l3m;Z;d d,l3mZ>d d/l3m?Z?d d0l3m@Z@d d1l3mAZAd d2lmBZBd d3lCmDZDe rAd d4lEmFZFd d5lGmHZHd6ZId7ZJd8ZKd9ZLd:ZMd;ZNdd?d?e*jQZQGd@dAdAe*jRZRGdBdCdCe*jSZTGdDdEdEe*jUZVGdFdGdGe*jWZWeWZXGdHdIdIeWZYGdJdKdKZZGdLdMdMeZe*j[Z\GdNdOdOeZe*j[Z]GdPdQdQeZe*j[Z^GdRdSdSeZe*j[Z_GdTdUdUZ`GdVdWdWe`e*jaZbGdXdYdYe`e*jcZdGdZd[d[e*jeZfGd\d]d]efZgGd^d_d_e*jcZhGd`dadae*jie*jjZiGdbdcdce*jjZkGdddedee*jlZmGdfdgdge*jnZoGdhdidie*jpZqGdjdkdke*jpZrGdldmdme*jsZtGdndodoe*jse*juZvGdpdqdqe*jpZwe\ZxeVZyeQZzeTZ{eWZ|e]Z}e^Z~e_Ze@ZehZeAZe>Ze6Zedxe6dye<dze@d{ehd|e9d}e=d~e:de8de^de_de7eWe]e5eieoeQeRekemefeqerevewdZGddde$jZGdddejZGddde$jZGdddeZGddde$jZGddde$jZddZddZddZddZeZddZGdddejZdS)a .. dialect:: mssql :name: Microsoft SQL Server :normal_support: 2012+ :best_effort: 2005+ .. _mssql_external_dialects: External Dialects ----------------- In addition to the above DBAPI layers with native SQLAlchemy support, there are third-party dialects for other DBAPI layers that are compatible with SQL Server. See the "External Dialects" list on the :ref:`dialect_toplevel` page. .. _mssql_identity: Auto Increment Behavior / IDENTITY Columns ------------------------------------------ SQL Server provides so-called "auto incrementing" behavior using the ``IDENTITY`` construct, which can be placed on any single integer column in a table. SQLAlchemy considers ``IDENTITY`` within its default "autoincrement" behavior for an integer primary key column, described at :paramref:`_schema.Column.autoincrement`. This means that by default, the first integer primary key column in a :class:`_schema.Table` will be considered to be the identity column - unless it is associated with a :class:`.Sequence` - and will generate DDL as such:: from sqlalchemy import Table, MetaData, Column, Integer m = MetaData() t = Table( "t", m, Column("id", Integer, primary_key=True), Column("x", Integer), ) m.create_all(engine) The above example will generate DDL as: .. sourcecode:: sql CREATE TABLE t ( id INTEGER NOT NULL IDENTITY, x INTEGER NULL, PRIMARY KEY (id) ) For the case where this default generation of ``IDENTITY`` is not desired, specify ``False`` for the :paramref:`_schema.Column.autoincrement` flag, on the first integer primary key column:: m = MetaData() t = Table( "t", m, Column("id", Integer, primary_key=True, autoincrement=False), Column("x", Integer), ) m.create_all(engine) To add the ``IDENTITY`` keyword to a non-primary key column, specify ``True`` for the :paramref:`_schema.Column.autoincrement` flag on the desired :class:`_schema.Column` object, and ensure that :paramref:`_schema.Column.autoincrement` is set to ``False`` on any integer primary key column:: m = MetaData() t = Table( "t", m, Column("id", Integer, primary_key=True, autoincrement=False), Column("x", Integer, autoincrement=True), ) m.create_all(engine) .. versionchanged:: 1.4 Added :class:`_schema.Identity` construct in a :class:`_schema.Column` to specify the start and increment parameters of an IDENTITY. These replace the use of the :class:`.Sequence` object in order to specify these values. .. deprecated:: 1.4 The ``mssql_identity_start`` and ``mssql_identity_increment`` parameters to :class:`_schema.Column` are deprecated and should we replaced by an :class:`_schema.Identity` object. Specifying both ways of configuring an IDENTITY will result in a compile error. These options are also no longer returned as part of the ``dialect_options`` key in :meth:`_reflection.Inspector.get_columns`. Use the information in the ``identity`` key instead. .. deprecated:: 1.3 The use of :class:`.Sequence` to specify IDENTITY characteristics is deprecated and will be removed in a future release. Please use the :class:`_schema.Identity` object parameters :paramref:`_schema.Identity.start` and :paramref:`_schema.Identity.increment`. .. versionchanged:: 1.4 Removed the ability to use a :class:`.Sequence` object to modify IDENTITY characteristics. :class:`.Sequence` objects now only manipulate true T-SQL SEQUENCE types. .. note:: There can only be one IDENTITY column on the table. When using ``autoincrement=True`` to enable the IDENTITY keyword, SQLAlchemy does not guard against multiple columns specifying the option simultaneously. The SQL Server database will instead reject the ``CREATE TABLE`` statement. .. note:: An INSERT statement which attempts to provide a value for a column that is marked with IDENTITY will be rejected by SQL Server. In order for the value to be accepted, a session-level option "SET IDENTITY_INSERT" must be enabled. The SQLAlchemy SQL Server dialect will perform this operation automatically when using a core :class:`_expression.Insert` construct; if the execution specifies a value for the IDENTITY column, the "IDENTITY_INSERT" option will be enabled for the span of that statement's invocation.However, this scenario is not high performing and should not be relied upon for normal use. If a table doesn't actually require IDENTITY behavior in its integer primary key column, the keyword should be disabled when creating the table by ensuring that ``autoincrement=False`` is set. Controlling "Start" and "Increment" ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Specific control over the "start" and "increment" values for the ``IDENTITY`` generator are provided using the :paramref:`_schema.Identity.start` and :paramref:`_schema.Identity.increment` parameters passed to the :class:`_schema.Identity` object:: from sqlalchemy import Table, Integer, Column, Identity test = Table( "test", metadata, Column( "id", Integer, primary_key=True, Identity(start=100, increment=10) ), Column("name", String(20)), ) The CREATE TABLE for the above :class:`_schema.Table` object would be: .. sourcecode:: sql CREATE TABLE test ( id INTEGER NOT NULL IDENTITY(100,10) PRIMARY KEY, name VARCHAR(20) NULL, ) .. note:: The :class:`_schema.Identity` object supports many other parameter in addition to ``start`` and ``increment``. These are not supported by SQL Server and will be ignored when generating the CREATE TABLE ddl. .. versionchanged:: 1.3.19 The :class:`_schema.Identity` object is now used to affect the ``IDENTITY`` generator for a :class:`_schema.Column` under SQL Server. Previously, the :class:`.Sequence` object was used. As SQL Server now supports real sequences as a separate construct, :class:`.Sequence` will be functional in the normal way starting from SQLAlchemy version 1.4. Using IDENTITY with Non-Integer numeric types ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ SQL Server also allows ``IDENTITY`` to be used with ``NUMERIC`` columns. To implement this pattern smoothly in SQLAlchemy, the primary datatype of the column should remain as ``Integer``, however the underlying implementation type deployed to the SQL Server database can be specified as ``Numeric`` using :meth:`.TypeEngine.with_variant`:: from sqlalchemy import Column from sqlalchemy import Integer from sqlalchemy import Numeric from sqlalchemy import String from sqlalchemy.ext.declarative import declarative_base Base = declarative_base() class TestTable(Base): __tablename__ = "test" id = Column( Integer().with_variant(Numeric(10, 0), "mssql"), primary_key=True, autoincrement=True, ) name = Column(String) In the above example, ``Integer().with_variant()`` provides clear usage information that accurately describes the intent of the code. The general restriction that ``autoincrement`` only applies to ``Integer`` is established at the metadata level and not at the per-dialect level. When using the above pattern, the primary key identifier that comes back from the insertion of a row, which is also the value that would be assigned to an ORM object such as ``TestTable`` above, will be an instance of ``Decimal()`` and not ``int`` when using SQL Server. The numeric return type of the :class:`_types.Numeric` type can be changed to return floats by passing False to :paramref:`_types.Numeric.asdecimal`. To normalize the return type of the above ``Numeric(10, 0)`` to return Python ints (which also support "long" integer values in Python 3), use :class:`_types.TypeDecorator` as follows:: from sqlalchemy import TypeDecorator class NumericAsInteger(TypeDecorator): "normalize floating point return values into ints" impl = Numeric(10, 0, asdecimal=False) cache_ok = True def process_result_value(self, value, dialect): if value is not None: value = int(value) return value class TestTable(Base): __tablename__ = "test" id = Column( Integer().with_variant(NumericAsInteger, "mssql"), primary_key=True, autoincrement=True, ) name = Column(String) .. _mssql_insert_behavior: INSERT behavior ^^^^^^^^^^^^^^^^ Handling of the ``IDENTITY`` column at INSERT time involves two key techniques. The most common is being able to fetch the "last inserted value" for a given ``IDENTITY`` column, a process which SQLAlchemy performs implicitly in many cases, most importantly within the ORM. The process for fetching this value has several variants: * In the vast majority of cases, RETURNING is used in conjunction with INSERT statements on SQL Server in order to get newly generated primary key values: .. sourcecode:: sql INSERT INTO t (x) OUTPUT inserted.id VALUES (?) As of SQLAlchemy 2.0, the :ref:`engine_insertmanyvalues` feature is also used by default to optimize many-row INSERT statements; for SQL Server the feature takes place for both RETURNING and-non RETURNING INSERT statements. .. versionchanged:: 2.0.10 The :ref:`engine_insertmanyvalues` feature for SQL Server was temporarily disabled for SQLAlchemy version 2.0.9 due to issues with row ordering. As of 2.0.10 the feature is re-enabled, with special case handling for the unit of work's requirement for RETURNING to be ordered. * When RETURNING is not available or has been disabled via ``implicit_returning=False``, either the ``scope_identity()`` function or the ``@@identity`` variable is used; behavior varies by backend: * when using PyODBC, the phrase ``; select scope_identity()`` will be appended to the end of the INSERT statement; a second result set will be fetched in order to receive the value. Given a table as:: t = Table( "t", metadata, Column("id", Integer, primary_key=True), Column("x", Integer), implicit_returning=False, ) an INSERT will look like: .. sourcecode:: sql INSERT INTO t (x) VALUES (?); select scope_identity() * Other dialects such as pymssql will call upon ``SELECT scope_identity() AS lastrowid`` subsequent to an INSERT statement. If the flag ``use_scope_identity=False`` is passed to :func:`_sa.create_engine`, the statement ``SELECT @@identity AS lastrowid`` is used instead. A table that contains an ``IDENTITY`` column will prohibit an INSERT statement that refers to the identity column explicitly. The SQLAlchemy dialect will detect when an INSERT construct, created using a core :func:`_expression.insert` construct (not a plain string SQL), refers to the identity column, and in this case will emit ``SET IDENTITY_INSERT ON`` prior to the insert statement proceeding, and ``SET IDENTITY_INSERT OFF`` subsequent to the execution. Given this example:: m = MetaData() t = Table( "t", m, Column("id", Integer, primary_key=True), Column("x", Integer) ) m.create_all(engine) with engine.begin() as conn: conn.execute(t.insert(), {"id": 1, "x": 1}, {"id": 2, "x": 2}) The above column will be created with IDENTITY, however the INSERT statement we emit is specifying explicit values. In the echo output we can see how SQLAlchemy handles this: .. sourcecode:: sql CREATE TABLE t ( id INTEGER NOT NULL IDENTITY(1,1), x INTEGER NULL, PRIMARY KEY (id) ) COMMIT SET IDENTITY_INSERT t ON INSERT INTO t (id, x) VALUES (?, ?) ((1, 1), (2, 2)) SET IDENTITY_INSERT t OFF COMMIT This is an auxiliary use case suitable for testing and bulk insert scenarios. SEQUENCE support ---------------- The :class:`.Sequence` object creates "real" sequences, i.e., ``CREATE SEQUENCE``: .. sourcecode:: pycon+sql >>> from sqlalchemy import Sequence >>> from sqlalchemy.schema import CreateSequence >>> from sqlalchemy.dialects import mssql >>> print( ... CreateSequence(Sequence("my_seq", start=1)).compile( ... dialect=mssql.dialect() ... ) ... ) {printsql}CREATE SEQUENCE my_seq START WITH 1 For integer primary key generation, SQL Server's ``IDENTITY`` construct should generally be preferred vs. sequence. .. tip:: The default start value for T-SQL is ``-2**63`` instead of 1 as in most other SQL databases. Users should explicitly set the :paramref:`.Sequence.start` to 1 if that's the expected default:: seq = Sequence("my_sequence", start=1) .. versionadded:: 1.4 added SQL Server support for :class:`.Sequence` .. versionchanged:: 2.0 The SQL Server dialect will no longer implicitly render "START WITH 1" for ``CREATE SEQUENCE``, which was the behavior first implemented in version 1.4. MAX on VARCHAR / NVARCHAR ------------------------- SQL Server supports the special string "MAX" within the :class:`_types.VARCHAR` and :class:`_types.NVARCHAR` datatypes, to indicate "maximum length possible". The dialect currently handles this as a length of "None" in the base type, rather than supplying a dialect-specific version of these types, so that a base type specified such as ``VARCHAR(None)`` can assume "unlengthed" behavior on more than one backend without using dialect-specific types. To build a SQL Server VARCHAR or NVARCHAR with MAX length, use None:: my_table = Table( "my_table", metadata, Column("my_data", VARCHAR(None)), Column("my_n_data", NVARCHAR(None)), ) Collation Support ----------------- Character collations are supported by the base string types, specified by the string argument "collation":: from sqlalchemy import VARCHAR Column("login", VARCHAR(32, collation="Latin1_General_CI_AS")) When such a column is associated with a :class:`_schema.Table`, the CREATE TABLE statement for this column will yield: .. sourcecode:: sql login VARCHAR(32) COLLATE Latin1_General_CI_AS NULL LIMIT/OFFSET Support -------------------- MSSQL has added support for LIMIT / OFFSET as of SQL Server 2012, via the "OFFSET n ROWS" and "FETCH NEXT n ROWS" clauses. SQLAlchemy supports these syntaxes automatically if SQL Server 2012 or greater is detected. .. versionchanged:: 1.4 support added for SQL Server "OFFSET n ROWS" and "FETCH NEXT n ROWS" syntax. For statements that specify only LIMIT and no OFFSET, all versions of SQL Server support the TOP keyword. This syntax is used for all SQL Server versions when no OFFSET clause is present. A statement such as:: select(some_table).limit(5) will render similarly to: .. sourcecode:: sql SELECT TOP 5 col1, col2.. FROM table For versions of SQL Server prior to SQL Server 2012, a statement that uses LIMIT and OFFSET, or just OFFSET alone, will be rendered using the ``ROW_NUMBER()`` window function. A statement such as:: select(some_table).order_by(some_table.c.col3).limit(5).offset(10) will render similarly to: .. sourcecode:: sql SELECT anon_1.col1, anon_1.col2 FROM (SELECT col1, col2, ROW_NUMBER() OVER (ORDER BY col3) AS mssql_rn FROM table WHERE t.x = :x_1) AS anon_1 WHERE mssql_rn > :param_1 AND mssql_rn <= :param_2 + :param_1 Note that when using LIMIT and/or OFFSET, whether using the older or newer SQL Server syntaxes, the statement must have an ORDER BY as well, else a :class:`.CompileError` is raised. .. _mssql_comment_support: DDL Comment Support -------------------- Comment support, which includes DDL rendering for attributes such as :paramref:`_schema.Table.comment` and :paramref:`_schema.Column.comment`, as well as the ability to reflect these comments, is supported assuming a supported version of SQL Server is in use. If a non-supported version such as Azure Synapse is detected at first-connect time (based on the presence of the ``fn_listextendedproperty`` SQL function), comment support including rendering and table-comment reflection is disabled, as both features rely upon SQL Server stored procedures and functions that are not available on all backend types. To force comment support to be on or off, bypassing autodetection, set the parameter ``supports_comments`` within :func:`_sa.create_engine`:: e = create_engine("mssql+pyodbc://u:p@dsn", supports_comments=False) .. versionadded:: 2.0 Added support for table and column comments for the SQL Server dialect, including DDL generation and reflection. .. _mssql_isolation_level: Transaction Isolation Level --------------------------- All SQL Server dialects support setting of transaction isolation level both via a dialect-specific parameter :paramref:`_sa.create_engine.isolation_level` accepted by :func:`_sa.create_engine`, as well as the :paramref:`.Connection.execution_options.isolation_level` argument as passed to :meth:`_engine.Connection.execution_options`. This feature works by issuing the command ``SET TRANSACTION ISOLATION LEVEL `` for each new connection. To set isolation level using :func:`_sa.create_engine`:: engine = create_engine( "mssql+pyodbc://scott:tiger@ms_2008", isolation_level="REPEATABLE READ" ) To set using per-connection execution options:: connection = engine.connect() connection = connection.execution_options(isolation_level="READ COMMITTED") Valid values for ``isolation_level`` include: * ``AUTOCOMMIT`` - pyodbc / pymssql-specific * ``READ COMMITTED`` * ``READ UNCOMMITTED`` * ``REPEATABLE READ`` * ``SERIALIZABLE`` * ``SNAPSHOT`` - specific to SQL Server 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. .. seealso:: :ref:`dbapi_autocommit` .. _mssql_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. An undocumented SQL Server procedure known as ``sp_reset_connection`` is known to be a workaround for this issue which will reset most of the session state that builds up on a connection, including temporary tables. To install ``sp_reset_connection`` as the means of performing reset-on-return, the :meth:`.PoolEvents.reset` event hook may be used, as demonstrated in the example below. 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 mssql_engine = create_engine( "mssql+pyodbc://scott:tiger^5HHH@mssql2017:1433/test?driver=ODBC+Driver+17+for+SQL+Server", # disable default reset-on-return scheme pool_reset_on_return=None, ) @event.listens_for(mssql_engine, "reset") def _reset_mssql(dbapi_connection, connection_record, reset_state): if not reset_state.terminate_only: dbapi_connection.execute("{call sys.sp_reset_connection}") # 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 Nullability ----------- MSSQL has support for three levels of column nullability. The default nullability allows nulls and is explicit in the CREATE TABLE construct: .. sourcecode:: sql name VARCHAR(20) NULL If ``nullable=None`` is specified then no specification is made. In other words the database's configured default is used. This will render: .. sourcecode:: sql name VARCHAR(20) If ``nullable`` is ``True`` or ``False`` then the column will be ``NULL`` or ``NOT NULL`` respectively. Date / Time Handling -------------------- DATE and TIME are supported. Bind parameters are converted to datetime.datetime() objects as required by most MSSQL drivers, and results are processed from strings if needed. The DATE and TIME types are not available for MSSQL 2005 and previous - if a server version below 2008 is detected, DDL for these types will be issued as DATETIME. .. _mssql_large_type_deprecation: Large Text/Binary Type Deprecation ---------------------------------- Per `SQL Server 2012/2014 Documentation `_, the ``NTEXT``, ``TEXT`` and ``IMAGE`` datatypes are to be removed from SQL Server in a future release. SQLAlchemy normally relates these types to the :class:`.UnicodeText`, :class:`_expression.TextClause` and :class:`.LargeBinary` datatypes. In order to accommodate this change, a new flag ``deprecate_large_types`` is added to the dialect, which will be automatically set based on detection of the server version in use, if not otherwise set by the user. The behavior of this flag is as follows: * When this flag is ``True``, the :class:`.UnicodeText`, :class:`_expression.TextClause` and :class:`.LargeBinary` datatypes, when used to render DDL, will render the types ``NVARCHAR(max)``, ``VARCHAR(max)``, and ``VARBINARY(max)``, respectively. This is a new behavior as of the addition of this flag. * When this flag is ``False``, the :class:`.UnicodeText`, :class:`_expression.TextClause` and :class:`.LargeBinary` datatypes, when used to render DDL, will render the types ``NTEXT``, ``TEXT``, and ``IMAGE``, respectively. This is the long-standing behavior of these types. * The flag begins with the value ``None``, before a database connection is established. If the dialect is used to render DDL without the flag being set, it is interpreted the same as ``False``. * On first connection, the dialect detects if SQL Server version 2012 or greater is in use; if the flag is still at ``None``, it sets it to ``True`` or ``False`` based on whether 2012 or greater is detected. * The flag can be set to either ``True`` or ``False`` when the dialect is created, typically via :func:`_sa.create_engine`:: eng = create_engine( "mssql+pymssql://user:pass@host/db", deprecate_large_types=True ) * Complete control over whether the "old" or "new" types are rendered is available in all SQLAlchemy versions by using the UPPERCASE type objects instead: :class:`_types.NVARCHAR`, :class:`_types.VARCHAR`, :class:`_types.VARBINARY`, :class:`_types.TEXT`, :class:`_mssql.NTEXT`, :class:`_mssql.IMAGE` will always remain fixed and always output exactly that type. .. _multipart_schema_names: Multipart Schema Names ---------------------- SQL Server schemas sometimes require multiple parts to their "schema" qualifier, that is, including the database name and owner name as separate tokens, such as ``mydatabase.dbo.some_table``. These multipart names can be set at once using the :paramref:`_schema.Table.schema` argument of :class:`_schema.Table`:: Table( "some_table", metadata, Column("q", String(50)), schema="mydatabase.dbo", ) When performing operations such as table or component reflection, a schema argument that contains a dot will be split into separate "database" and "owner" components in order to correctly query the SQL Server information schema tables, as these two values are stored separately. Additionally, when rendering the schema name for DDL or SQL, the two components will be quoted separately for case sensitive names and other special characters. Given an argument as below:: Table( "some_table", metadata, Column("q", String(50)), schema="MyDataBase.dbo", ) The above schema would be rendered as ``[MyDataBase].dbo``, and also in reflection, would be reflected using "dbo" as the owner and "MyDataBase" as the database name. To control how the schema name is broken into database / owner, specify brackets (which in SQL Server are quoting characters) in the name. Below, the "owner" will be considered as ``MyDataBase.dbo`` and the "database" will be None:: Table( "some_table", metadata, Column("q", String(50)), schema="[MyDataBase.dbo]", ) To individually specify both database and owner name with special characters or embedded dots, use two sets of brackets:: Table( "some_table", metadata, Column("q", String(50)), schema="[MyDataBase.Period].[MyOwner.Dot]", ) .. versionchanged:: 1.2 the SQL Server dialect now treats brackets as identifier delimiters splitting the schema into separate database and owner tokens, to allow dots within either name itself. .. _legacy_schema_rendering: Legacy Schema Mode ------------------ Very old versions of the MSSQL dialect introduced the behavior such that a schema-qualified table would be auto-aliased when used in a SELECT statement; given a table:: account_table = Table( "account", metadata, Column("id", Integer, primary_key=True), Column("info", String(100)), schema="customer_schema", ) this legacy mode of rendering would assume that "customer_schema.account" would not be accepted by all parts of the SQL statement, as illustrated below: .. sourcecode:: pycon+sql >>> eng = create_engine("mssql+pymssql://mydsn", legacy_schema_aliasing=True) >>> print(account_table.select().compile(eng)) {printsql}SELECT account_1.id, account_1.info FROM customer_schema.account AS account_1 This mode of behavior is now off by default, as it appears to have served no purpose; however in the case that legacy applications rely upon it, it is available using the ``legacy_schema_aliasing`` argument to :func:`_sa.create_engine` as illustrated above. .. deprecated:: 1.4 The ``legacy_schema_aliasing`` flag is now deprecated and will be removed in a future release. .. _mssql_indexes: Clustered Index Support ----------------------- The MSSQL dialect supports clustered indexes (and primary keys) via the ``mssql_clustered`` option. This option is available to :class:`.Index`, :class:`.UniqueConstraint`. and :class:`.PrimaryKeyConstraint`. For indexes this option can be combined with the ``mssql_columnstore`` one to create a clustered columnstore index. To generate a clustered index:: Index("my_index", table.c.x, mssql_clustered=True) which renders the index as ``CREATE CLUSTERED INDEX my_index ON table (x)``. To generate a clustered primary key use:: Table( "my_table", metadata, Column("x", ...), Column("y", ...), PrimaryKeyConstraint("x", "y", mssql_clustered=True), ) which will render the table, for example, as: .. sourcecode:: sql CREATE TABLE my_table ( x INTEGER NOT NULL, y INTEGER NOT NULL, PRIMARY KEY CLUSTERED (x, y) ) Similarly, we can generate a clustered unique constraint using:: Table( "my_table", metadata, Column("x", ...), Column("y", ...), PrimaryKeyConstraint("x"), UniqueConstraint("y", mssql_clustered=True), ) To explicitly request a non-clustered primary key (for example, when a separate clustered index is desired), use:: Table( "my_table", metadata, Column("x", ...), Column("y", ...), PrimaryKeyConstraint("x", "y", mssql_clustered=False), ) which will render the table, for example, as: .. sourcecode:: sql CREATE TABLE my_table ( x INTEGER NOT NULL, y INTEGER NOT NULL, PRIMARY KEY NONCLUSTERED (x, y) ) Columnstore Index Support ------------------------- The MSSQL dialect supports columnstore indexes via the ``mssql_columnstore`` option. This option is available to :class:`.Index`. It be combined with the ``mssql_clustered`` option to create a clustered columnstore index. To generate a columnstore index:: Index("my_index", table.c.x, mssql_columnstore=True) which renders the index as ``CREATE COLUMNSTORE INDEX my_index ON table (x)``. To generate a clustered columnstore index provide no columns:: idx = Index("my_index", mssql_clustered=True, mssql_columnstore=True) # required to associate the index with the table table.append_constraint(idx) the above renders the index as ``CREATE CLUSTERED COLUMNSTORE INDEX my_index ON table``. .. versionadded:: 2.0.18 MSSQL-Specific Index Options ----------------------------- In addition to clustering, the MSSQL dialect supports other special options for :class:`.Index`. INCLUDE ^^^^^^^ The ``mssql_include`` option renders INCLUDE(colname) for the given string names:: Index("my_index", table.c.x, mssql_include=["y"]) would render the index as ``CREATE INDEX my_index ON table (x) INCLUDE (y)`` .. _mssql_index_where: Filtered Indexes ^^^^^^^^^^^^^^^^ The ``mssql_where`` option renders WHERE(condition) for the given string names:: Index("my_index", table.c.x, mssql_where=table.c.x > 10) would render the index as ``CREATE INDEX my_index ON table (x) WHERE x > 10``. .. versionadded:: 1.3.4 Index ordering ^^^^^^^^^^^^^^ Index ordering is available via functional expressions, such as:: Index("my_index", table.c.x.desc()) would render the index as ``CREATE INDEX my_index ON table (x DESC)`` .. seealso:: :ref:`schema_indexes_functional` Compatibility Levels -------------------- MSSQL supports the notion of setting compatibility levels at the database level. This allows, for instance, to run a database that is compatible with SQL2000 while running on a SQL2005 database server. ``server_version_info`` will always return the database server version information (in this case SQL2005) and not the compatibility level information. Because of this, if running under a backwards compatibility mode SQLAlchemy may attempt to use T-SQL statements that are unable to be parsed by the database server. .. _mssql_triggers: Triggers -------- SQLAlchemy by default uses OUTPUT INSERTED to get at newly generated primary key values via IDENTITY columns or other server side defaults. MS-SQL does not allow the usage of OUTPUT INSERTED on tables that have triggers. To disable the usage of OUTPUT INSERTED on a per-table basis, specify ``implicit_returning=False`` for each :class:`_schema.Table` which has triggers:: Table( "mytable", metadata, Column("id", Integer, primary_key=True), # ..., implicit_returning=False, ) Declarative form:: class MyClass(Base): # ... __table_args__ = {"implicit_returning": False} .. _mssql_rowcount_versioning: Rowcount Support / ORM Versioning --------------------------------- The SQL Server drivers may have limited ability to return the number of rows updated from an UPDATE or DELETE statement. As of this writing, the PyODBC driver is not able to return a rowcount when OUTPUT INSERTED is used. Previous versions of SQLAlchemy therefore had limitations for features such as the "ORM Versioning" feature that relies upon accurate rowcounts in order to match version numbers with matched rows. SQLAlchemy 2.0 now retrieves the "rowcount" manually for these particular use cases based on counting the rows that arrived back within RETURNING; so while the driver still has this limitation, the ORM Versioning feature is no longer impacted by it. As of SQLAlchemy 2.0.5, ORM versioning has been fully re-enabled for the pyodbc driver. .. versionchanged:: 2.0.5 ORM versioning support is restored for the pyodbc driver. Previously, a warning would be emitted during ORM flush that versioning was not supported. Enabling Snapshot Isolation --------------------------- SQL Server has a default transaction isolation mode that locks entire tables, and causes even mildly concurrent applications to have long held locks and frequent deadlocks. Enabling snapshot isolation for the database as a whole is recommended for modern levels of concurrency support. This is accomplished via the following ALTER DATABASE commands executed at the SQL prompt: .. sourcecode:: sql ALTER DATABASE MyDatabase SET ALLOW_SNAPSHOT_ISOLATION ON ALTER DATABASE MyDatabase SET READ_COMMITTED_SNAPSHOT ON Background on SQL Server snapshot isolation is available at https://msdn.microsoft.com/en-us/library/ms175095.aspx. ) annotationsN)overload) TYPE_CHECKING)UUID)information_schema)JSON) JSONIndexType) JSONPathType)exc)Identity)schema)Sequence)sql)text)util)cursor)default) reflection)ReflectionDefaults) coercions)compiler)elements) expression)func) quoted_name)roles)sqltypes)try_cast)is_sql_compiler)InsertmanyvaluesSentinelOpts)TryCast)BIGINT)BINARY)CHAR)DATE)DATETIME)DECIMAL)FLOAT)INTEGER)NCHAR)NUMERIC)NVARCHAR)SMALLINT)TEXT)VARCHARupdate_wrapper)Literal)DMLState) TableClause)) ) ) ) ) )>asbyifinisofonortoaddallandanyascendforkeynotoffsettopusebulkcasedbccdenydescdiskdropdumpelseexecexitfilefromfullgotointojoinkillleftlikeloadnullopenoverplanprocreadrulesavesomethentranuserviewwhenwithalterbeginbreakcheckclosecrossfetchgrantgroupindexinnermergeorderouterpivotprintrighttableunionwherewhilebackupbrowsecolumncommitcreaterdeletedoubleerrlvlescapeexceptexistshavinginsertlinenonullifoptionpublicreturnrevertrevokerselectuniqueupdatevaluesbetweencascadecollatecomputeconvertcurrentdeclarerexecuteforeignnocheckoffsetsopenxmlpercentprimaryrestoresetusertriggertsequalunpivotvaryingwaitforcoalescecontainscontinuedatabasedistinctexternalfreetextfunctionholdlockidentitynationalreadtextrestrictrollbackrowcountshutdowntextsizetruncate clustered intersect openquery precision procedure raiserror writetext checkpoint constraint deallocate fillfactor openrowset references rowguidcol statistics updatetext distributed identitycol reconfigure replication system_user tablesample transaction current_date current_time current_user nonclustered session_user authorization containstable freetexttable securityauditopendatasourceidentity_insertcurrent_timestampc eZdZdZfddZZS)REALzthe SQL Server REAL datatype.c "|ddtjdi|dS)Nr setdefaultsuper__init__selfkw __class__r`/var/www/html/ecg_monitoring/venv/lib/python3.10/site-packages/sqlalchemy/dialects/mssql/base.pyr z REAL.__init____name__ __module__ __qualname____doc__r __classcell__rrrrrsrcr)DOUBLE_PRECISIONzMthe SQL Server DOUBLE PRECISION datatype. .. versionadded:: 2.0.11 c r)Nr5rrrrrrrrzDOUBLE_PRECISION.__init__rrrrrrsrc@eZdZdZdS)TINYINTNrrr__visit_name__rrrrrrc@s&eZdZddZedZddZdS)_MSDatecC dd}|S)NcS&t|tjkrt|j|j|jS|SNtypedatetimedateyearmonthdayvaluerrrprocessz'_MSDate.bind_processor..processrrdialectrrrrbind_processorz_MSDate.bind_processorz(\d+)-(\d+)-(\d+)cfdd}|S)NcXt|tjr |St|tr*j|}|std|ftjdd|DS|S)Nz"could not parse %r as a date valuecSg|]}t|pdqSrint.0xrrr z=_MSDate.result_processor..process..) isinstancerrstr_regmatch ValueErrorgroupsrmrrrr   z)_MSDate.result_processor..processrrrcoltyperrr1rresult_processor  z_MSDate.result_processorN)rrrrrecompiler+r5rrrrr s r csFeZdZd fdd ZedddZddZe dZ d d Z Z S) TIMENc s||_tdSr)rrr)rrkwargsrrrrsz TIME.__init__ilrcfdd}|S)Ncs>t|tjrtjj|}|St|tjr t|}|Sr)r)rcombine_TIME__zero_datetimer*rr1rrrs   z$TIME.bind_processor..processrrrr1rrr6zTIME.bind_processorz!(\d+):(\d+):(\d+)(?:\.(\d{0,6}))?cr)Ncr)Nz"could not parse %r as a time valuecSr r!r"r$rrrr'5r(z:TIME.result_processor..process..)r)rr>r*r+r,r-r.r/r1rrr,r2z&TIME.result_processor..processrr3rr1rr5+r6zTIME.result_processorr) rrrrrrr=rr7r8r+r5rrrrrr9s  r9c@r) _BASETIMEIMPLNrrrrrr??r r?c@eZdZddZdS) _DateTimeBasecCr )NcSr rrrrrrrErz-_DateTimeBase.bind_processor..processrrrrrrDrz_DateTimeBase.bind_processorN)rrrrrrrrrAC rAc@ eZdZdS) _MSDateTimeNrrrrrrrrDNrDc@r) SMALLDATETIMENrrrrrrGRr rGc"eZdZdZdfdd ZZS) DATETIME2Nc tjdi|||_dSNrrrrrrrrrrrY zDATETIME2.__init__rrrrr rrrrrrrIVrIcrH)DATETIMEOFFSETNc rJrKrLrMrrrrarNzDATETIMEOFFSET.__init__rrOrrrrrQ^rPrQc@r@)_UnicodeLiteralcr;)Ncs(|dd}jjr|dd}d|S)N'''%z%%zN'%s')replaceidentifier_preparer_double_percentsrrrrrhs  z2_UnicodeLiteral.literal_processor..processrrrrYrliteral_processorgs z!_UnicodeLiteral.literal_processorN)rrrrZrrrrrRfrBrRc@rC) _MSUnicodeNrErrrrr[srFr[c@rC)_MSUnicodeTextNrErrrrr\wrFr\cs2eZdZdZdZdZdddZfddZZS) TIMESTAMPaBImplement the SQL Server TIMESTAMP type. Note this is **completely different** than the SQL Standard TIMESTAMP type, which is not supported by SQL Server. It is a read-only datatype that does not support INSERT of values. .. versionadded:: 1.2 .. seealso:: :class:`_mssql.ROWVERSION` NFcCs ||_dS)zConstruct a TIMESTAMP or ROWVERSION type. :param convert_int: if True, binary integer values will be converted to integers on read. .. versionadded:: 1.2 N) convert_int)rr^rrrrs zTIMESTAMP.__init__cs(t|||jrfdd}|SS)Ncs*r|}|durtt|dd}|S)Nhex)r#codecsencodersuper_rrrs z+TIMESTAMP.result_processor..process)rr5r^r3rrcrr5s  zTIMESTAMP.result_processorF) rrrrr lengthrr5rrrrrr]{s   r]c@eZdZdZdZdS) ROWVERSIONa(Implement the SQL Server ROWVERSION type. The ROWVERSION datatype is a SQL Server synonym for the TIMESTAMP datatype, however current SQL Server documentation suggests using ROWVERSION for new datatypes going forward. The ROWVERSION datatype does **not** reflect (e.g. introspect) from the database as itself; the returned datatype will be :class:`_mssql.TIMESTAMP`. This is a read-only datatype that does not support INSERT of values. .. versionadded:: 1.2 .. seealso:: :class:`_mssql.TIMESTAMP` Nrrrrr rrrrrhsrhc@rg)NTEXTzMMSSQL NTEXT type, for variable-length unicode text up to 2^30 characters.Nrirrrrrjsrjcs&eZdZdZdZdfdd ZZS) VARBINARYaLThe MSSQL VARBINARY type. This type adds additional features to the core :class:`_types.VARBINARY` type, including "deprecate_large_types" mode where either ``VARBINARY(max)`` or IMAGE is rendered, as well as the SQL Server ``FILESTREAM`` option. .. seealso:: :ref:`mssql_large_type_deprecation` NFcs.||_|jr|dvrtdtj|ddS)a Construct a VARBINARY type. :param length: optional, a length for the column for use in DDL statements, for those binary types that accept a length, such as the MySQL BLOB type. :param filestream=False: if True, renders the ``FILESTREAM`` keyword in the table definition. In this case ``length`` must be ``None`` or ``'max'``. .. versionadded:: 1.4.31 )Nmaxz4length must be None or 'max' when setting filestreamrfN) filestreamr-rr)rrfrnrrrrs zVARBINARY.__init__)NF)rrrrr rrrrrrrks rkc@r)IMAGENrrrrrror roc@rg)XMLaMSSQL XML type. This is a placeholder type for reflection purposes that does not include any Python-side datatype support. It also does not currently support additional arguments, such as "CONTENT", "DOCUMENT", "xml_schema_collection". Nrirrrrrps rpc@rg)BITzMSSQL BIT type. Both pyodbc and pymssql return values from BIT columns as Python so just subclass Boolean. Nrirrrrrqsrqc@r)MONEYNrrrrrrrr rrc@r) SMALLMONEYNrrrrrrsr rsc@seZdZddZddZdS)MSUUidcCs(|jrdS|jrdd}|Sdd}|S)NcSs|dur|j}|Srr_rrrrrsz&MSUUid.bind_processor..processcSs |dur|dddd}|S)N-rTrSrVrrrrr's native_uuidas_uuidrrrrrszMSUUid.bind_processorcCs0|jr dd}|S|jrdd}|Sdd}|S)NcSsdt|dddS)NrSrT)r*rVrrrrr1sz)MSUUid.literal_processor..processcSsd|jdS)NrSrurrrrr8scSsd|dddddS)NrSrvrwrTrxrrrrr>sryrrrrrZ.szMSUUid.literal_processorN)rrrrrZrrrrrts rtc@s@eZdZdZe ddddZe ddd dZddd dZdS)UNIQUEIDENTIFIER.rUNIQUEIDENTIFIER[_python_UUID]r{ Literal[True]cCdSrrrr{rrrrIzUNIQUEIDENTIFIER.__init__UNIQUEIDENTIFIER[str]Literal[False]cCrrrrrrrrNrTboolcCs||_d|_dS)aConstruct a :class:`_mssql.UNIQUEIDENTIFIER` type. :param as_uuid=True: if True, values will be interpreted as Python uuid objects, converting to/from string via the DBAPI. .. versionchanged: 2.0 Added direct "uuid" support to the :class:`_mssql.UNIQUEIDENTIFIER` datatype; uuid interpretation defaults to ``True``. TN)r{rzrrrrrSs N).)rr}r{r~)rrr{r)T)r{r)rrrr rrrrrrr|Fsr|c@r) SQL_VARIANTNrrrrrrdr rr#bigintsmallinttinyintvarcharnvarcharcharncharrntextdecimalnumericfloatr datetime2datetimeoffsetr)r> smalldatetimebinary varbinarybitrealzdouble precisionimagexml timestampmoney smallmoneyuniqueidentifier sql_variantcs.eZdZdHddZddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ ddZ ddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3Zd4d5Zd6d7Zd8d9Zd:d;Zdd?Z!d@dAZ"fdBdCZ#dDdEZ$dFdGZ%Z&S)IMSTypeCompilerNcCsNt|ddr d|j}nd}|s|j}|r|d|}ddd||fDS)zYExtend a string-type declaration with standard SQL COLLATE annotations. collationNz COLLATE %s(%s) cSsg|]}|dur|qSrrr%crrrr'r(z*MSTypeCompiler._extend..)getattrrrfrc)rspectype_rfrrrr_extends   zMSTypeCompiler._extendcK|j|fi|Sr)visit_DOUBLE_PRECISIONrrrrrr visit_doublezMSTypeCompiler.visit_doublecKs$t|dd}|dur dSdd|iS)Nrr)zFLOAT(%(precision)s)rrrrrrrr visit_FLOATs  zMSTypeCompiler.visit_FLOATcKdS)Nrrrrrr visit_TINYINTzMSTypeCompiler.visit_TINYINTcK t|dd}|durd|SdS)NrzTIME(%s)r9rrrrr visit_TIME zMSTypeCompiler.visit_TIMEcKr)Nr]rrrrrvisit_TIMESTAMPrzMSTypeCompiler.visit_TIMESTAMPcKr)Nrhrrrrrvisit_ROWVERSIONrzMSTypeCompiler.visit_ROWVERSIONcKs*|jr |j|fi|S|j|fi|Sr)timezonevisit_DATETIMEOFFSETvisit_DATETIMErrrrvisit_datetimeszMSTypeCompiler.visit_datetimecKs"t|dd}|durd|jSdS)NrzDATETIMEOFFSET(%s)rQ)rrrrrrrs  z#MSTypeCompiler.visit_DATETIMEOFFSETcKr)Nrz DATETIME2(%s)rIrrrrrvisit_DATETIME2rzMSTypeCompiler.visit_DATETIME2cKr)NrGrrrrrvisit_SMALLDATETIMErz"MSTypeCompiler.visit_SMALLDATETIMEcKrr)visit_NVARCHARrrrr visit_unicoderzMSTypeCompiler.visit_unicodecK,|jjr |j|fi|S|j|fi|Sr)rdeprecate_large_types visit_VARCHAR visit_TEXTrrrr visit_textzMSTypeCompiler.visit_textcKrr)rrr visit_NTEXTrrrrvisit_unicode_textrz!MSTypeCompiler.visit_unicode_textcK |d|S)Nrjrrrrrr zMSTypeCompiler.visit_NTEXTcKr)Nr/rrrrrrrzMSTypeCompiler.visit_TEXTcK|jd||jpddS)Nr0rlrmrrfrrrrrzMSTypeCompiler.visit_VARCHARcKr)Nr%rrrrr visit_CHARrzMSTypeCompiler.visit_CHARcKr)Nr+rrrrr visit_NCHARrzMSTypeCompiler.visit_NCHARcKrNr-rlrmrrrrrrrzMSTypeCompiler.visit_NVARCHARcK0|jjtkr|j|fi|S|j|fi|Sr)rserver_version_infoMS_2008_VERSIONr visit_DATErrrr visit_date  zMSTypeCompiler.visit_datecKrr) visit_timerrrrvisit__BASETIMEIMPLrz"MSTypeCompiler.visit__BASETIMEIMPLcKrr)rrrrrrrrrrrzMSTypeCompiler.visit_timecKrr)rrvisit_VARBINARY visit_IMAGErrrrvisit_large_binaryrz!MSTypeCompiler.visit_large_binarycKr)NrorrrrrrrzMSTypeCompiler.visit_IMAGEcKr)Nrprrrrr visit_XML!rzMSTypeCompiler.visit_XMLcKs.|jd||jpdd}t|ddr|d7}|S)NrkrlrmrnFz FILESTREAM)rrfr)rrrrrrrr$s zMSTypeCompiler.visit_VARBINARYcKs ||Sr) visit_BITrrrr visit_boolean* zMSTypeCompiler.visit_booleancKr)Nrqrrrrrr-rzMSTypeCompiler.visit_BITcKs|jd|ddSrrrrrr visit_JSON0szMSTypeCompiler.visit_JSONcKr)Nrrrrrrr visit_MONEY5rzMSTypeCompiler.visit_MONEYcKr)Nrsrrrrrvisit_SMALLMONEY8rzMSTypeCompiler.visit_SMALLMONEYc s,|jr |j|fi|Stj|fi|Sr)rzvisit_UNIQUEIDENTIFIERr visit_uuidrrrrr;szMSTypeCompiler.visit_uuidcKr)Nr|rrrrrrArz%MSTypeCompiler.visit_UNIQUEIDENTIFIERcKr)Nrrrrrrvisit_SQL_VARIANTDrz MSTypeCompiler.visit_SQL_VARIANTr)'rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrsH  rcsbeZdZUdZdZdZded<ddZddZd d Z d d Z d dZ ddZ fddZ ZS)MSExecutionContextFN MSDialectrcCs*|jr|jjr|jjj}|||jj}|Sr)compiledschema_translate_mappreparer_render_schema_translates)r statementrstrrr _opt_encodeOs zMSExecutionContext._opt_encodec Cs|jr|trt|js Jt|jjtsJt|jjjtsJ|jjj}|j }|durJt|j t sJd}|jj }|j |jdvpG|joG|j |jv|_nd}d|_|jj ob|ob|jj ob|j ob|j |_|jr~|j|j|d|j|d|dSdSdS)z#Activate IDENTITY_INSERT if needed.NTrFzSET IDENTITY_INSERT %s ONr)isinsertrr rr) compile_stater4 dml_tabler5_autoincrement_columnrrdml_compile_staterMcompiled_parameters_dict_parameters_insert_col_keys_enable_identity_insertinlineeffective_returning executemany_select_lastrowidroot_connection_cursor_executerrrW format_table)rtbl id_columninsert_has_identityrrrrpre_execVsV      #zMSExecutionContext.pre_execc Cs$|j}|js |js |jr|jj|_|jr>|jj r"| |jdd|n | |jdd||j d}t |d|_ tj|_n|jdurZt|jrZ|jjrZt|j|jj|j |_|jrtryt|jsfJt|jjtsoJt|jjjtsyJ| |j|d|j|jjjd|dSdS)z#Disable IDENTITY_INSERT if enabled.z$SELECT scope_identity() AS lastrowidrzSELECT @@identity AS lastrowidrNSET IDENTITY_INSERT %s OFF) rrisupdateisdeleterr _rowcountrruse_scope_identityrfetchallr# _lastrowid_cursor_NO_CURSOR_DMLcursor_fetch_strategyrr r FullyBufferedCursorFetchStrategy descriptionrrr)rr4rr5rrWr)rconnrowrrr post_execs`     zMSExecutionContext.post_execcCs|jSr)r r1rrr get_lastrowidsz MSExecutionContext.get_lastrowidcCsJ|jr#z|j|d|j|jjjWdSt y"YdSwdS)Nr) rrrrrWrrrr Exception)rerrrhandle_dbapi_exceptions z)MSExecutionContext.handle_dbapi_exceptioncCs|d|j||S)NzSELECT NEXT VALUE FOR %s)_execute_scalarrWformat_sequence)rseqrrrr fire_sequences  z MSExecutionContext.fire_sequencecs>t|tjr||jjurt|jtjr|jjrdSt |Sr) r) sa_schemaColumnrrrroptionalrget_insert_default)rrrrrrs    z%MSExecutionContext.get_insert_default)rrrrrr __annotations__rrrrrrrrrrrrrHs 19 rcseZdZdZeejjdddddZfddZ fd d Z fd d Z d dZ ddZ ddZddZddZddZddZddZddZdd Zfd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Ze defd6d7 Z e fd8d9Z!e dffd;d< Z"d=d>Z#d?d@Z$dAdBZ%dCdDZ&fdEdFZ'dGdHZ(dIdJZ)fdKdLZ*dMdNZ+dOdPZ,dQdRZ-dSdTZ.dUdVZ/dWdXZ0dYdZZ1d[d\Z2d]d^Z3d_d`Z4dadbZ5dcddZ6Z7S)g MSSQLCompilerT dayofyearweekday millisecond microsecond)doydow milliseconds microsecondscsi|_tj|i|dSr) tablealiasesrr)rargsr:rrrrszMSSQLCompiler.__init__c sd|d<tj|fi|S)NTliteral_execute)r_format_frame_clause)rrange_rrrrr,sz"MSSQLCompiler._format_frame_clausecsfdd}|S)Ncs>|jjr|g|Ri|Sttt|j}||i|Sr)rlegacy_schema_aliasingrrr r)rargrrd)rfnrrdecoratesz.decorater)r0r1rr0r_with_legacy_schema_aliasingsz*MSSQLCompiler._with_legacy_schema_aliasingcKr)NCURRENT_TIMESTAMPrrr0rrrrvisit_now_funcrzMSSQLCompiler.visit_now_funccKr)Nz GETDATE()rr5rrrvisit_current_date_funcrz%MSSQLCompiler.visit_current_date_funccKd|j|fi|SNzLEN%sfunction_argspecr5rrrvisit_length_func rzMSSQLCompiler.visit_length_funccKr8r9r:r5rrrvisit_char_length_func rz$MSSQLCompiler.visit_char_length_funccKsN|jjdj|fi|}d|d<|jjdj|fi|}d|d|dS)NrTr+rz string_agg(, ))clauses_compiler_dispatch)rr0rexpr delimeterrrrvisit_aggregate_strings_funcsz*MSSQLCompiler.visit_aggregate_strings_funcc sdfdd|DS)Nz + c3s"|] }j|fiVqdSr)rr%elemrrrr s zFMSSQLCompiler.visit_concat_op_expression_clauselist..rc)r clauselistoperatorrrrGr%visit_concat_op_expression_clauselistsz3MSSQLCompiler.visit_concat_op_expression_clauselistcK,d|j|jfi||j|jfi|fS)Nz%s + %srrerrrrKrrrrvisit_concat_op_binaryz$MSSQLCompiler.visit_concat_op_binarycKr)N1rrrBrrrr visit_true!rzMSSQLCompiler.visit_truecKr)N0rrSrrr visit_false$rzMSSQLCompiler.visit_falsecKrM)NzCONTAINS (%s, %s)rNrOrrrvisit_match_op_binary'rQz#MSSQLCompiler.visit_match_op_binaryc s~tj|fi|}|jr=||r=d|d<|d|j||fi|7}|jdur=|jdr4|d7}|jdr=|d7}|S) z+MS-SQL puts TOP, it's version of LIMIT hereTr+zTOP %s NrzPERCENT with_tiesz WITH TIES )rget_select_precolumns_has_row_limiting_clause_use_topr_get_limit_or_fetch _fetch_clause_fetch_clause_options)rrrsrrrrY-s   z#MSSQLCompiler.get_select_precolumnscC|Srrrrrrrrget_from_hint_textBrz MSSQLCompiler.get_from_hint_textcCr`rrrarrrget_crud_hint_textErz MSSQLCompiler.get_crud_hint_textcCs|jdur|jS|jSr)r] _limit_clauserrrrrr\Hs z!MSSQLCompiler._get_limit_or_fetchcCs6|jduo||jp||jo|jdp|jdS)NrrX)_offset_clause_simple_int_clauserdr]r^rerrrr[Ns    zMSSQLCompiler._use_topcKrNrwr)rcsr:rrr limit_clause]rzMSSQLCompiler.limit_clausecCsB|jjs td|jdur|jds|jdrtddSdS)NzLMSSQL requires an order_by when using an OFFSET or a non-simple LIMIT clauserrXz^MSSQL needs TOP to use PERCENT and/or WITH TIES. Only simple fetch without offset can be used.)_order_by_clauser@r CompileErrorr^rerrr_check_can_use_fetch_limit`s z(MSSQLCompiler._check_can_use_fetch_limitcKs>|jjr||s|||j|f||dd|SdS)zdMSSQL 2012 supports OFFSET/FETCH operators Use it instead subquery with row_number T) fetch_clauserequire_offsetrw)r_supports_offset_fetchr[rmrnr\rrrrrr_row_limit_clausess zMSSQLCompiler._row_limit_clausecKs,d|j|jfi||j|jfi|fS)NzTRY_CAST (%s AS %s))rclause typeclause)relementrrrrvisit_try_castrQzMSSQLCompiler.visit_try_castc Ks|}|jrx|jjsx||sxt|ddsx||dd|jjD}||}|j }| }d|_ | t jj|ddd}t d}t jdd|jD}|duro|||k}|durm||||k}|S|||k}|S|S) zLook for ``LIMIT`` and OFFSET in a select statement, and if so tries to wrap it in a subquery with ``row_number()`` criterion. MSSQL 2012 and above are excluded _mssql_visitNcSsg|]}t|qSr)sql_utilunwrap_label_referencerErrrr'sz.T)order_bymssql_rncSsg|] }|jdkr|qS)r{)rMrrrrr's)rZrrpr[rrmrkr@r\rf _generaterw add_columnsrr ROW_NUMBERrjlabelrzaliasrrrr) r select_stmtr:r_order_by_clausesrj offset_clauser{ limitselectrrrtranslate_select_structuresP     z(MSSQLCompiler.translate_select_structureFc s\||us|rtj|fi|S||}|dur$|j|fd|i|Stj|fi|SN mssql_aliased)r visit_table_schema_aliased_tabler)rrriscrudr:rrrrrs  zMSSQLCompiler.visit_tablec s|j|d<tj|fi|Sr)rur visit_alias)rrrrrrrs zMSSQLCompiler.visit_aliasNc s|jdur |js |jr|r<||j}|dur.T)colszOUTPUT r>) is_insert is_updaterr is_deleterx ClauseAdapter_generate_columns_plus_namesr_select_iterablesrc)rrreturning_colsrrtargetcolumnsrrrreturning_clause s    zMSSQLCompiler.returning_clausecCr)NWITHr)r recursiverrrget_cte_preambleF szMSSQLCompiler.get_cte_preamblecs&t|tjr |dSt|||Sr)r)rFunctionrrlabel_select_column)rrrasfromrrrrM s  z!MSSQLCompiler.label_select_columncKrrhrrqrrrfor_update_clauseS rzMSSQLCompiler.for_update_clausecKsL|r||s|jdus|jjsdS|j|jfi|}|r$d|SdS)Nrwz ORDER BY )rr[_offsetrrprrk)rrrrzrrrorder_by_clauseX s zMSSQLCompiler.order_by_clausec &ddfdd|g|DS)aRender the UPDATE..FROM clause specific to MSSQL. In MSSQL, if the UPDATE statement involves an alias of the table to be updated, then the table itself must be added to the FROM list as well. Otherwise, it is optional. Here, we add it regardless. FROM r>c3(|]}|jfddVqdST)r fromhintsNrAr%r from_hintsrrrrrH{  z3MSSQLCompiler.update_from_clause..rI)r update_stmt from_table extra_fromsrrrrrupdate_from_clauseq s  z MSSQLCompiler.update_from_clausecKs&d}|rd}|j|fdd|d|S)z=If we have extra froms make sure we render any alias as hint.FT)rrashintr)r delete_stmtrrrrrrrdelete_table_clause sz!MSSQLCompiler.delete_table_clausec r)zjRender the DELETE .. FROM clause specific to MSSQL. Yes, it has the FROM keyword twice. rr>c3rrrrrrrrH rz9MSSQLCompiler.delete_extra_from_clause..rI)rrrrrrrrrdelete_extra_from_clause s z&MSSQLCompiler.delete_extra_from_clausecKr)NzSELECT 1 WHERE 1!=1rrrrrvisit_empty_set_expr rz"MSSQLCompiler.visit_empty_set_exprcKd||j||jfS)Nz*NOT EXISTS (SELECT %s INTERSECT SELECT %s)rNrOrrrvisit_is_distinct_from_binary   z+MSSQLCompiler.visit_is_distinct_from_binarycKr)Nz&EXISTS (SELECT %s INTERSECT SELECT %s)rNrOrrr!visit_is_not_distinct_from_binary rz/MSSQLCompiler.visit_is_not_distinct_from_binarycKs|jjtjurd|j|jfi||j|jfi|fSd|j|jfi||j|jfi|f}|jjtjurQd|j|jfi||j|jfi|f}nn|jjtjurd|j|jfi||j|jfi|t |jtj rtdn d|jj |jj ff}n>|jjtj urd}n4|jjtjurd|j|jfi||j|jfi|f}nd |j|jfi||j|jfi|f}|d |d S) NzJSON_QUERY(%s, %s)z+CASE JSON_VALUE(%s, %s) WHEN NULL THEN NULLz(ELSE CAST(JSON_VALUE(%s, %s) AS INTEGER)z#ELSE CAST(JSON_VALUE(%s, %s) AS %s)r)zNUMERIC(%s, %s)z0WHEN 'true' THEN 1 WHEN 'false' THEN 0 ELSE NULLzELSE JSON_VALUE(%s, %s)zELSE JSON_QUERY(%s, %s)rz END)r_type_affinityrrrrerIntegerNumericr)FloatrscaleBooleanString)rrrKrcase_expressiontype_expressionrrr _render_json_extract_from_binary sJ  z.MSSQLCompiler._render_json_extract_from_binarycK|j||fi|SrrrOrrrvisit_json_getitem_op_binary z*MSSQLCompiler.visit_json_getitem_op_binarycKrrrrOrrr!visit_json_path_getitem_op_binary rz/MSSQLCompiler.visit_json_path_getitem_op_binarycKr)NzNEXT VALUE FOR %s)rr)rrrrrrvisit_sequence szMSSQLCompiler.visit_sequence)FFr)8rrrreturning_precedes_valuesr update_copyr SQLCompilerrrr,r3r6r7r<r=rDrLrPrTrVrWrYrbrcr\r[rjrmrrrvrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr sv    4  3   8r cs4eZdZdZdZddZddZfddZZS) MSSQLStrictCompilerzA subclass of MSSQLCompiler which disables the usage of bind parameters where not allowed natively by MS-SQL. A dialect may use this compiler on a platform where native binds are used. TcK4d|d<d|j|jfi||j|jfi|fS)NTr+z%s IN %srNrOrrrvisit_in_op_binary z&MSSQLStrictCompiler.visit_in_op_binarycKr)NTr+z %s NOT IN %srNrOrrrvisit_not_in_op_binary rz*MSSQLStrictCompiler.visit_not_in_op_binarycs.tt|tjrdt|dSt||S)a5 For date and datetime values, convert to a string format acceptable to MSSQL. That seems to be the so-called ODBC canonical date format which looks like this: yyyy-mm-dd hh:mi:ss.mmm(24h) For other data types, call the base class implementation. rS) issubclassrrrr*rrender_literal_value)rrrrrrr s z(MSSQLStrictCompiler.render_literal_value) rrrransi_bind_rulesrrrrrrrrr s rcsveZdZddZdddZddZdd Zd d Zd d ZddZ ddZ ddZ ddZ fddZ ddZZS) MSDDLCompilercKsz|j|}|jdur|d||j7}n|d|jjj|j|d7}|jdurL|jr>|js>t |j t j s>|j dus>|jrC|d7}n |jdurL|d7}|jdurVtd|jd}|d}|d }|dusk|dury|jrstd td d |jr||j|jfi|7}|S||jjus|j durt |j t r|j jr||t||d 7}|S||}|dur|d|7}|S)Nr)rTz NOT NULLz NULLz;mssql requires Table-bound columns in order to generate DDLmssqlidentity_startidentity_incrementzzCannot specify options 'mssql_identity_start' and/or 'mssql_identity_increment' while also using the 'Identity' construct.z|The dialect options 'mssql_identity_start' and 'mssql_identity_increment' are deprecated. Use the 'Identity' object instead.1.4start incrementz DEFAULT )r format_columncomputedrrtype_compiler_instancernullable primary_keyr)rrr autoincrementrrr rldialect_optionsrwarn_deprecatedrrr get_column_default_string)rrr:colspecd_optrrrrrrget_column_specification sd              z&MSDDLCompiler.get_column_specificationFc  sP|jjd}jr|d7}jdd}|dur*|r&|d7}n|d7}jdd}|r7|d7}|d j|d jf7}tj d kr`|d d fddj D7}jddrfddjddD}|dd fdd|D7}jdd}|durt t j|}jj|ddd} |d| 7}|S)NzCREATE zUNIQUE rr CLUSTERED NONCLUSTERED columnstorez COLUMNSTORE zINDEX %s ON %sinclude_schemarz (%s)r>c3s"|] }jj|dddVqdS)FT include_table literal_bindsN) sql_compilerr)r%rBr1rrrHo s z3MSDDLCompiler.visit_create_index..includecs&g|]}t|trjj|n|qSr)r)r*rr)r%col)rrrr'x sz4MSDDLCompiler.visit_create_index..z INCLUDE (%s)csg|]}|jqSr)quoterr)rrrr'~ r(rFTrz WHERE )ru_verify_index_tablerrr_prepared_index_namerrlen expressionsrcrexpectrDDLExpressionRolerr) rrrrrrr  inclusions whereclausewhere_compiledr)rrrrvisit_create_indexS sN        z MSDDLCompiler.visit_create_indexcKs$d|j|jdd|j|jjfS)Nz DROP INDEX %s ON %sFr)rrurrr)rrYrrrrvisit_drop_index szMSDDLCompiler.visit_drop_indexc st|dkrdSd}|jdur|dj|7}|d7}|jdd}|dur3|r/|d7}n|d7}|d d fd d |D7}||7}|S) NrrwCONSTRAINT %s z PRIMARY KEY rrr r rr>c3|] }j|jVqdSrrrrrr1rrrH  z=MSDDLCompiler.visit_primary_key_constraint..)rrrformat_constraintrrcdefine_constraint_deferrability)rrrrrrr1rvisit_primary_key_constraint s$     z*MSDDLCompiler.visit_primary_key_constraintc st|dkrdSd}|jdurj|}|dur|d|7}|dj|fi|7}|jdd}|durB|r>|d7}n|d7}|d d fd d |D7}||7}|S) Nrrwr"z UNIQUE %srrr r rr>c3r#rr$rr1rrrH r%z8MSDDLCompiler.visit_unique_constraint..)rrrr&!define_unique_constraint_distinctrrcr')rrrrformatted_namerrr1rvisit_unique_constraint s,       z%MSDDLCompiler.visit_unique_constraintcKs.d|jj|jddd}|jdur|d7}|S)NzAS (%s)FTrz PERSISTED)rrsqltext persisted)r generatedrrrrrvisit_computed_column s  z#MSDDLCompiler.visit_computed_columncKsT|j|j}|r |n|jj}d|j|jjt |j ||jj |jddS)NzNexecute sp_addextendedproperty 'MS_Description', {}, 'schema', {}, 'table', {}F use_schema) rschema_for_objectrurdefault_schema_nameformatrrcommentrr- quote_schemarrrrr schema_namerrrvisit_set_table_comment s  z%MSDDLCompiler.visit_set_table_commentcKs@|j|j}|r |n|jj}d|j||jj|jddS)NzKexecute sp_dropextendedproperty 'MS_Description', 'schema', {}, 'table', {}Fr0)rr2rurr3r4r6rrrYrrr8rrrvisit_drop_table_comment s z&MSDDLCompiler.visit_drop_table_commentcKsd|j|jj}|r |n|jj}d|j|jj t |j ||jj |jjdd|j|jS)Nz\execute sp_addextendedproperty 'MS_Description', {}, 'schema', {}, 'table', {}, 'column', {}Fr0)rr2rurrr3r4rrr5rr-r6rrr7rrrvisit_set_column_comment s   z&MSDDLCompiler.visit_set_column_commentcKsP|j|jj}|r |n|jj}d|j||jj|jjdd|j |jS)NzYexecute sp_dropextendedproperty 'MS_Description', 'schema', {}, 'table', {}, 'column', {}Fr0) rr2rurrr3r4r6rrr:rrrvisit_drop_column_comment s  z'MSDDLCompiler.visit_drop_column_commentc s@d}|jjdur|jj}d|j|}tj|fd|i|S)Nz AS %sprefix)ru data_type type_compilerrrvisit_create_sequence)rrrr>r?rrrrA s  z#MSDDLCompiler.visit_create_sequencecKsTd}|jdus |jdur(|jdurdn|j}|jdurdn|j}|d||f7}|S)Nz IDENTITYrz(%s,%s)r)rrrrrrrrrvisit_identity_column s z#MSDDLCompiler.visit_identity_columnre)rrrr r r!r(r+r/r9r;r<r=rArBrrrrrr s ?<   rcs:eZdZeZfddZddZddZd dd ZZ S) MSIdentifierPreparercstj|dddddS)N[]F) initial_quote final_quotequote_case_sensitive_collations)rr)rrrrrr s  zMSIdentifierPreparer.__init__cC |ddS)NrE]]rxrrrrr_escape_identifier rz'MSIdentifierPreparer._escape_identifiercCrI)NrJrErxrKrrr_unescape_identifier# rz)MSIdentifierPreparer._unescape_identifierNcCs\|dur tjdddt|\}}|r!d||||f}|S|r*||}|Sd}|S)z'Prepare a quoted table and schema name.NzThe IdentifierPreparer.quote_schema.force parameter is deprecated and will be removed in a future release. This flag has no effect on the behavior of the IdentifierPreparer.quote method; please refer to quoted_name().z1.3)versionz%s.%srw)rr_schema_elementsr)rrforcedbnameownerresultrrrr6& s  z!MSIdentifierPreparer.quote_schemar) rrrRESERVED_WORDSreserved_wordsrrLrMr6rrrrrrC s  rCcdfdd }t|S)Nc s,t||\}}t|||||||fi|Sr_owner_plus_db _switch_db)r connectionrrrQrRr2rrwrapB s z$_db_plus_owner_listing..wraprr1r0r[rr2r_db_plus_owner_listingA s r]crV)Nc s.t||\}}t||||||||f i|SrrW)rrZ tablenamerrrQrRr2rrr[T s z_db_plus_owner..wraprr1r\rr2r_db_plus_ownerS s r_c Os|r|d}||kr|d|jj|z||i|W|r4||kr5|d|jj|SSS|rI||krJ|d|jj|www)Nzselect db_name()zuse %s)exec_driver_sqlscalarrrWr)rQrZr0r/r current_dbrrrrYf s*   rYcCs|sd|jfSt|Sr)r3rO)rrrrrrXw s rXcCs\t|tr |jr d|fS|tvrt|S|drd|fSg}d}d}d}td|D]3}|s0q+|dkr9d}d}q+|dkr@d}q+|sZ|dkrZ|rP|d |n||d}d}q+||7}q+|rf||t|d krd |d d |d }}t d |d d rt|dd}n| d d}nt|rd|d }}nd\}}||ft|<||fS)Nz __[SCHEMA_rwFz (\[|\]|\.)rDTrE.z[%s]rrz .*\].*\[.*r)NN) r)rr_memoized_schema startswithr7splitappendrrcr,lstriprstrip)rpushsymbolbracket has_bracketstokenrQrRrrrrO sJ       rOcseZdZdZdZdZdZdZdZdZ dZ e Z dZ dZdZdZdZdZdZdZejeejeejeejjeejjeejeeje ej!e"e#e#e$e$e%e%e&e&ej'e(i Z)e*j+j,-de.j/iZ,e0Z0dZ1dZ2dZ3dZ4dZ5dZ6dZ7dZ8dZ9dZ:e;jBZ?dZ@dZAdZBdZCd ZDeEZFeGZHeIZJeKZLeMjNd d ifeMjOd d ifeMjPd d d d d feMjQd d d fgZR   dGfdd ZSfddZTddZUfddZVhdZWddZXddZYddZZfddZ[dd Z\d!d"Z]d#d$Z^d%d&Z_e`d'd(Zaebjce`d)d*Zdebjceed+d,Zfebjcd-d.Zgebjceed/d0Zhebjceed1d2Ziebjcd3d4Zjd5d6Zkebjce`d7d8Zlebjce`d9d:ZmebjcdHd;d<Znd=d>Zod?d@Zpebjce`dAdBZqebjce`dCdDZrebjce`dEdFZsZtS)IrrTFdbor.ri3rrN)rrrr )rrc  szt|pd|_||_||_||_| |_||_} | dur| |_|dur,t dd||_ t j di| ||_ ||_dS)Nrz[The legacy_schema_aliasing parameter is deprecated and will be removed in a future release.rr)r# query_timeoutr8rr!ignore_no_transaction_on_rollback_user_defined_supports_commentssupports_commentsrrr.rr_json_serializer_json_deserializer) rrsrr8rrvjson_serializerjson_deserializerr.rtoptsudsrrrr/ s$   zMSDialect.__init__cs|dt||dS)Nz$IF @@TRANCOUNT = 0 BEGIN TRANSACTION)r`r do_savepointrrZrrrrr}U s zMSDialect.do_savepointcCrrrr~rrrdo_release_savepointZ szMSDialect.do_release_savepointc sbz t|WdS|jjy0}z|jr$tdt|r$t dnWYd}~dSd}~ww)Nz .*\b111214\bz|ProgrammingError 111214 'No corresponding transaction found.' has been suppressed via ignore_no_transaction_on_rollback=True) r do_rollbackdbapiProgrammingErrorrtr7r,r*rwarn)rdbapi_connectionrrrrr^ s zMSDialect.do_rollback>READ COMMITTEDREPEATABLE READREAD UNCOMMITTEDSNAPSHOT SERIALIZABLEcCs t|jSr)list_isolation_lookup)rrrrrget_isolation_level_valuesv rz$MSDialect.get_isolation_level_valuescCs8|}|d|||dkr|dSdS)Nz SET TRANSACTION ISOLATION LEVEL r)rrr{r)rrlevelrrrrset_isolation_levely s  zMSDialect.set_isolation_levelc Cs|}d}zJz#|d||}|stdd|d}|d|Wn|jjyA}z td|||d}~ww|}|dW|S|w)Nzsys.system_viewszTSELECT name FROM {} WHERE name IN ('dm_exec_sessions', 'dm_pdw_nodes_exec_sessions')zBCan't fetch isolation level on this particular SQL Server version.zsys.ra SELECT CASE transaction_isolation_level WHEN 0 THEN NULL WHEN 1 THEN 'READ UNCOMMITTED' WHEN 2 THEN 'READ COMMITTED' WHEN 3 THEN 'REPEATABLE READ' WHEN 4 THEN 'SERIALIZABLE' WHEN 5 THEN 'SNAPSHOT' END AS TRANSACTION_ISOLATION_LEVEL FROM {} where session_id = @@SPID zZCan't fetch isolation level; encountered error {} when attempting to query the "{}" view.) rrr4fetchoneNotImplementedErrorrErrorupperr{)rrr view_namererrrrrget_isolation_level s>  zMSDialect.get_isolation_levelcs,t||||||dSr)r initialize_setup_version_attributes_setup_supports_nvarchar_max_setup_supports_commentsrrZrrrr s  zMSDialect.initializecCs|jdttddvrtdddd|jD|jtkr%d|_nd |_|jdur3|jt k|_|jo<|jdd k|_ dS) Nrr<z[Unrecognized server version info '%s'. Some SQL Server features may not function properly.rccss|]}t|VqdSr)r*r$rrrrH sz6MSDialect._setup_version_attributes..TFr9) rrrangerrrcrsupports_multivalues_insertrMS_2012_VERSIONrpr1rrrr s  z#MSDialect._setup_version_attributescCs<z |tdWntjyd|_YdSwd|_dS)Nz0SELECT CAST('test max support' AS NVARCHAR(max))FT)rarrr DBAPIError_supports_nvarchar_maxrrrrr s  z&MSDialect._setup_supports_nvarchar_maxcCsJ|jdurdSz |tdWntjyd|_YdSwd|_dS)NzdSELECT 1 FROM fn_listextendedproperty(default, default, default, default, default, default, default)FT)rurarrr rrvrrrrr s   z"MSDialect._setup_supports_commentscCs.td}||}|durt|ddS|jS)NzSELECT schema_name()Tre)rrrarr8)rrZqueryr3rrr_get_default_schema_name s   z"MSDialect._get_default_schema_namecKs |||j|||fi|Sr)_ensure_has_table_connection_internal_has_table)rrZr^rQrRrrrrr has_table s zMSDialect.has_tablec KsNtj}t|jj|jj|k}|r||jj|k}||} | duSr) ischema sequencesrrr sequence_namersequence_schemarfirst) rrZ sequencenamerQrRrrrr_rrrr has_sequence s   zMSDialect.has_sequencec KsBtj}t|jj}|r||jj|k}||}dd|DS)NcSg|]}|dqSr!r)r%rrrrr' z0MSDialect.get_sequence_names..) rrrrrrrrr) rrZrQrRrrrr_rrrrget_sequence_names s  zMSDialect.get_sequence_namescKs4ttjjjtjjj}dd||D}|S)NcSrr!rr%rrrrr' rz.MSDialect.get_schema_names..)rrrschematarr8rzr)rrZrr_ schema_namesrrrget_schema_names s zMSDialect.get_schema_namesc KTtj}t|jjt|jj|k|jj dk |jj}dd| |D}|S)N BASE TABLEcSrr!rrrrrr'* rz-MSDialect.get_table_names.. rtablesrrr table_namerand_ table_schema table_typerzr) rrZrQrRrrrr_ table_namesrrrget_table_names      zMSDialect.get_table_namesc Kr)NVIEWcSrr!rrrrrr'; rz,MSDialect.get_view_names..r) rrZrQrRrrrr_ view_namesrrrget_view_names- rzMSDialect.get_view_namesc Ks|drt|tddd|diStj}t|jj  t t |jj dk|jj dk|jj |k}|rA| |jj|k}||}|duS)N#z"SELECT object_id(:table_name, 'U')rz tempdb.dbo.[rErr)rgrrarrrrrrrrror_rrrr)rrZr^rRrrr_rrrrr> s*       zMSDialect._internal_has_tablecKs0|j|||fi|r|St|d|)Nrc)rr NoSuchTableError)rrZr^rRmethodrrrr_default_or_error^ szMSDialect._default_or_errorc Ks|jtkrdnd}|jddtd|dtd|t td|t j t d }i} | D]B} | d | d d kggid | | d<} | d} | d} | dvr_| d k| d<| dvrm| dk| d<d| d<| ddury| d| d<q7|jddtdtd|t td|t j t d }| D]:} | d| vrq| | d}|dd}|dd}|r|s| dr|s|d| d q|d| d q| D] }|d|dd<q| rt| S|j|||tjfi|S)Nzind.filter_definitionzNULL as filter_definitionT future_resultzM select ind.index_id, ind.is_unique, ind.name, ind.type, a+ from sys.indexes as ind join sys.tables as tab on ind.object_id = tab.object_id join sys.schemas as sch on sch.schema_id = tab.schema_id where tab.name = :tabname and sch.name = :schname and ind.is_primary_key = 0 and ind.type != 0 order by ind.name tabnameschname)rr is_uniquer)rr column_namesinclude_columnsrindex_idrr>rmssql_clustered>rmssql_columnstorefilter_definition mssql_wherea select ind_col.index_id, col.name, ind_col.is_included_column from sys.columns as col join sys.tables as tab on tab.object_id = col.object_id join sys.index_columns as ind_col on ind_col.column_id = col.column_id and ind_col.object_id = tab.object_id join sys.schemas as sch on sch.schema_id = tab.schema_id where tab.name = :tabname and sch.name = :schname is_included_columnrr mssql_include)rrexecution_optionsrrr bindparams bindparamr CoerceUnicoderrUnicodemappingsrrirrrrindexes)rrZr^rQrRrrrrprrrdo index_type index_def is_colstore is_clustered index_inforrr get_indexese s                zMSDialect.get_indexesc KsT|tdtd|ttd|t}|r |St |d|)Nzselect mod.definition from sys.sql_modules as mod join sys.views as views on mod.object_id = views.object_id join sys.schemas as sch on views.schema_id = sch.schema_id where views.name=:viewname and sch.name=:schnameviewnamerrc) rrrrrrrrar r)rrZrrQrRrrview_defrrrget_view_definition s  zMSDialect.get_view_definitionc Ks~|jstd|r |n|j}d}|t|td|t td|t  }|r2d|iS|j ||dt j fi|S)Nz=Can't get table comments on current SQL Server version in usez SELECT cast(com.value as nvarchar(max)) FROM fn_listextendedproperty('MS_Description', 'schema', :schema, 'table', :table, NULL, NULL ) as com; rrr)rvrr3rrrrrrrrarr table_comment)rrZrrrr8 COMMENT_SQLr5rrrget_table_comment s0 zMSDialect.get_table_commentcCs||ds dSdS)Nz##z [_][_][_]%rw)rg)rr^rrr_temp_table_name_like_pattern s  z'MSDialect._temp_table_name_like_patternc Csvz|tdd||iWStjy&}ztd||d}~wtjy:}zt d||d}~ww)Nz_select table_schema, table_name from tempdb.information_schema.tables where table_name like :p1p1zFound more than one temporary table named '%s' in tempdb at this time. Cannot reliably resolve that name to its internal table name.z6Unable to find a temporary table named '%s' in tempdb.) rrrroner MultipleResultsFoundUnreflectableTableError NoResultFoundr)rrZr^menerrr_get_internal_temp_table_names8 z'MSDialect._get_internal_temp_table_namec&Ks*|d}|r|||\}}tj}ntj}tj} tj} |r7t|j j |k|j j |k} |j j d|j j } n |j j |k} |j j } |j rI| j j } n t| j j td} t| }t|j j|j j|j j|j j|j j|j j|j j|j j| | j j| j j| j j| j jtjj j !d"|j#| t| j j|k| j j$|j j%dkdj#| t| j j|k| j j$|j j%dkdj#tjttjj ddktjj j&|ktjj j'|j j(ktjj j$d kd)| *|j j(}|j+d d ,|}g}|-D]}||j j}||j j}||j jd k}||j j}||j j}||j j}||j j}||j j}|| }|| j j}|| j j}|| j j}|| j j}|tjj j } |j./|d}!i}"|!t0t1t2t3t4t5t6t7t8j9f vrs|d krhd}||"d<|rs||"d<|!durt:;d||ft8j<}!nt=|!t8j>r||"d<t=|!t8j?s||"d<|!di|"}!||!|||du| d}#|dur|dur||d|#d<|dur|dus|duri|#d<n+t@|!t8jArtB|}$tB|}%nt@|!t8jCrtB|}$tB|}%n|}$|}%|$|%d|#d<|D|#q|r|S|jE|||tFjfi|S)Nrrcir5DATABASE_DEFAULT)onclauseclassrMS_DescriptionTrYESrdrfrz*Did not recognize type '%s' of column '%s'rr)rrrrrr5)r,r-rrrr)Grgrrmssql_temp_table_columnsrcomputed_columnsidentity_columnsrrrrrr definitioncastr-r object_idr column_namer? is_nullablecharacter_maximum_lengthnumeric_precision numeric_scalecolumn_defaultcollation_name is_persisted is_identity seed_valueincrement_valueextended_propertiesrr select_from outerjoinrrmajor_idminor_idordinal_positionrrzrrr ischema_namesrMSStringMSChar MSNVarcharMSNCharMSTextMSNTextMSBinary MSVarBinaryr LargeBinaryrrNULLTYPErrrr) BigIntegerr#rrirr)&rrZr^rQrRrr is_temp_tabler computed_cols identity_colsr full_namecomputed_definitionrr_rrrrrrcharlen numericprec numericscalerrrr r rrr5r4r:cdictrrrrr get_columns0s0           !  + 0                    zMSDialect.get_columnsc Ks<g}tj}tjd} t| jj|jj| jj t t | jj d| jj ddt|jj | jj k|jj | jj k| jj|k| jj |k|jj | jj} |jdd| } d} d} | D]%}d||jjjvr||d| dur~|| jj j} | dur|d} qa|r|| d | id S|j|||tjfi|S) NCrcCnstIsClustKeyrTrPRIMARY COLUMN_NAMEr)constrained_columnsrr)r constraintskey_constraintsrrrrrconstraint_typeconstraint_namerobjectpropertyrrrrrrrzrrrrrrirr pk_constraint)rrZr^rQrRrrpkeysTCr)r_rr1rrrrrget_pk_constraintsb     zMSDialect.get_pk_constraintc Ksdtdtd|ttd|tjttttttttd}g}dd} t | }| | D]Y} | \ } } } } }}}} }}|| }| |d<|dkrc||d d <|dkrm||d d <|d s||d <|dus}||kr|r|d |}||d<|d|d}}| | | |qC|rt|S|j|||tjfi|S)Na>WITH fk_info AS ( SELECT ischema_ref_con.constraint_schema, ischema_ref_con.constraint_name, ischema_key_col.ordinal_position, ischema_key_col.table_schema, ischema_key_col.table_name, ischema_ref_con.unique_constraint_schema, ischema_ref_con.unique_constraint_name, ischema_ref_con.match_option, ischema_ref_con.update_rule, ischema_ref_con.delete_rule, ischema_key_col.column_name AS constrained_column FROM INFORMATION_SCHEMA.REFERENTIAL_CONSTRAINTS ischema_ref_con INNER JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE ischema_key_col ON ischema_key_col.table_schema = ischema_ref_con.constraint_schema AND ischema_key_col.constraint_name = ischema_ref_con.constraint_name WHERE ischema_key_col.table_name = :tablename AND ischema_key_col.table_schema = :owner ), constraint_info AS ( SELECT ischema_key_col.constraint_schema, ischema_key_col.constraint_name, ischema_key_col.ordinal_position, ischema_key_col.table_schema, ischema_key_col.table_name, ischema_key_col.column_name FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE ischema_key_col ), index_info AS ( SELECT sys.schemas.name AS index_schema, sys.indexes.name AS index_name, sys.index_columns.key_ordinal AS ordinal_position, sys.schemas.name AS table_schema, sys.objects.name AS table_name, sys.columns.name AS column_name FROM sys.indexes INNER JOIN sys.objects ON sys.objects.object_id = sys.indexes.object_id INNER JOIN sys.schemas ON sys.schemas.schema_id = sys.objects.schema_id INNER JOIN sys.index_columns ON sys.index_columns.object_id = sys.objects.object_id AND sys.index_columns.index_id = sys.indexes.index_id INNER JOIN sys.columns ON sys.columns.object_id = sys.indexes.object_id AND sys.columns.column_id = sys.index_columns.column_id ) SELECT fk_info.constraint_schema, fk_info.constraint_name, fk_info.ordinal_position, fk_info.constrained_column, constraint_info.table_schema AS referred_table_schema, constraint_info.table_name AS referred_table_name, constraint_info.column_name AS referred_column, fk_info.match_option, fk_info.update_rule, fk_info.delete_rule FROM fk_info INNER JOIN constraint_info ON constraint_info.constraint_schema = fk_info.unique_constraint_schema AND constraint_info.constraint_name = fk_info.unique_constraint_name AND constraint_info.ordinal_position = fk_info.ordinal_position UNION SELECT fk_info.constraint_schema, fk_info.constraint_name, fk_info.ordinal_position, fk_info.constrained_column, index_info.table_schema AS referred_table_schema, index_info.table_name AS referred_table_name, index_info.column_name AS referred_column, fk_info.match_option, fk_info.update_rule, fk_info.delete_rule FROM fk_info INNER JOIN index_info ON index_info.index_schema = fk_info.unique_constraint_schema AND index_info.index_name = fk_info.unique_constraint_name AND index_info.ordinal_position = fk_info.ordinal_position ORDER BY fk_info.constraint_schema, fk_info.constraint_name, fk_info.ordinal_position r^rR)constraint_schemar1rrconstrained_columnreferred_table_schemareferred_table_namereferred_columncSsdgddgidS)N)rr-referred_schemareferred_tablereferred_columnsoptionsrrrrrfkey_recsz,MSDialect.get_foreign_keys..fkey_recrz NO ACTIONr?onupdateondeleter=rcr<r-r>)rrrrrrrrrr defaultdictrrGrirrrr foreign_keys)rrZr^rQrRrrr_fkeysr@r_rfknmscolrschemartblrcolfkuprule fkdelrulerec local_cols remote_colsrrrget_foreign_keysszew       zMSDialect.get_foreign_keys) NTrrNNNNNFr)urrrrsupports_statement_cachesupports_default_valuessupports_empty_insertfavor_returning_over_lastrowidreturns_native_bytesrvsupports_default_metavaluerexecution_ctx_clsrmax_identifier_lengthr8insert_returningupdate_returningdelete_returningupdate_returning_multifromdelete_returning_multifromrDateTimerDDater rr r Timer?rr[ UnicodeTextr\rQrIrGr'UuidrtcolspecsrDefaultDialectengine_config_typesrrasboolrsupports_sequencessequences_optionaldefault_sequence_basesupports_native_boolean#non_native_boolean_check_constraintsupports_unicode_bindspostfetch_lastrowidruse_insertmanyvalues!use_insertmanyvalues_wo_returningr! AUTOINCREMENTIDENTITYUSE_INSERT_FROM_SELECT"insertmanyvalues_implicit_sentinelinsertmanyvalues_max_parametersrprr.rr statement_compilerr ddl_compilerrtype_compiler_clsrCrrPrimaryKeyConstraintUniqueConstraintIndexrconstruct_argumentsrr}rrrrrrrrrrrr_rrcacherr]rrrrrrrrrrrr(r6rQrrrrrr s      &  .         p   3 7r)r __future__rrarrKr7typingrruuidr _python_UUIDrwrrjsonrr r r r rrrrrrenginerr rrengine.reflectionrrrrrrrrrrrx sql._typingr sql.compilerr! sql.elementsr"typesr#r$r%r&r'r(r)r*r+r,r-r.r/r0r2 util.typingr3sql.dmlr4sql.selectabler5MS_2017_VERSIONMS_2016_VERSIONMS_2014_VERSIONrrMS_2005_VERSIONMS_2000_VERSIONrTrrrrr`r r9_MSTimer?rAr_rDrGrIrQrRrr[rbr\_Binaryr]rhrjrkrroTextrprrq TypeEnginerrrsrcrt _UUID_RETURNr|r MSDateTimeMSDateMSReal MSTinyIntegerMSTimeMSSmallDateTime MSDateTime2MSDateTimeOffsetrrrrrrrrMSImageMSBitMSMoney MSSmallMoneyMSUniqueIdentifier MSVariantrGenericTypeCompilerrDefaultExecutionContextrrr r DDLCompilerrIdentifierPreparerrCr]r_rYrXLRUCacherfrOrerrrrrs S                                                 9  *  0(  0     #&,,: