sqlmesh-hardcharger 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. sqlmesh_hardcharger-1.0.0/CHANGELOG.md +14 -0
  2. sqlmesh_hardcharger-1.0.0/LICENSE +201 -0
  3. sqlmesh_hardcharger-1.0.0/MANIFEST.in +5 -0
  4. sqlmesh_hardcharger-1.0.0/Makefile +45 -0
  5. sqlmesh_hardcharger-1.0.0/PKG-INFO +178 -0
  6. sqlmesh_hardcharger-1.0.0/README.md +140 -0
  7. sqlmesh_hardcharger-1.0.0/docs/assets/hardcharger-banner-dark.png +0 -0
  8. sqlmesh_hardcharger-1.0.0/docs/assets/hardcharger-banner-light.png +0 -0
  9. sqlmesh_hardcharger-1.0.0/docs/releasing.md +28 -0
  10. sqlmesh_hardcharger-1.0.0/pyproject.toml +79 -0
  11. sqlmesh_hardcharger-1.0.0/scripts/test-upstream.py +138 -0
  12. sqlmesh_hardcharger-1.0.0/scripts/upstream_fixtures.py +113 -0
  13. sqlmesh_hardcharger-1.0.0/setup.cfg +4 -0
  14. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger/__init__.py +68 -0
  15. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger/adapter.py +209 -0
  16. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger/cli.py +10 -0
  17. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger/connection.py +162 -0
  18. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/PKG-INFO +178 -0
  19. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/SOURCES.txt +31 -0
  20. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/dependency_links.txt +1 -0
  21. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/entry_points.txt +2 -0
  22. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/requires.txt +13 -0
  23. sqlmesh_hardcharger-1.0.0/sqlmesh_hardcharger.egg-info/top_level.txt +1 -0
  24. sqlmesh_hardcharger-1.0.0/tests/__init__.py +0 -0
  25. sqlmesh_hardcharger-1.0.0/tests/integration/__init__.py +0 -0
  26. sqlmesh_hardcharger-1.0.0/tests/integration/conftest.py +54 -0
  27. sqlmesh_hardcharger-1.0.0/tests/integration/docker/compose.hardcharger.yaml +20 -0
  28. sqlmesh_hardcharger-1.0.0/tests/integration/test_hardcharger_regressions.py +88 -0
  29. sqlmesh_hardcharger-1.0.0/tests/integration/test_integration_ducklake.py +860 -0
  30. sqlmesh_hardcharger-1.0.0/tests/integration/test_integration_hardcharger.py +371 -0
  31. sqlmesh_hardcharger-1.0.0/tests/test_hardcharger.py +305 -0
  32. sqlmesh_hardcharger-1.0.0/tests/test_hardcharger_regressions.py +81 -0
  33. sqlmesh_hardcharger-1.0.0/uv.lock +2503 -0
