sqlalchemy-mssql-bulkcopy 0.1.0__tar.gz

sqlalchemy_mssql_bulkcopy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,70 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - run: pip install -e ".[dev]"
+      - run: pip install "sqlalchemy @ git+https://github.com/sqlalchemy/sqlalchemy.git@main"
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+      - run: pytest --cov=sqlalchemy_mssql_bulkcopy --cov-report=term-missing
+
+  integration:
+    name: Integration (SQL Server 2022)
+    runs-on: ubuntu-latest
+    services:
+      sqlserver:
+        image: mcr.microsoft.com/mssql/server:2022-latest
+        env:
+          ACCEPT_EULA: Y
+          MSSQL_SA_PASSWORD: BenchMark!Pass123
+        ports:
+          - 1433:1433
+        options: >-
+          --health-cmd "/opt/mssql-tools18/bin/sqlcmd -S localhost -U sa -P 'BenchMark!Pass123' -C -Q 'SELECT 1'"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 10
+          --health-start-period 30s
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - run: pip install -e ".[dev]"
+      - run: pip install "sqlalchemy @ git+https://github.com/sqlalchemy/sqlalchemy.git@main"
+      - run: python tests/integration.py

sqlalchemy_mssql_bulkcopy-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,61 @@
+name: Publish
+
+on:
+  push:
+    tags: ["v*"]
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v5
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sqlalchemy-mssql-bulkcopy
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+
+  release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

sqlalchemy_mssql_bulkcopy-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+.coverage
+htmlcov/
+coverage.xml
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+src/sqlalchemy_mssql_bulkcopy/_version.py

