dbt-sqlserver 1.10.0__tar.gz → 1.10.1rc1__tar.gz

dbt_sqlserver-1.10.1rc1/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: dbt-sqlserver
+Version: 1.10.1rc1
+Summary: A Microsoft SQL Server adapter plugin for dbt
+Author: Mikael Ene, Anders Swanson, Sam Debruyn, Cor Zuurmond, Cody Scott
+License: MIT
+Project-URL: Setup & configuration, https://docs.getdbt.com/reference/warehouse-profiles/mssql-profile
+Project-URL: Documentation & usage, https://docs.getdbt.com/reference/resource-configs/mssql-configs
+Project-URL: Changelog, https://github.com/dbt-msft/dbt-sqlserver/blob/master/CHANGELOG.md
+Project-URL: Issue Tracker, https://github.com/dbt-msft/dbt-sqlserver/issues
+Project-URL: Source, https://github.com/dbt-msft/dbt-sqlserver
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dbt-core<2.0,>=1.10.0
+Requires-Dist: dbt-common<2.0,>=1.22.0
+Requires-Dist: dbt-adapters<2.0,>=1.15.2
+Requires-Dist: pyodbc>=5.2.0
+Provides-Extra: azure
+Requires-Dist: azure-identity>=1.12.0; extra == "azure"
+Provides-Extra: pyodbc
+Requires-Dist: pyodbc>=5.2.0; extra == "pyodbc"
+Provides-Extra: mssql
+Requires-Dist: mssql-python>=1.7.1; extra == "mssql"
+Requires-Dist: azure-identity>=1.12.0; extra == "mssql"
+Requires-Dist: azure-core>=1.0.0; extra == "mssql"
+Dynamic: license-file
+
+# dbt-sqlserver
+
+[dbt](https://www.getdbt.com) adapter for Microsoft SQL Server and Azure SQL services.
+
+The adapter supports dbt-core 0.14 or newer and follows the same versioning scheme.
+E.g. version 1.1.x of the adapter will be compatible with dbt-core 1.1.x.
+
+The minimum supported SQL Server version is SQL Server 2017.
+
+## Documentation
+
+We've bundled all documentation on the dbt docs site:
+
+- [Profile setup & authentication](https://docs.getdbt.com/reference/warehouse-profiles/mssql-profile)
+- [Adapter documentation, usage and important notes](https://docs.getdbt.com/reference/resource-configs/mssql-configs)
+
+Join us on the [dbt Slack](https://getdbt.slack.com/archives/CMRMDDQ9W) to ask questions, get help, or to discuss the project.
+
+## Installation
+
+The default install uses the `pyodbc` backend and includes the `pyodbc` dependency. If you want the optional `mssql-python` backend instead, install the `mssql` extra.
+
+Latest version: ![PyPI](https://img.shields.io/pypi/v/dbt-sqlserver?label=latest%20stable&logo=pypi)  
+Latest pre-release: ![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/dbt-msft/dbt-sqlserver?include_prereleases&label=latest%20pre-release&logo=pypi)
+
+
+### Backend requirements at a glance
+
+| Backend | Python package | Debian/Ubuntu system packages |
+|---|---|---|
+| `pyodbc` | `dbt-sqlserver[pyodbc]` or `pyodbc` | `unixodbc-dev` plus the Microsoft ODBC Driver for SQL Server |
+| `mssql-python` | `dbt-sqlserver[mssql]` or `mssql-python` | `libltdl7`, `libkrb5-3`, `libgssapi-krb5-2` |
+
+
+### `pyodbc` backend
+
+The legacy and currently default ODBC path uses `pyodbc` and the Microsoft ODBC driver.
+
+```shell
+pip install -U dbt-sqlserver
+```
+
+You should migrate to using an explicit extra in preparation for deprecation; the following is equivalent:
+
+```shell
+pip install -U "dbt-sqlserver[pyodbc]"
+```
+
+You also need the Microsoft ODBC driver for SQL Server installed on your system:
+[Windows](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16#download-for-windows) |
+[macOS](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/install-microsoft-odbc-driver-sql-server-macos?view=sql-server-ver16) |
+[Linux](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-sql-server?view=sql-server-ver16)
+
+<details><summary>Debian/Ubuntu</summary>
+
+Install the ODBC headers as well as the driver linked above:
+
+```shell
+sudo apt-get install -y unixodbc-dev
+```
+
+</details>
+
+### `mssql-python` backend
+
+An alternative backend that does not require the ODBC driver.
+
+```shell
+pip install -U "dbt-sqlserver[mssql]"
+```
+
+On Debian/Ubuntu-based systems, `mssql-python` requires these system libraries:
+
+```shell
+sudo apt-get install -y libltdl7 libkrb5-3 libgssapi-krb5-2
+```
+
+Enable it per target in your `profiles.yml`:
+
+```yaml
+your_profile:
+  target: dev
+  outputs:
+    dev:
+      type: sqlserver
+      host: your-server
+      port: 1433
+      database: your-database
+      schema: dbo
+      user: your-user
+      password: your-password
+      encrypt: true
+      trust_cert: false
+      backend: mssql-python  # <-- enables this backend
+```
+
+## Changelog
+
+See [the changelog](CHANGELOG.md)
+
+## Configuration
+
+### `dbt_sqlserver_use_default_schema_concat`
+
+*(default: `false`)* Controls schema name generation when a [custom schema](https://docs.getdbt.com/docs/build/custom-schemas) is set on a model.
+
+| Flag value | `custom_schema_name` | Result |
+|---|---|---|
+| `false` (default, legacy) | *(none)* | `target.schema` |
+| `false` (default, legacy) | `"reporting"` | `reporting` |
+| `true` (dbt-core standard) | *(none)* | `target.schema` |
+| `true` (dbt-core standard) | `"reporting"` | `target.schema_reporting` |
+
+When `false` (the default), the adapter uses its legacy behaviour: `custom_schema_name` is used **as-is** without being prefixed by `target.schema`.  
+When `true`, the adapter delegates to dbt-core's `default__generate_schema_name`, which concatenates `target.schema` + `_` + `custom_schema_name`.
+
+**Example usage in `dbt_project.yml`:**
+
+```yaml
+flags:
+  dbt_sqlserver_use_default_schema_concat: true  # Enable standard schema concatenation
+```
+
+The same setting is also honoured via `vars:` for backwards compatibility; the behavior flag under `flags:` takes precedence when both are set.
+
+> **Note:** If you want to permanently customise schema generation and avoid any future changes, override the `sqlserver__generate_schema_name` macro directly in your project instead.
+
+### `backend`
+
+*(default: `pyodbc`)* Set to `mssql-python` in a profile target to use the `mssql-python` backend instead of `pyodbc`. The adapter fails if the required backend package (Python dependency), such as `pyodbc` or `mssql-python`, is not installed.
+
+### `dbt_sqlserver_enable_safe_type_expansion`
+
+*(default: `false`)* When enabled, allows the adapter to widen column types during incremental model schema expansion beyond same-family string resizes. Supported safe expansions include:
+
+- **Cross-family string**: `varchar`/`char` → `nvarchar`/`nchar` (same or larger size)
+- **Integer family**: `bit` → `tinyint` → `smallint` → `int` → `bigint`
+- **Integer → numeric**: `int` → `numeric` (with sufficient precision to hold the integer range)
+- **Numeric precision/scale**: `numeric(p,s)` → `numeric(p2,s2)` where precision and scale both increase
+- **Fixed-money**: `smallmoney` → `money`, `money` → `numeric` (with sufficient precision)
+
+Safe expansions are further gated by `column_type_expansion_max_rows` (default 1,000,000 rows) to avoid long-running operations on large tables.
+
+### `dbt_sqlserver_use_dbt_transactions`
+
+_(default: `false`)_ When enabled, makes dbt's transaction hooks real at the SQL Server level by emitting `BEGIN TRANSACTION` / `COMMIT TRANSACTION` through the adapter's `add_begin_query` and `add_commit_query` methods. 
+
+The default is `false`, preserving existing behavior where `begin`/`commit` hooks are logical no-ops and the ODBC driver auto-commits each statement. When `dbt_sqlserver_use_dbt_transactions: true`, the adapter emits real T-SQL transaction statements, and rollback uses `IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION`.
+
+The driver connection remains in autocommit mode (`autocommit=true`) in both modes.
+
+This mode is opt-in and should be tested carefully with project-specific materializations and hooks.
+
+```yaml
+# dbt_project.yml
+flags:
+  dbt_sqlserver_enable_safe_type_expansion: true
+  dbt_sqlserver_use_dbt_transactions: true # <-- opt-in; default is false
+```
+
+### `column_type_expansion_max_rows`
+
+*(default: `1000000`)* Per-model config that limits when safe type expansion runs. When the target table exceeds this row count, safe type expansion is skipped (basic same-family string resizes still proceed). Set to `-1` to disable the check entirely.
+
+```sql
+-- In an incremental model
+{{ config(materialized='incremental', unique_key='id',
+           column_type_expansion_max_rows=500000) }}
+```
+
+### `prefer_single_alter_column`
+
+*(default: `false`)* Model-level config that controls how `alter_column_type` changes column types on tables. When `false` (default), the adapter uses the safer approach: add a temporary column, copy data, drop the original, and rename. When `true`, the adapter uses a single `ALTER COLUMN` statement, which is faster on small, medium tables and instant on safe type expansions but may fail for types that cannot be implicitly converted.
+
+```sql
+-- In an incremental model
+{{ config(materialized='incremental', unique_key='id',
+           prefer_single_alter_column=true) }}
+```
+
+**Compatibility notes:** Enabling `dbt_sqlserver_use_dbt_transactions: true` may expose transaction-state assumptions hidden by autocommit-only mode. Explicit transaction macros may interact with dbt-managed transactions, and cleanup after failed DDL/DML may differ. Review pre/post hooks for in-transaction vs out-of-transaction semantics.
+
+## Contributing
+
+[![Unit tests](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/unit-tests.yml)
+[![Integration tests on SQL Server](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/integration-tests-sqlserver.yml/badge.svg)](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/integration-tests-sqlserver.yml)
+
+This adapter is community-maintained.
+You are welcome to contribute by creating issues, opening or reviewing pull requests, or helping other users in the Slack channel.
+If you're unsure how to get started, check out our [contributing guide](CONTRIBUTING.md).
+
+## License
+
+[![PyPI - License](https://img.shields.io/pypi/l/dbt-sqlserver)](https://github.com/dbt-msft/dbt-sqlserver/blob/master/LICENSE)
+
+## Code of Conduct
+
+This project and everyone involved is expected to follow the [dbt Code of Conduct](https://community.getdbt.com/code-of-conduct).

dbt_sqlserver-1.10.1rc1/README.md

@@ -0,0 +1,198 @@
+# dbt-sqlserver
+
+[dbt](https://www.getdbt.com) adapter for Microsoft SQL Server and Azure SQL services.
+
+The adapter supports dbt-core 0.14 or newer and follows the same versioning scheme.
+E.g. version 1.1.x of the adapter will be compatible with dbt-core 1.1.x.
+
+The minimum supported SQL Server version is SQL Server 2017.
+
+## Documentation
+
+We've bundled all documentation on the dbt docs site:
+
+- [Profile setup & authentication](https://docs.getdbt.com/reference/warehouse-profiles/mssql-profile)
+- [Adapter documentation, usage and important notes](https://docs.getdbt.com/reference/resource-configs/mssql-configs)
+
+Join us on the [dbt Slack](https://getdbt.slack.com/archives/CMRMDDQ9W) to ask questions, get help, or to discuss the project.
+
+## Installation
+
+The default install uses the `pyodbc` backend and includes the `pyodbc` dependency. If you want the optional `mssql-python` backend instead, install the `mssql` extra.
+
+Latest version: ![PyPI](https://img.shields.io/pypi/v/dbt-sqlserver?label=latest%20stable&logo=pypi)  
+Latest pre-release: ![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/dbt-msft/dbt-sqlserver?include_prereleases&label=latest%20pre-release&logo=pypi)
+
+
+### Backend requirements at a glance
+
+| Backend | Python package | Debian/Ubuntu system packages |
+|---|---|---|
+| `pyodbc` | `dbt-sqlserver[pyodbc]` or `pyodbc` | `unixodbc-dev` plus the Microsoft ODBC Driver for SQL Server |
+| `mssql-python` | `dbt-sqlserver[mssql]` or `mssql-python` | `libltdl7`, `libkrb5-3`, `libgssapi-krb5-2` |
+
+
+### `pyodbc` backend
+
+The legacy and currently default ODBC path uses `pyodbc` and the Microsoft ODBC driver.
+
+```shell
+pip install -U dbt-sqlserver
+```
+
+You should migrate to using an explicit extra in preparation for deprecation; the following is equivalent:
+
+```shell
+pip install -U "dbt-sqlserver[pyodbc]"
+```
+
+You also need the Microsoft ODBC driver for SQL Server installed on your system:
+[Windows](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16#download-for-windows) |
+[macOS](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/install-microsoft-odbc-driver-sql-server-macos?view=sql-server-ver16) |
+[Linux](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-sql-server?view=sql-server-ver16)
+
+<details><summary>Debian/Ubuntu</summary>
+
+Install the ODBC headers as well as the driver linked above:
+
+```shell
+sudo apt-get install -y unixodbc-dev
+```
+
+</details>
+
+### `mssql-python` backend
+
+An alternative backend that does not require the ODBC driver.
+
+```shell
+pip install -U "dbt-sqlserver[mssql]"
+```
+
+On Debian/Ubuntu-based systems, `mssql-python` requires these system libraries:
+
+```shell
+sudo apt-get install -y libltdl7 libkrb5-3 libgssapi-krb5-2
+```
+
+Enable it per target in your `profiles.yml`:
+
+```yaml
+your_profile:
+  target: dev
+  outputs:
+    dev:
+      type: sqlserver
+      host: your-server
+      port: 1433
+      database: your-database
+      schema: dbo
+      user: your-user
+      password: your-password
+      encrypt: true
+      trust_cert: false
+      backend: mssql-python  # <-- enables this backend
+```
+
+## Changelog
+
+See [the changelog](CHANGELOG.md)
+
+## Configuration
+
+### `dbt_sqlserver_use_default_schema_concat`
+
+*(default: `false`)* Controls schema name generation when a [custom schema](https://docs.getdbt.com/docs/build/custom-schemas) is set on a model.
+
+| Flag value | `custom_schema_name` | Result |
+|---|---|---|
+| `false` (default, legacy) | *(none)* | `target.schema` |
+| `false` (default, legacy) | `"reporting"` | `reporting` |
+| `true` (dbt-core standard) | *(none)* | `target.schema` |
+| `true` (dbt-core standard) | `"reporting"` | `target.schema_reporting` |
+
+When `false` (the default), the adapter uses its legacy behaviour: `custom_schema_name` is used **as-is** without being prefixed by `target.schema`.  
+When `true`, the adapter delegates to dbt-core's `default__generate_schema_name`, which concatenates `target.schema` + `_` + `custom_schema_name`.
+
+**Example usage in `dbt_project.yml`:**
+
+```yaml
+flags:
+  dbt_sqlserver_use_default_schema_concat: true  # Enable standard schema concatenation
+```
+
+The same setting is also honoured via `vars:` for backwards compatibility; the behavior flag under `flags:` takes precedence when both are set.
+
+> **Note:** If you want to permanently customise schema generation and avoid any future changes, override the `sqlserver__generate_schema_name` macro directly in your project instead.
+
+### `backend`
+
+*(default: `pyodbc`)* Set to `mssql-python` in a profile target to use the `mssql-python` backend instead of `pyodbc`. The adapter fails if the required backend package (Python dependency), such as `pyodbc` or `mssql-python`, is not installed.
+
+### `dbt_sqlserver_enable_safe_type_expansion`
+
+*(default: `false`)* When enabled, allows the adapter to widen column types during incremental model schema expansion beyond same-family string resizes. Supported safe expansions include:
+
+- **Cross-family string**: `varchar`/`char` → `nvarchar`/`nchar` (same or larger size)
+- **Integer family**: `bit` → `tinyint` → `smallint` → `int` → `bigint`
+- **Integer → numeric**: `int` → `numeric` (with sufficient precision to hold the integer range)
+- **Numeric precision/scale**: `numeric(p,s)` → `numeric(p2,s2)` where precision and scale both increase
+- **Fixed-money**: `smallmoney` → `money`, `money` → `numeric` (with sufficient precision)
+
+Safe expansions are further gated by `column_type_expansion_max_rows` (default 1,000,000 rows) to avoid long-running operations on large tables.
+
+### `dbt_sqlserver_use_dbt_transactions`
+
+_(default: `false`)_ When enabled, makes dbt's transaction hooks real at the SQL Server level by emitting `BEGIN TRANSACTION` / `COMMIT TRANSACTION` through the adapter's `add_begin_query` and `add_commit_query` methods. 
+
+The default is `false`, preserving existing behavior where `begin`/`commit` hooks are logical no-ops and the ODBC driver auto-commits each statement. When `dbt_sqlserver_use_dbt_transactions: true`, the adapter emits real T-SQL transaction statements, and rollback uses `IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION`.
+
+The driver connection remains in autocommit mode (`autocommit=true`) in both modes.
+
+This mode is opt-in and should be tested carefully with project-specific materializations and hooks.
+
+```yaml
+# dbt_project.yml
+flags:
+  dbt_sqlserver_enable_safe_type_expansion: true
+  dbt_sqlserver_use_dbt_transactions: true # <-- opt-in; default is false
+```
+
+### `column_type_expansion_max_rows`
+
+*(default: `1000000`)* Per-model config that limits when safe type expansion runs. When the target table exceeds this row count, safe type expansion is skipped (basic same-family string resizes still proceed). Set to `-1` to disable the check entirely.
+
+```sql
+-- In an incremental model
+{{ config(materialized='incremental', unique_key='id',
+           column_type_expansion_max_rows=500000) }}
+```
+
+### `prefer_single_alter_column`
+
+*(default: `false`)* Model-level config that controls how `alter_column_type` changes column types on tables. When `false` (default), the adapter uses the safer approach: add a temporary column, copy data, drop the original, and rename. When `true`, the adapter uses a single `ALTER COLUMN` statement, which is faster on small, medium tables and instant on safe type expansions but may fail for types that cannot be implicitly converted.
+
+```sql
+-- In an incremental model
+{{ config(materialized='incremental', unique_key='id',
+           prefer_single_alter_column=true) }}
+```
+
+**Compatibility notes:** Enabling `dbt_sqlserver_use_dbt_transactions: true` may expose transaction-state assumptions hidden by autocommit-only mode. Explicit transaction macros may interact with dbt-managed transactions, and cleanup after failed DDL/DML may differ. Review pre/post hooks for in-transaction vs out-of-transaction semantics.
+
+## Contributing
+
+[![Unit tests](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/unit-tests.yml)
+[![Integration tests on SQL Server](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/integration-tests-sqlserver.yml/badge.svg)](https://github.com/dbt-msft/dbt-sqlserver/actions/workflows/integration-tests-sqlserver.yml)
+
+This adapter is community-maintained.
+You are welcome to contribute by creating issues, opening or reviewing pull requests, or helping other users in the Slack channel.
+If you're unsure how to get started, check out our [contributing guide](CONTRIBUTING.md).
+
+## License
+
+[![PyPI - License](https://img.shields.io/pypi/l/dbt-sqlserver)](https://github.com/dbt-msft/dbt-sqlserver/blob/master/LICENSE)
+
+## Code of Conduct
+
+This project and everyone involved is expected to follow the [dbt Code of Conduct](https://community.getdbt.com/code-of-conduct).

dbt_sqlserver-1.10.1rc1/dbt/adapters/sqlserver/__version__.py

@@ -0,0 +1 @@
+version = "1.10.1rc1"

{dbt_sqlserver-1.10.0 → dbt_sqlserver-1.10.1rc1}/dbt/adapters/sqlserver/relation_configs/__init__.py

@@ -1,3 +1,8 @@
+from dbt.adapters.sqlserver.relation_configs.index import (
+    SQLServerIndexConfig,
+    SQLServerIndexConfigChange,
+    SQLServerIndexType,
+)
 from dbt.adapters.sqlserver.relation_configs.policies import (
     MAX_CHARACTERS_IN_IDENTIFIER,
     SQLServerIncludePolicy,
@@ -10,4 +15,7 @@ __all__ = [
     "SQLServerIncludePolicy",
     "SQLServerQuotePolicy",
     "SQLServerRelationType",
+    "SQLServerIndexType",
+    "SQLServerIndexConfig",
+    "SQLServerIndexConfigChange",
 ]