@@ -0,0 +1,14 @@
1
+ # Changelog
2
+
3
+ ## [1.0.0] - 2026-10-23
4
+
5
+ - Initial Hardcharger release, ported from sqlmesh-gizmosql 0.3.1 with all 55 inherited tests.
6
+ - Native Hardcharger ADBC 2.0.2 over Warp SQL HTTP(S), TLS by default, Python 3.11+.
7
+ - SQLMesh 0.236.4, the latest compatible transitive dependencies, refreshed development/build tools and lockfile.
8
+ - Reuse SQLMesh's current DuckDB implementation, including DuckLake partitioning and case-insensitive cascade detection.
9
+ - Fix partial source-column ingestion, typed missing values, native transaction handling, metadata discovery and quoted schema names.
10
+ - Add token/mTLS/custom CA options, per-connection default catalogs, IPv6 and a YAML-aware SQLMesh CLI.
11
+ - Add regression coverage and current upstream DuckDB/shared engine tests against real Hardcharger.
12
+ - Tag-gated PyPI Trusted Publishing with provenance attestations and GitHub release artifacts.
13
+
14
+ Earlier GizmoSQL releases remain in the preserved Git history and original repository.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright Contributors to the SQLMesh project
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,5 @@
1
+ include CHANGELOG.md Makefile uv.lock
2
+ recursive-include docs *.md *.png
3
+ recursive-include scripts *.py
4
+ recursive-include tests *.py *.yaml
5
+ global-exclude *.py[cod] *.db *.duckdb *.wal *.log
@@ -0,0 +1,45 @@
1
+ .PHONY: install install-dev test unit-test integration-test ducklake-test all-tests upstream-test lint format build docker-up docker-down
2
+
3
+ COMPOSE = docker compose -p sqlmesh-hardcharger -f tests/integration/docker/compose.hardcharger.yaml
4
+
5
+ install:
6
+ uv sync
7
+
8
+ install-dev:
9
+ uv sync --extra dev --frozen
10
+
11
+ test: unit-test
12
+
13
+ unit-test:
14
+ uv run pytest -m "not integration"
15
+
16
+ integration-test:
17
+ uv run pytest -m "integration and not ducklake"
18
+
19
+ docker-up:
20
+ $(COMPOSE) up -d --wait
21
+
22
+ docker-down:
23
+ $(COMPOSE) down
24
+
25
+ ducklake-test: docker-up
26
+ POSTGRES_HOST=127.0.0.1 POSTGRES_PORT=55441 uv run pytest -m ducklake
27
+
28
+ all-tests: docker-up
29
+ POSTGRES_HOST=127.0.0.1 POSTGRES_PORT=55441 uv run pytest -m "integration or not integration"
30
+
31
+ upstream-test:
32
+ uv run python scripts/test-upstream.py
33
+
34
+ lint:
35
+ uv run ruff check .
36
+ uv run ruff format --check .
37
+ uv run mypy sqlmesh_hardcharger
38
+
39
+ format:
40
+ uv run ruff check --fix .
41
+ uv run ruff format .
42
+
43
+ build:
44
+ uv run python -m build
45
+ uv run twine check --strict dist/*
@@ -0,0 +1,178 @@
1
+ Metadata-Version: 2.4
2
+ Name: sqlmesh-hardcharger
3
+ Version: 1.0.0
4
+ Summary: Hardcharger engine adapter for SQLMesh
5
+ Author-email: Philip Moore <philip@gizmodata.com>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/gizmodata/sqlmesh-hardcharger
8
+ Project-URL: Repository, https://github.com/gizmodata/sqlmesh-hardcharger
9
+ Project-URL: Documentation, https://github.com/gizmodata/sqlmesh-hardcharger#readme
10
+ Keywords: sqlmesh,hardcharger,duckdb,arrow,warp-sql,data-engineering
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Programming Language :: Python :: 3.14
20
+ Classifier: Topic :: Database
21
+ Classifier: Topic :: Scientific/Engineering :: Information Analysis
22
+ Requires-Python: >=3.11
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: sqlmesh<0.237,>=0.236.4
26
+ Requires-Dist: adbc-driver-hardcharger<3,>=2.0.2
27
+ Provides-Extra: dev
28
+ Requires-Dist: pytest>=9.1.1; extra == "dev"
29
+ Requires-Dist: pytest-cov>=7.1.0; extra == "dev"
30
+ Requires-Dist: mypy>=2.4.0; extra == "dev"
31
+ Requires-Dist: ruff>=0.17.2; extra == "dev"
32
+ Requires-Dist: hardcharger>=2.0.1; extra == "dev"
33
+ Requires-Dist: pytest-mock>=3.17.0; extra == "dev"
34
+ Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
35
+ Requires-Dist: build>=1.6.1; extra == "dev"
36
+ Requires-Dist: twine>=7.0.0; extra == "dev"
37
+ Dynamic: license-file
38
+
39
+ <p align="center">
40
+ <a href="https://github.com/gizmodata/hardcharger">
41
+ <picture>
42
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gizmodata/sqlmesh-hardcharger/main/docs/assets/hardcharger-banner-dark.png">
43
+ <img src="https://raw.githubusercontent.com/gizmodata/sqlmesh-hardcharger/main/docs/assets/hardcharger-banner-light.png" alt="Hardcharger™" width="400">
44
+ </picture>
45
+ </a>
46
+ </p>
47
+
48
+ <h1 align="center">SQLMesh Hardcharger™ Adapter</h1>
49
+
50
+ <p align="center">
51
+ <a href="https://github.com/gizmodata/sqlmesh-hardcharger/actions/workflows/ci.yml"><img src="https://github.com/gizmodata/sqlmesh-hardcharger/actions/workflows/ci.yml/badge.svg" alt="CI: full suite on Python 3.11–3.14"></a>
52
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/pypi/v/sqlmesh-hardcharger?logo=pypi" alt="PyPI version"></a>
53
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/badge/Python-3.11–3.14-3776AB?logo=python&amp;logoColor=white" alt="Python 3.11–3.14"></a>
54
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/pepy/dt/sqlmesh-hardcharger.svg" alt="PyPI downloads"></a>
55
+ <a href="https://github.com/gizmodata/hardcharger-adbc"><img src="https://img.shields.io/badge/driver-Hardcharger%20ADBC-f15a24.svg" alt="Hardcharger ADBC driver"></a>
56
+ <a href="https://github.com/gizmodata/warp-sql"><img src="https://img.shields.io/badge/protocol-Warp%20SQL-31a8db.svg" alt="Warp SQL protocol"></a>
57
+ <a href="https://github.com/gizmodata/sqlmesh-hardcharger/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg" alt="Apache 2.0 license"></a>
58
+ <a href="https://gizmodata.com"><img src="https://img.shields.io/badge/by-GizmoData%E2%84%A2-f15a24.svg" alt="GizmoData™"></a>
59
+ </p>
60
+
61
+
62
+ Run [SQLMesh](https://sqlmesh.com) transformations on [Hardcharger™](https://gizmodata.com/hardcharger), GizmoData's DuckDB 2.0 server. Connect using the native [Hardcharger ADBC driver](https://github.com/gizmodata/hardcharger-adbc) over **Warp SQL HTTP(S)**.
63
+
64
+ ## Install
65
+
66
+ ```bash
67
+ pip install sqlmesh-hardcharger
68
+ ```
69
+
70
+ Python **3.11 or later**. Installs SQLMesh 0.236.4 (compatible 0.236.x releases) and `adbc-driver-hardcharger>=2.0.2,<3`. SQLGlot stays within SQLMesh's supported 30.8.x range. The local DuckDB package is SQLMesh's dependency; remote queries execute on the Hardcharger server's DuckDB 2.0 engine.
71
+
72
+ ## Quick start
73
+
74
+ Add `config.yaml` to your SQLMesh project:
75
+
76
+ ```yaml
77
+ gateways:
78
+ hardcharger:
79
+ connection:
80
+ type: hardcharger
81
+ host: localhost
82
+ port: 31337
83
+ username: "{{ env_var('HARDCHARGER_USERNAME') }}"
84
+ password: "{{ env_var('HARDCHARGER_PASSWORD') }}"
85
+ use_encryption: true
86
+ # database: analytics # optional existing default catalog
87
+ state_connection:
88
+ type: duckdb
89
+ database: sqlmesh_state.duckdb
90
+
91
+ default_gateway: hardcharger
92
+ model_defaults:
93
+ dialect: duckdb
94
+ ```
95
+
96
+ Use the included CLI, which registers the adapter **before** SQLMesh loads YAML:
97
+
98
+ ```bash
99
+ sqlmesh-hardcharger info
100
+ sqlmesh-hardcharger plan
101
+ sqlmesh-hardcharger run
102
+ ```
103
+
104
+ It exposes SQLMesh's standard commands and options. For a local server without TLS, explicitly set `use_encryption: false`; otherwise HTTPS and certificate verification are enabled. The adapter builds `hardcharger://host:port` URIs, adding `?tls=false` only for plaintext.
105
+
106
+ For the standard `sqlmesh` command, import `sqlmesh_hardcharger` in a Python `config.py` before constructing your SQLMesh `Config`. For Python applications:
107
+
108
+ ```python
109
+ import sqlmesh_hardcharger # registers type: hardcharger
110
+ from sqlmesh import Context
111
+
112
+ context = Context(paths="path/to/project")
113
+ try:
114
+ context.plan(auto_apply=True, no_prompts=True)
115
+ finally:
116
+ context.close()
117
+ ```
118
+
119
+ Use a separate PostgreSQL state connection for production, following [SQLMesh's state connection guidance](https://sqlmesh.readthedocs.io/en/stable/guides/configuration/#state-connection). The local DuckDB state connection above is for development. The tests also exercise state migrations on Hardcharger, but SQLMesh does not recommend this custom engine for production state storage.
120
+
121
+ ## Features
122
+
123
+ - DuckDB SQL generation, SQLMesh plan/apply/run, incremental models, logical merges, SCD type 2 and table diffs.
124
+ - Arrow-native bulk DataFrame ingestion, including partial source columns, typed nulls and reordered columns.
125
+ - Native ADBC transactions and nested SQLMesh transaction scopes, with rollback on errors.
126
+ - Catalog discovery and switching, automatic schema creation, quoted identifiers and non-default catalogs.
127
+ - DuckLake with PostgreSQL metadata, partitioning and correct cascade behavior, inherited from current SQLMesh.
128
+ - Password, bearer token, browser OAuth/SSO, trusted external identity token and mutual TLS authentication through the native driver.
129
+
130
+ ## Connection options
131
+
132
+ | Option | Default | Meaning |
133
+ | --- | --- | --- |
134
+ | `host` | `localhost` | Server hostname or IPv6 address |
135
+ | `port` | `31337` | Warp SQL port (1–65535) |
136
+ | `username`, `password` | unset | Password sign-in |
137
+ | `access_token` | unset | Hardcharger bearer token; omit password credentials |
138
+ | `subject_token` | unset | Trusted identity-provider token for token exchange; omit other credentials |
139
+ | `auth_type` | unset (password) | `password`, `external`, `client_certificate` or `mtls` |
140
+ | `use_encryption` | `true` | HTTPS; false explicitly opts into plain HTTP |
141
+ | `disable_certificate_verification` | `false` | Development-only TLS verification bypass |
142
+ | `tls_root_certs` | unset | PEM CA text or file path |
143
+ | `tls_client_cert`, `tls_client_key` | unset | PEM text or paths for mTLS |
144
+ | `tls_server_name` | unset | Certificate hostname / SNI override |
145
+ | `database` | unset | Existing catalog to select on each new connection |
146
+ | `concurrent_tasks` | `4` | Concurrent SQLMesh tasks |
147
+ | `register_comments` | `true` | Register model comments |
148
+ | `pre_ping` | `false` | Check pooled connections before use |
149
+
150
+ For browser sign-in, set `auth_type: external` and omit username/password/token. For client-certificate sign-in, set `auth_type: client_certificate`, provide the certificate and key, and omit password/token credentials. See the [driver authentication documentation](https://github.com/gizmodata/hardcharger-adbc/tree/main/python).
151
+
152
+ Catalog creation attaches a DuckDB file on the **server**. Dropping a catalog detaches it; it never deletes a file on the client or deletes the server's database file. Manage server files through your server administration process. Materialized views, managed models, SQLMesh grant synchronization and custom `when_matched` logical merge clauses are not advertised by this adapter.
153
+
154
+ ## Development and testing
155
+
156
+ ```bash
157
+ uv sync --extra dev --frozen
158
+ uv run ruff check .
159
+ uv run mypy sqlmesh_hardcharger
160
+ uv run pytest # unit tests
161
+
162
+ # All inherited and Hardcharger-specific integration tests, including DuckLake:
163
+ docker compose -p sqlmesh-hardcharger -f tests/integration/docker/compose.hardcharger.yaml up -d --wait
164
+ POSTGRES_HOST=127.0.0.1 POSTGRES_PORT=55441 uv run pytest -m integration
165
+
166
+ # Current upstream DuckDB and shared engine tests, over a real Hardcharger server:
167
+ uv run python scripts/test-upstream.py
168
+ ```
169
+
170
+ The `hardcharger` development dependency downloads and verifies the released server binary on first use. Override it with `HARDCHARGER_SERVER_BINARY` when testing another build. A server is required for integration tests: they fail instead of silently skipping if it cannot start.
171
+
172
+ All 55 tests from [sqlmesh-gizmosql](https://github.com/gizmodata/sqlmesh-gizmosql/tree/0f4c37e91677b10e0a053cabea812de2ab31403a) are retained. The upstream runner pins SQLMesh v0.236.4 at `f6527ffbd8d54d91e26fab7d36c8f4a061bc6451`, uses the installed SQLMesh package, and replaces connection fixtures without changing assertions. Only the two MotherDuck-specific unit tests are deselected; the upstream suite's own unsupported-feature skips remain visible. Bump the pin and dependency range together when adopting a new SQLMesh API series.
173
+
174
+ CI tests Python 3.11–3.14, runs the upstream compatibility job, checks types and lint, builds the wheel/sdist, and publishes from version tags using PyPI Trusted Publishing with attestations. See [release setup](docs/releasing.md).
175
+
176
+ ## License and origin
177
+
178
+ Apache-2.0. Adapted from GizmoData's SQLMesh GizmoSQL adapter, preserving its Git history and tests. DuckDB engine semantics are inherited from Apache-2.0 SQLMesh. Hardcharger and GizmoData are trademarks of GizmoData.
@@ -0,0 +1,140 @@
1
+ <p align="center">
2
+ <a href="https://github.com/gizmodata/hardcharger">
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/gizmodata/sqlmesh-hardcharger/main/docs/assets/hardcharger-banner-dark.png">
5
+ <img src="https://raw.githubusercontent.com/gizmodata/sqlmesh-hardcharger/main/docs/assets/hardcharger-banner-light.png" alt="Hardcharger™" width="400">
6
+ </picture>
7
+ </a>
8
+ </p>
9
+
10
+ <h1 align="center">SQLMesh Hardcharger™ Adapter</h1>
11
+
12
+ <p align="center">
13
+ <a href="https://github.com/gizmodata/sqlmesh-hardcharger/actions/workflows/ci.yml"><img src="https://github.com/gizmodata/sqlmesh-hardcharger/actions/workflows/ci.yml/badge.svg" alt="CI: full suite on Python 3.11–3.14"></a>
14
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/pypi/v/sqlmesh-hardcharger?logo=pypi" alt="PyPI version"></a>
15
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/badge/Python-3.11–3.14-3776AB?logo=python&amp;logoColor=white" alt="Python 3.11–3.14"></a>
16
+ <a href="https://pypi.org/project/sqlmesh-hardcharger/"><img src="https://img.shields.io/pepy/dt/sqlmesh-hardcharger.svg" alt="PyPI downloads"></a>
17
+ <a href="https://github.com/gizmodata/hardcharger-adbc"><img src="https://img.shields.io/badge/driver-Hardcharger%20ADBC-f15a24.svg" alt="Hardcharger ADBC driver"></a>
18
+ <a href="https://github.com/gizmodata/warp-sql"><img src="https://img.shields.io/badge/protocol-Warp%20SQL-31a8db.svg" alt="Warp SQL protocol"></a>
19
+ <a href="https://github.com/gizmodata/sqlmesh-hardcharger/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg" alt="Apache 2.0 license"></a>
20
+ <a href="https://gizmodata.com"><img src="https://img.shields.io/badge/by-GizmoData%E2%84%A2-f15a24.svg" alt="GizmoData™"></a>
21
+ </p>
22
+
23
+
24
+ Run [SQLMesh](https://sqlmesh.com) transformations on [Hardcharger™](https://gizmodata.com/hardcharger), GizmoData's DuckDB 2.0 server. Connect using the native [Hardcharger ADBC driver](https://github.com/gizmodata/hardcharger-adbc) over **Warp SQL HTTP(S)**.
25
+
26
+ ## Install
27
+
28
+ ```bash
29
+ pip install sqlmesh-hardcharger
30
+ ```
31
+
32
+ Python **3.11 or later**. Installs SQLMesh 0.236.4 (compatible 0.236.x releases) and `adbc-driver-hardcharger>=2.0.2,<3`. SQLGlot stays within SQLMesh's supported 30.8.x range. The local DuckDB package is SQLMesh's dependency; remote queries execute on the Hardcharger server's DuckDB 2.0 engine.
33
+
34
+ ## Quick start
35
+
36
+ Add `config.yaml` to your SQLMesh project:
37
+
38
+ ```yaml
39
+ gateways:
40
+ hardcharger:
41
+ connection:
42
+ type: hardcharger
43
+ host: localhost
44
+ port: 31337
45
+ username: "{{ env_var('HARDCHARGER_USERNAME') }}"
46
+ password: "{{ env_var('HARDCHARGER_PASSWORD') }}"
47
+ use_encryption: true
48
+ # database: analytics # optional existing default catalog
49
+ state_connection:
50
+ type: duckdb
51
+ database: sqlmesh_state.duckdb
52
+
53
+ default_gateway: hardcharger
54
+ model_defaults:
55
+ dialect: duckdb
56
+ ```
57
+
58
+ Use the included CLI, which registers the adapter **before** SQLMesh loads YAML:
59
+
60
+ ```bash
61
+ sqlmesh-hardcharger info
62
+ sqlmesh-hardcharger plan
63
+ sqlmesh-hardcharger run
64
+ ```
65
+
66
+ It exposes SQLMesh's standard commands and options. For a local server without TLS, explicitly set `use_encryption: false`; otherwise HTTPS and certificate verification are enabled. The adapter builds `hardcharger://host:port` URIs, adding `?tls=false` only for plaintext.
67
+
68
+ For the standard `sqlmesh` command, import `sqlmesh_hardcharger` in a Python `config.py` before constructing your SQLMesh `Config`. For Python applications:
69
+
70
+ ```python
71
+ import sqlmesh_hardcharger # registers type: hardcharger
72
+ from sqlmesh import Context
73
+
74
+ context = Context(paths="path/to/project")
75
+ try:
76
+ context.plan(auto_apply=True, no_prompts=True)
77
+ finally:
78
+ context.close()
79
+ ```
80
+
81
+ Use a separate PostgreSQL state connection for production, following [SQLMesh's state connection guidance](https://sqlmesh.readthedocs.io/en/stable/guides/configuration/#state-connection). The local DuckDB state connection above is for development. The tests also exercise state migrations on Hardcharger, but SQLMesh does not recommend this custom engine for production state storage.
82
+
83
+ ## Features
84
+
85
+ - DuckDB SQL generation, SQLMesh plan/apply/run, incremental models, logical merges, SCD type 2 and table diffs.
86
+ - Arrow-native bulk DataFrame ingestion, including partial source columns, typed nulls and reordered columns.
87
+ - Native ADBC transactions and nested SQLMesh transaction scopes, with rollback on errors.
88
+ - Catalog discovery and switching, automatic schema creation, quoted identifiers and non-default catalogs.
89
+ - DuckLake with PostgreSQL metadata, partitioning and correct cascade behavior, inherited from current SQLMesh.
90
+ - Password, bearer token, browser OAuth/SSO, trusted external identity token and mutual TLS authentication through the native driver.
91
+
92
+ ## Connection options
93
+
94
+ | Option | Default | Meaning |
95
+ | --- | --- | --- |
96
+ | `host` | `localhost` | Server hostname or IPv6 address |
97
+ | `port` | `31337` | Warp SQL port (1–65535) |
98
+ | `username`, `password` | unset | Password sign-in |
99
+ | `access_token` | unset | Hardcharger bearer token; omit password credentials |
100
+ | `subject_token` | unset | Trusted identity-provider token for token exchange; omit other credentials |
101
+ | `auth_type` | unset (password) | `password`, `external`, `client_certificate` or `mtls` |
102
+ | `use_encryption` | `true` | HTTPS; false explicitly opts into plain HTTP |
103
+ | `disable_certificate_verification` | `false` | Development-only TLS verification bypass |
104
+ | `tls_root_certs` | unset | PEM CA text or file path |
105
+ | `tls_client_cert`, `tls_client_key` | unset | PEM text or paths for mTLS |
106
+ | `tls_server_name` | unset | Certificate hostname / SNI override |
107
+ | `database` | unset | Existing catalog to select on each new connection |
108
+ | `concurrent_tasks` | `4` | Concurrent SQLMesh tasks |
109
+ | `register_comments` | `true` | Register model comments |
110
+ | `pre_ping` | `false` | Check pooled connections before use |
111
+
112
+ For browser sign-in, set `auth_type: external` and omit username/password/token. For client-certificate sign-in, set `auth_type: client_certificate`, provide the certificate and key, and omit password/token credentials. See the [driver authentication documentation](https://github.com/gizmodata/hardcharger-adbc/tree/main/python).
113
+
114
+ Catalog creation attaches a DuckDB file on the **server**. Dropping a catalog detaches it; it never deletes a file on the client or deletes the server's database file. Manage server files through your server administration process. Materialized views, managed models, SQLMesh grant synchronization and custom `when_matched` logical merge clauses are not advertised by this adapter.
115
+
116
+ ## Development and testing
117
+
118
+ ```bash
119
+ uv sync --extra dev --frozen
120
+ uv run ruff check .
121
+ uv run mypy sqlmesh_hardcharger
122
+ uv run pytest # unit tests
123
+
124
+ # All inherited and Hardcharger-specific integration tests, including DuckLake:
125
+ docker compose -p sqlmesh-hardcharger -f tests/integration/docker/compose.hardcharger.yaml up -d --wait
126
+ POSTGRES_HOST=127.0.0.1 POSTGRES_PORT=55441 uv run pytest -m integration
127
+
128
+ # Current upstream DuckDB and shared engine tests, over a real Hardcharger server:
129
+ uv run python scripts/test-upstream.py
130
+ ```
131
+
132
+ The `hardcharger` development dependency downloads and verifies the released server binary on first use. Override it with `HARDCHARGER_SERVER_BINARY` when testing another build. A server is required for integration tests: they fail instead of silently skipping if it cannot start.
133
+
134
+ All 55 tests from [sqlmesh-gizmosql](https://github.com/gizmodata/sqlmesh-gizmosql/tree/0f4c37e91677b10e0a053cabea812de2ab31403a) are retained. The upstream runner pins SQLMesh v0.236.4 at `f6527ffbd8d54d91e26fab7d36c8f4a061bc6451`, uses the installed SQLMesh package, and replaces connection fixtures without changing assertions. Only the two MotherDuck-specific unit tests are deselected; the upstream suite's own unsupported-feature skips remain visible. Bump the pin and dependency range together when adopting a new SQLMesh API series.
135
+
136
+ CI tests Python 3.11–3.14, runs the upstream compatibility job, checks types and lint, builds the wheel/sdist, and publishes from version tags using PyPI Trusted Publishing with attestations. See [release setup](docs/releasing.md).
137
+
138
+ ## License and origin
139
+
140
+ Apache-2.0. Adapted from GizmoData's SQLMesh GizmoSQL adapter, preserving its Git history and tests. DuckDB engine semantics are inherited from Apache-2.0 SQLMesh. Hardcharger and GizmoData are trademarks of GizmoData.
@@ -0,0 +1,28 @@
1
+ # Publishing sqlmesh-hardcharger
2
+
3
+ ## One-time PyPI setup
4
+
5
+ At https://pypi.org/manage/account/publishing/ add a **pending GitHub publisher**:
6
+
7
+ | Field | Exact value |
8
+ | --- | --- |
9
+ | PyPI project name | `sqlmesh-hardcharger` |
10
+ | GitHub owner | `gizmodata` |
11
+ | Repository name | `sqlmesh-hardcharger` |
12
+ | Workflow filename | `ci.yml` |
13
+ | Environment name | `release` |
14
+
15
+ Enter only the workflow filename, not `.github/workflows/ci.yml`. The GitHub `release` environment exists and accepts `v*` tags. No API token secret is needed. A pending publisher creates the PyPI project on the first successful upload; it does not reserve the name beforehand. After the first publication, manage it at https://pypi.org/manage/project/sqlmesh-hardcharger/settings/publishing/.
16
+
17
+ References: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/ and https://docs.pypi.org/trusted-publishers/adding-a-publisher/.
18
+
19
+ ## Release
20
+
21
+ 1. Update both package versions (`pyproject.toml` and `sqlmesh_hardcharger/__init__.py`), CHANGELOG and `uv.lock`.
22
+ 2. Run CI on `main`, including the complete inherited/regression suite and pinned upstream tests.
23
+ 3. Confirm the trusted publisher above is configured.
24
+ 4. Tag the validated commit (`v1.0.0` for the first release) and push the tag.
25
+ 5. The `ci.yml` workflow reruns tests, builds/checks artifacts, publishes with an OIDC identity and PyPI attestations, then creates the GitHub release.
26
+ 6. Verify a fresh PyPI installation and published metadata/provenance. Update the Hardcharger integrations page only after PyPI publication succeeds.
27
+
28
+ A failed upload can be retried by rerunning the failed job; do not change the tag or attempt to overwrite a published version. Use a new version for changed artifacts.