Skip to main content

SQLBuild

The refactorable warehouse. Verify early, test properly, and refactor safely.

Website · Docs · Quickstart · Roadmap

Change your warehouse as often as your code. SQLBuild brings compile-time checks, tests and safe renames to your SQL, so change stops being risky. It is a free, open-source framework for SQL and Python data pipelines, and it keeps its state in append-only tables in your own warehouse: no external state database, no manifest files and no paid tier.

Moving and renaming an incremental model: sqb plan migrates the existing table instead of rebuilding it

Move an incremental model to a new folder and name, and sqb plan migrates its table instead of rebuilding it.

Quick start

pip install sqlbuild
sqb playground waffle-shop
cd waffle-shop
sqb plan
sqb build
sqb test

The playground runs on local DuckDB, with no warehouse credentials.

What it does

Catch mistakes before anything runs

  • Compile-time checks. SQLBuild resolves references, validates SQL, infers column types, checks contracts and computes column lineage, all offline. A typo'd column fails in seconds, not halfway through a warehouse run.
  • Your conventions as rules. Built-in and custom Python rules turn review comments into compile errors: for example, marts can't read sources directly, or every final model declares its key.

Prove it works

  • Tests across models. SQL tests mock the sources and check the result through every model in between, with macros as test helpers. Macro, UDF and table-function tests are built in.
  • End-to-end scenarios. Build the real graph against fixture data, capture fixtures from the warehouse, and replay them locally on DuckDB in CI. See scenarios.
  • Audits and diffs. Audits run before data reaches the target table, and data diffs compare dev against prod or any query.

Change it without rebuilding everything

  • Renames keep their history. Rename or move an incremental or snapshot model and SQLBuild migrates the existing table instead of rebuilding it.
  • Replay on change. When a model's SQL changes, choose how far back to reprocess, from only the new data to the last 14 days to a full rebuild, with replay_on_change.
  • Macros don't have to be global. Keep macros, enums and constants next to the models that use them, and preview what a move would break with sqb scope. See declaration scopes.
  • Tidy up safely. The janitor archives stale tables before anything is deleted.

Ingestion with Python loaders, and Python tasks, assets and checks, run in the same graph as your SQL models. See the docs for everything else.

In the terminal

Each demo is real output from the example projects in website/examples, running on local DuckDB.

A renamed column breaks the contract

daily_revenue declares contract enforced. Renaming waffles_sold to units_sold in the SELECT fails at compile time, before anything reaches the warehouse.

sqb compile fails because units_sold is not in the enforced contract and the declared waffles_sold column is missing

Both sides are reported: the new column isn't in the contract, and the declared one is gone.

Your own conventions as compile errors

Rules are Python functions in your project. This one, from rules/layers.py, says marts must read sources through staging:

from sqlbuild.rules import Finding, Model, RuleContext, rule


@rule(
    code="XSQBRARCH001",
    message="Marts must read sources through staging",
    remediation="Reference a staging model with __ref() instead.",
)
def marts_use_staging(*, model: Model, ctx: RuleContext) -> list[Finding]:
    layer = ctx.project.tree.relative_parts(path=model.path, under="models")[0]
    sql = ctx.sql.for_model(model).authored.source
    if layer != "marts" or "__source(" not in sql:
        return []
    line = sql[: sql.index("__source(")].count("\n") + 1
    return [ctx.finding(subject=model, line=line)]

A mart that reads __source("raw__payments") directly now fails, and so does the unit test that has no mock for it:

sqb compile reports the custom rule XSQBRARCH001 on the line that reads a raw source, and a unit test with no mock for that source

See rules.

See what a move would break

sqb scope --as-path previews moving a model before you move it.

sqb scope previews moving daily_revenue: the enum and macro it uses would be lost, so both usages are invalidated

Look at Lost and Invalidated usages: the model uses an enum and a macro that are private to models/marts, so moving it would break both.

Example

A model is a SQL file with a MODEL() header and a SELECT:

MODEL (
  description "One row per order",
  materialized table,
  columns (
    order_id (audits [not_null, unique]),
  ),
  tags [marts],
);

SELECT
  o.order_id,
  o.customer_id,
  p.amount_cents AS total_cents
FROM __ref("stg_orders") o
JOIN __ref("stg_payments") p USING (order_id)

A test mocks the sources and asserts on the model, resolving every model in between from its real SQL:

TEST();