sqlalchemy_mssql_bulkcopy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Caspi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sqlalchemy_mssql_bulkcopy-0.1.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: sqlalchemy-mssql-bulkcopy
+Version: 0.1.0
+Summary: Bulk copy for SQLAlchemy + mssql-python — 10-50x faster writes via SQL Server's native TDS protocol
+Author: Daniel Caspi
+License: MIT
+Project-URL: Homepage, https://github.com/dxdc/sqlalchemy-mssql-bulkcopy
+Project-URL: Issues, https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/issues
+Project-URL: Changelog, https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/releases
+Keywords: sqlalchemy,mssql,sql-server,bulk-copy,pandas,mssql-python,bulkcopy,tds,etl
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy>=2.1.0b1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.0; extra == "dev"
+Requires-Dist: pandas>=2.0; extra == "dev"
+Requires-Dist: mssql-python>=1.4.0; extra == "dev"
+Requires-Dist: ruff>=0.9; extra == "dev"
+Dynamic: license-file
+
+# sqlalchemy-mssql-bulkcopy
+
+[![CI](https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/actions/workflows/ci.yml/badge.svg)](https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/sqlalchemy-mssql-bulkcopy)](https://pypi.org/project/sqlalchemy-mssql-bulkcopy/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+Bulk copy for SQLAlchemy + mssql-python — 10–50× faster writes via
+SQL Server's native TDS bulk load protocol.
+
+All `cursor.bulkcopy()` kwargs pass through to the driver. When
+mssql-python adds new options, this package supports them automatically.
+
+Based on the [event hook approach recommended by SQLAlchemy's maintainer](https://github.com/sqlalchemy/sqlalchemy/issues/13218).
+
+## Install
+
+The `mssql+mssqlpython` dialect requires SQLAlchemy ≥ 2.1.0b2,
+which is not yet on PyPI. Install SA from git until then:
+
+```bash
+pip install "sqlalchemy @ git+https://github.com/sqlalchemy/sqlalchemy.git@main"
+pip install sqlalchemy-mssql-bulkcopy
+```
+
+Once SA 2.1 is stable:
+
+```bash
+pip install sqlalchemy-mssql-bulkcopy
+```
+
+Requires Python ≥ 3.10, SQLAlchemy ≥ 2.1, mssql-python ≥ 1.4.
+
+## Usage
+
+### Direct (recommended)
+
+No engine configuration needed. Returns the driver result dict.
+
+```python
+from sqlalchemy import create_engine
+from sqlalchemy_mssql_bulkcopy import bulkcopy
+
+engine = create_engine("mssql+mssqlpython://user:pass@host/db")
+
+with engine.begin() as conn:
+    result = bulkcopy(conn, df, "dbo.users", batch_size=50_000)
+    print(f"{result['rows_copied']} rows in {result['elapsed_time']:.2f}s")
+```
+
+Accepts DataFrames (columns auto-detected), lists of tuples, generators,
+or any iterable:
+
+```python
+# All driver options pass through as kwargs
+result = bulkcopy(
+    conn, df, "staging.events",
+    batch_size=100_000,
+    table_lock=True,
+    keep_identity=True,
+    check_constraints=True,
+    fire_triggers=True,
+    keep_nulls=True,
+    timeout=300,
+    use_internal_transaction=True,
+)
+```
+
+### Event hook (SA Core / ORM)
+
+Hooks into SQLAlchemy's INSERT workflow. Per-statement opt-in via
+execution options:
+
+```python
+from sqlalchemy_mssql_bulkcopy import register_bulkcopy
+
+engine = create_engine(
+    "mssql+mssqlpython://user:pass@host/db",
+    use_insertmanyvalues=False,  # required — see note below
+)
+register_bulkcopy(engine, batch_size=10_000, table_lock=True)
+
+with engine.begin() as conn:
+    conn.execute(
+        users.insert().execution_options(use_bulkcopy=True),
+        rows,
+    )
+```
+
+Per-statement overrides use the `bulkcopy_` prefix:
+
+```python
+stmt = users.insert().execution_options(
+    use_bulkcopy=True,
+    bulkcopy_batch_size=100_000,
+    bulkcopy_fire_triggers=True,
+)
+```
+
+> **Note:** `register_bulkcopy()` raises `ValueError` if
+> `use_insertmanyvalues` is not disabled. SA 2.x defaults to multi-row
+> `INSERT … VALUES` batching which bypasses `executemany()` entirely —
+> the event hook never fires without this flag. This is a global engine
+> setting: non-bulkcopy inserts will use `executemany()` instead, which
+> is slightly slower for medium-sized batches. If that matters, use
+> `bulkcopy()` directly instead.
+
+### Pandas
+
+```python
+from sqlalchemy_mssql_bulkcopy import bulkcopy_insert_method
+
+df.to_sql("users", engine, method=bulkcopy_insert_method,
+          if_exists="append", index=False)
+```
+
+## Confirming bulkcopy was used
+
+```python
+# Direct — return value
+result = bulkcopy(conn, df, "dbo.users")
+assert result["rows_copied"] == len(df)
+
+# Event hook — on_complete callback
+results = []
+register_bulkcopy(engine, on_complete=lambda t, r: results.append(r))
+```
+
+Both approaches log at INFO level:
+`bulkcopy: 1000 rows -> dbo.users (0.050s)`
+
+## License
+
+MIT

sqlalchemy_mssql_bulkcopy-0.1.0/README.md

@@ -0,0 +1,133 @@
+# sqlalchemy-mssql-bulkcopy
+
+[![CI](https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/actions/workflows/ci.yml/badge.svg)](https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/sqlalchemy-mssql-bulkcopy)](https://pypi.org/project/sqlalchemy-mssql-bulkcopy/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+Bulk copy for SQLAlchemy + mssql-python — 10–50× faster writes via
+SQL Server's native TDS bulk load protocol.
+
+All `cursor.bulkcopy()` kwargs pass through to the driver. When
+mssql-python adds new options, this package supports them automatically.
+
+Based on the [event hook approach recommended by SQLAlchemy's maintainer](https://github.com/sqlalchemy/sqlalchemy/issues/13218).
+
+## Install
+
+The `mssql+mssqlpython` dialect requires SQLAlchemy ≥ 2.1.0b2,
+which is not yet on PyPI. Install SA from git until then:
+
+```bash
+pip install "sqlalchemy @ git+https://github.com/sqlalchemy/sqlalchemy.git@main"
+pip install sqlalchemy-mssql-bulkcopy
+```
+
+Once SA 2.1 is stable:
+
+```bash
+pip install sqlalchemy-mssql-bulkcopy
+```
+
+Requires Python ≥ 3.10, SQLAlchemy ≥ 2.1, mssql-python ≥ 1.4.
+
+## Usage
+
+### Direct (recommended)
+
+No engine configuration needed. Returns the driver result dict.
+
+```python
+from sqlalchemy import create_engine
+from sqlalchemy_mssql_bulkcopy import bulkcopy
+
+engine = create_engine("mssql+mssqlpython://user:pass@host/db")
+
+with engine.begin() as conn:
+    result = bulkcopy(conn, df, "dbo.users", batch_size=50_000)
+    print(f"{result['rows_copied']} rows in {result['elapsed_time']:.2f}s")
+```
+
+Accepts DataFrames (columns auto-detected), lists of tuples, generators,
+or any iterable:
+
+```python
+# All driver options pass through as kwargs
+result = bulkcopy(
+    conn, df, "staging.events",
+    batch_size=100_000,
+    table_lock=True,
+    keep_identity=True,
+    check_constraints=True,
+    fire_triggers=True,
+    keep_nulls=True,
+    timeout=300,
+    use_internal_transaction=True,
+)
+```
+
+### Event hook (SA Core / ORM)
+
+Hooks into SQLAlchemy's INSERT workflow. Per-statement opt-in via
+execution options:
+
+```python
+from sqlalchemy_mssql_bulkcopy import register_bulkcopy
+
+engine = create_engine(
+    "mssql+mssqlpython://user:pass@host/db",
+    use_insertmanyvalues=False,  # required — see note below
+)
+register_bulkcopy(engine, batch_size=10_000, table_lock=True)
+
+with engine.begin() as conn:
+    conn.execute(
+        users.insert().execution_options(use_bulkcopy=True),
+        rows,
+    )
+```
+
+Per-statement overrides use the `bulkcopy_` prefix:
+
+```python
+stmt = users.insert().execution_options(
+    use_bulkcopy=True,
+    bulkcopy_batch_size=100_000,
+    bulkcopy_fire_triggers=True,
+)
+```
+
+> **Note:** `register_bulkcopy()` raises `ValueError` if
+> `use_insertmanyvalues` is not disabled. SA 2.x defaults to multi-row
+> `INSERT … VALUES` batching which bypasses `executemany()` entirely —
+> the event hook never fires without this flag. This is a global engine
+> setting: non-bulkcopy inserts will use `executemany()` instead, which
+> is slightly slower for medium-sized batches. If that matters, use
+> `bulkcopy()` directly instead.
+
+### Pandas
+
+```python
+from sqlalchemy_mssql_bulkcopy import bulkcopy_insert_method
+
+df.to_sql("users", engine, method=bulkcopy_insert_method,
+          if_exists="append", index=False)
+```
+
+## Confirming bulkcopy was used
+
+```python
+# Direct — return value
+result = bulkcopy(conn, df, "dbo.users")
+assert result["rows_copied"] == len(df)
+
+# Event hook — on_complete callback
+results = []
+register_bulkcopy(engine, on_complete=lambda t, r: results.append(r))
+```
+
+Both approaches log at INFO level:
+`bulkcopy: 1000 rows -> dbo.users (0.050s)`
+
+## License
+
+MIT

sqlalchemy_mssql_bulkcopy-0.1.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["setuptools>=75.0", "setuptools-scm>=8.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sqlalchemy-mssql-bulkcopy"
+dynamic = ["version"]
+description = "Bulk copy for SQLAlchemy + mssql-python — 10-50x faster writes via SQL Server's native TDS protocol"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [{ name = "Daniel Caspi" }]
+keywords = [
+    "sqlalchemy", "mssql", "sql-server", "bulk-copy", "pandas",
+    "mssql-python", "bulkcopy", "tds", "etl",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Typing :: Typed",
+]
+dependencies = ["sqlalchemy>=2.1.0b1"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=6.0",
+    "pandas>=2.0",
+    "mssql-python>=1.4.0",
+    "ruff>=0.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/dxdc/sqlalchemy-mssql-bulkcopy"
+Issues = "https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/issues"
+Changelog = "https://github.com/dxdc/sqlalchemy-mssql-bulkcopy/releases"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 99
+src = ["src", "tests"]
+exclude = ["_version.py"]
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "UP", "B", "SIM", "RUF"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+
+[tool.coverage.run]
+source = ["sqlalchemy_mssql_bulkcopy"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.setuptools_scm]
+version_file = "src/sqlalchemy_mssql_bulkcopy/_version.py"

sqlalchemy_mssql_bulkcopy-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+