sqlbuild-cli 0.156.0__py3-none-macosx_10_12_x86_64.whl

sqlbuild_cli-0.156.0.dist-info/METADATA

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: sqlbuild-cli
+Version: 0.156.0
+License-File: LICENSE
+Summary: The native sqb and sqlbuild executables of SQLBuild
+License-Expression: Apache-2.0
+Requires-Python: >=3.12, <3.15
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/chio-labs/sqlbuild/main/.github/sqlbuild-logo-clean.png" alt="SQLBuild" width="100%">
+</p>
+
+<p align="center">
+  <strong>The refactorable warehouse.</strong> Verify early, test properly, and refactor safely.
+</p>
+
+<p align="center">
+  <a href="https://sqlbuild.com">Website</a> ·
+  <a href="https://sqlbuild.com/docs/">Docs</a> ·
+  <a href="https://sqlbuild.com/docs/quickstart/">Quickstart</a> ·
+  <a href="https://sqlbuild.com/docs/roadmap/">Roadmap</a>
+</p>
+
+Change your warehouse as often as your code. SQLBuild brings compile-time checks, end-to-end 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.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/chio-labs/sqlbuild/main/.github/demos/rename.gif" alt="Moving and renaming an incremental model with sqb mv: sqb plan migrates the existing table instead of rebuilding it" width="100%">
+</p>
+
+Move an incremental model to a new folder and name with `sqb mv`, and `sqb plan` migrates its table
+instead of rebuilding it.
+
+## Quick start
+
+```bash
+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](https://sqlbuild.com/docs/concepts/models/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](https://sqlbuild.com/docs/concepts/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](https://sqlbuild.com/docs/concepts/testing/) 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](https://sqlbuild.com/docs/concepts/scenarios/).
+- **Audits and diffs.** Audits run before data reaches the target table, and
+  [data diffs](https://sqlbuild.com/docs/concepts/diff/) compare dev against prod or any query.
+
+### Change it without rebuilding everything
+
+- **Renames keep their history.** [`sqb rename` and `sqb mv`](https://sqlbuild.com/docs/cli/rename/)
+  update every reference, and the next build
+  [migrates](https://sqlbuild.com/docs/concepts/models/migrations/) the existing table instead of
+  rebuilding it. The old name keeps working through a compatibility view.
+  `sqb rename <model>.<column>` renames an incremental model's column in place.
+- **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`](https://sqlbuild.com/docs/concepts/incremental/#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](https://sqlbuild.com/docs/concepts/declaration-scopes/).
+- **Tidy up safely.** The [janitor](https://sqlbuild.com/docs/cli/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](https://sqlbuild.com/docs/) for everything else.
+
+## In the terminal
+
+Each demo is real output from the example projects in [`website/examples`](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.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/chio-labs/sqlbuild/main/.github/demos/contract.gif" alt="sqb compile fails because units_sold is not in the enforced contract and the declared waffles_sold column is missing" width="100%">
+</p>
+
+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`](website/examples/waffle-shop/rules/layers.py), says marts must read sources
+through staging:
+
+```python
+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:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/chio-labs/sqlbuild/main/.github/demos/rules.gif" alt="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" width="100%">
+</p>
+
+See [rules](https://sqlbuild.com/docs/concepts/rules/).
+
+### See what a move would break
+
+`sqb scope --as-path` previews moving a model before you move it.
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/chio-labs/sqlbuild/main/.github/demos/scope.gif" alt="sqb scope previews moving daily_revenue: the enum and macro it uses would be lost, so both usages are invalidated" width="100%">
+</p>
+
+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`:
+
+```sql
+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,
+  @cents_to_dollars("p.amount_cents") AS total_dollars
+FROM __ref("stg_orders") o
+JOIN __ref("stg_payments") p USING (order_id)
+```
+
+Macros are plain Python functions that return SQL, kept next to the models that use them:
+
+```python
+# models/marts/_sqlbuild/_macros/currency.py
+def cents_to_dollars(column: str) -> str:
+    """Convert a cents integer column to a dollars decimal with two decimal places."""
+    return f"ROUND(({column}) / 100.0, 2)"
+```
+
+A test mocks the sources and asserts on the model, resolving every model in between from its real
+SQL:
+
+```sql
+TEST();
+
+WITH
+__source__raw__orders AS (
+  SELECT
+    1 AS id,
+    100 AS customer_id,
+    2 AS waffle_type_id,
+    3 AS quantity,
+    CAST('2026-04-01 10:00:00' AS TIMESTAMP) AS ordered_at,
+    'completed' AS status
+),
+__source__raw__payments AS (
+  SELECT
+    10 AS id,
+    1 AS order_id,
+    1500 AS amount_cents,
+    'credit_card' AS payment_method,
+    CAST('2026-04-01 10:05:00' AS TIMESTAMP) AS paid_at,
+    'success' AS status
+),
+__expected__fact_orders AS (
+  SELECT 1 AS order_id, 100 AS customer_id, 1500 AS total_cents, 15.00 AS total_dollars
+)
+```
+
+## 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](https://sqlbuild.com/docs/concepts/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](https://sqlbuild.com/docs/roadmap/) for what's next.
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+SQLBuild is licensed under the [Apache License 2.0](LICENSE).
+

sqlbuild_cli-0.156.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+sqlbuild_cli-0.156.0.data/scripts/sqb,sha256=4G_A0R5RXsd2u2iuW_Su0u3WNbP5XsTCGhkp-RvCZl0,1135136
+sqlbuild_cli-0.156.0.data/scripts/sqlbuild,sha256=zShq9sxs8Ph9wWMp5Tz-IUJ-4zyUnapvzEsRpbe4nVo,1135136
+sqlbuild_cli-0.156.0.dist-info/METADATA,sha256=HXOrLbyxZRqNlUy9mb37htcaAggWl5ENj_wUmw7-oDM,8937
+sqlbuild_cli-0.156.0.dist-info/WHEEL,sha256=lydvCcUfNMjZsH7TcDaQbgngdhXqm4ws-SEf1zfNtck,104
+sqlbuild_cli-0.156.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sqlbuild_cli-0.156.0.dist-info/sboms/sqlbuild-cli.cyclonedx.json,sha256=8AAEbIRCkaGaQHZ1i0pbMCJ2LbzP4p9Odvf1xRka9BM,70933
+sqlbuild_cli-0.156.0.dist-info/RECORD,,

sqlbuild_cli-0.156.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-macosx_10_12_x86_64

sqlbuild_cli-0.156.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.