WITH
__source__raw__orders AS (
  @mock_orders()
),
__source__raw__payments AS (
  SELECT
    1 AS payment_id,
    1 AS order_id,
    1500 AS amount_cents,
    'credit_card' AS method
),
__expected__fact_orders AS (
  SELECT 1 AS order_id, 100 AS customer_id, 1500 AS total_cents
)
SELECT 1

Warehouses

Warehouse Status
Snowflake Supported
DuckDB Supported
MotherDuck Supported
PostgreSQL Supported
BigQuery Beta
Databricks Beta
SQL Server Beta

Snowflake is the main target. Beta adapters build, test and plan, but have had less production use so far. See adapters.

Free and independent

SQLBuild is Apache 2.0 and will stay free: no paid tier, no commercial edition, and no feature held back for one. Its state lives in your warehouse, next to your data. See the roadmap for what's next.

Contributing

Contributions are welcome. See CONTRIBUTING.md.

License

SQLBuild is licensed under the Apache License 2.0.

Metadata

Release files for sqlbuild 0.133.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sqlbuild 0.133.2
File Size Uploaded Provenance
sqlbuild-0.133.2.tar.gz 2.1 MB With provenance Details

Built distributions (wheels)

Table of built distributions (wheels) for sqlbuild 0.133.2
File
sqlbuild-0.133.2-cp312-abi3-win_amd64.whl CPython 3.12 abi3 Windows x86-64 Details
sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.12 abi3 Linux glibc 2.17+ x86-64 Details
sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.12 abi3 Linux glibc 2.17+ ARM64 Details
sqlbuild-0.133.2-cp312-abi3-macosx_11_0_arm64.whl CPython 3.12 abi3 macOS 11.0+ ARM64 Details
sqlbuild-0.133.2-cp312-abi3-macosx_10_12_x86_64.whl CPython 3.12 abi3 macOS 10.12+ x86-64 Details

Total release size: 83.4 MB

Release files / sqlbuild-0.133.2.tar.gz

Download URL sqlbuild-0.133.2.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
1524106a9267fe60de21a517cb691841c0e916f4c7fe09fb30abe9875a52cb6e
BLAKE2b-256 checksum
How to use checksums
5ee848f682c5fb0f79ef5f704c6753915ccb9a1d95d85f98b3cb652b98c90081
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / sqlbuild-0.133.2-cp312-abi3-win_amd64.whl

Download URL sqlbuild-0.133.2-cp312-abi3-win_amd64.whl
Size 17.1 MB
Tags CPython 3.12 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
569ed5018a543beb10fb65b6108517178d37c5b65660e135243a27cc4247fe0b
BLAKE2b-256 checksum
How to use checksums
dceeb5d230a01f6f1ef4f0187956c5427e4264182b89a99aba3eef2ba3687dc2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 16.5 MB
Tags CPython 3.12 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
6c1abd860bde8ac9bbd89235e4db74d1c3b45f0cbfeae1b6d6b4a0e319f9f987
BLAKE2b-256 checksum
How to use checksums
03d0e251fd6117683be9a98d0a48534fbafce94643b197f30e106eadf309ff7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL sqlbuild-0.133.2-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 15.8 MB
Tags CPython 3.12 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
fc6652721722a1c73f7db42e41a053430ae3bd7e7d93d10ffc4f5570e2e77a83
BLAKE2b-256 checksum
How to use checksums
ea17162811b6095aeab0a2889bced700d0ea5febe21d9277525a9464eae32ac0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / sqlbuild-0.133.2-cp312-abi3-macosx_11_0_arm64.whl

Download URL sqlbuild-0.133.2-cp312-abi3-macosx_11_0_arm64.whl
Size 15.7 MB
Tags CPython 3.12 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
d7ae0df4a221c8e2104031b5fe6a1ed3cd8d5c1acfd7d523c16e18da7de4adea
BLAKE2b-256 checksum
How to use checksums
351b4fd5f944638b9b9dbb7ef13d8440cda6b13771a8f17ca21002bf4472046d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / sqlbuild-0.133.2-cp312-abi3-macosx_10_12_x86_64.whl

Download URL sqlbuild-0.133.2-cp312-abi3-macosx_10_12_x86_64.whl
Size 16.2 MB
Tags CPython 3.12 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
d3f5c4c5edb08bbdb1824076c8a1c0de0c00c7dd068ea31bfdbb8d2364e7b211
BLAKE2b-256 checksum
How to use checksums
6c6d5cf4622d23a28e0ada330649a26f305b5330cd74d2e3430bca0bd6e69957
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Security for sqlbuild 0.133.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for sqlbuild-0.133.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.133.2 This release

6 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page