Skip to main content

SQLMesh GizmoSQL Adapter

A SQLMesh engine adapter for GizmoSQL - a database server that uses DuckDB as its execution engine and exposes an Arrow Flight SQL interface for remote connections.

sqlmesh-gizmosql-ci Supported Python Versions PyPI version PyPI Downloads

Installation

pip install sqlmesh-gizmosql

This will install sqlmesh and adbc-driver-gizmosql as dependencies.

As of v0.3.0, this adapter runs on adbc-driver-gizmosql 2.0, powered by the new native Go GizmoSQL ADBC driver — same API as before, with DDL/DML immediate execution, RETURNING support, gizmosql:// URIs, and OAuth/SSO provided by the shared Go driver library used across all languages.

Usage

1. Import the adapter

Simply import the package before using SQLMesh. The adapter registers itself automatically:

import sqlmesh_gizmosql  # Registers GizmoSQL adapter
from sqlmesh import Context

context = Context(paths="path/to/project")

2. Configure your connection

Add a GizmoSQL connection to your config.yaml:

gateways:
  my_gizmosql:
    connection:
      type: gizmosql
      host: localhost
      port: 31337
      username: your_username
      password: your_password
      database: my_database  # optional, default catalog
      use_encryption: true   # default: true (uses TLS)
      disable_certificate_verification: false  # for self-signed certs

3. Use SQLMesh as normal

sqlmesh plan
sqlmesh run

Configuration Options

Option Type Default Description
host str localhost GizmoSQL server hostname
port int 31337 GizmoSQL server port
username str None Authentication username (not needed with auth_type: external)
password str None Authentication password (not needed with auth_type: external)
database str None Default database/catalog
use_encryption bool True Use TLS encryption
disable_certificate_verification bool False Skip TLS cert verification
auth_type str None Authentication type (e.g., external for browser-based OAuth/SSO)
concurrent_tasks int 4 Max concurrent tasks
register_comments bool True Register model comments
pre_ping bool False Pre-ping connections

OAuth/SSO Authentication

GizmoSQL supports browser-based OAuth/SSO via auth_type: external. When using external auth, no username or password is needed — a browser window will open for authentication:

gateways:
  my_gizmosql:
    connection:
      type: gizmosql
      host: gizmosql.example.com
      port: 31337
      auth_type: external
      disable_certificate_verification: true  # for self-signed certs

Features

  • Arrow Flight SQL: Efficient data transfer using Arrow's columnar format
  • Full Catalog Support: Create, drop, and switch between databases
  • Transaction Support: Full transaction control via SQL statements
  • ADBC Bulk Ingestion: Fast data loading using Arrow-native bulk operations
  • DuckDB Compatibility: Uses DuckDB SQL dialect for query generation

Requirements

  • Python >= 3.10
  • SQLMesh >= 0.236.1
  • A running GizmoSQL server with DuckDB backend

Development

# Clone the repository
git clone https://github.com/gizmodata/sqlmesh-gizmosql.git
cd sqlmesh-gizmosql

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run linting
ruff check .
mypy sqlmesh_gizmosql

License

Apache 2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlmesh_gizmosql-0.3.0.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlmesh_gizmosql-0.3.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file sqlmesh_gizmosql-0.3.0.tar.gz.

File metadata

  • Download URL: sqlmesh_gizmosql-0.3.0.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sqlmesh_gizmosql-0.3.0.tar.gz
Algorithm Hash digest
SHA256 be4b7cdfe423998dd66566eaabeca8b8c6f736837831af4097cc9bd8675ad98e
MD5 b6e48da3beaeeaedd0d33b38783cecfc
BLAKE2b-256 20a6ceeaea3eb361189505ef772351b9d70d844ef7a158ef483079f8206b3a5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlmesh_gizmosql-0.3.0.tar.gz:

Publisher: ci.yml on gizmodata/sqlmesh-gizmosql

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sqlmesh_gizmosql-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlmesh_gizmosql-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b974ac42aca66fd826ce379d774f5c916b6fb13aa3d0656b3c7f367b366674d6
MD5 356dc746a3f41d428523642ac0226e06
BLAKE2b-256 182f3504ce5bf38b20e52652ab181477284f5dbc6df2aa34b8735037fed9b89e

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlmesh_gizmosql-0.3.0-py3-none-any.whl:

Publisher: ci.yml on gizmodata/sqlmesh-gizmosql

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page