Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions website/public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -408,13 +408,13 @@ <h2>Start simple</h2>
<li>Free and open source, with no paid tier.</li>
</ul>
<div class="adapters" aria-label="Supported warehouses">
<span>Snowflake</span>
<span>DuckDB</span>
<span>MotherDuck</span>
<span>Snowflake</span>
<span>BigQuery</span>
<span>Databricks</span>
<span>PostgreSQL</span>
<span>SQL Server</span>
<span>BigQuery <small>Beta</small></span>
<span>Databricks <small>Beta</small></span>
<span>SQL Server <small>Beta</small></span>
</div>
</div>
<pre class="terminal"><span class="cmd">pip install sqlbuild</span>
Expand Down
9 changes: 9 additions & 0 deletions website/public/styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,15 @@ h3 {
font-size: 13px;
}

.adapters small {
margin-left: 4px;
color: var(--muted-foreground);
font-size: 11px;
font-weight: 600;
letter-spacing: 0.04em;
text-transform: uppercase;
}

/* Closing call to action */
.closing {
padding: 88px 0 96px;
Expand Down
23 changes: 13 additions & 10 deletions website/src/content/docs/docs/concepts/adapters.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,25 @@ title: "Overview"
description: "Supported database engines and their connection configuration."
---

SQLBuild uses adapters to connect to different database engines.
SQLBuild uses adapters to connect to different database engines. Snowflake is the main target.

- **Supported:** ready for production use.
- **Beta:** builds, tests and plans work, but with less production use so far. Expect rough edges, and please [report issues](https://github.com/chio-labs/sqlbuild/issues).

| Adapter | Status | Install |
|---------|--------|---------|
| [Snowflake](/docs/concepts/adapters/snowflake) | Supported | `sqlbuild[snowflake]` |
| [DuckDB](/docs/concepts/adapters/duckdb) | Supported | included by default |
| [MotherDuck](/docs/concepts/adapters/motherduck) | Supported | included by default (uses DuckDB) |
| [Snowflake](/docs/concepts/adapters/snowflake) | Supported | `sqlbuild[snowflake]` |
| [BigQuery](/docs/concepts/adapters/bigquery) | Supported | `sqlbuild[bigquery]` |
| [Databricks](/docs/concepts/adapters/databricks) | Supported | `sqlbuild[databricks]` |
| [PostgreSQL](/docs/concepts/adapters/postgres) | Supported | `sqlbuild[postgres]` |
| [SQL Server](/docs/concepts/adapters/sqlserver) | Supported | `sqlbuild[sqlserver]` |
| ClickHouse | Coming soon | |
| Redshift | Coming soon | |
| Trino | Coming soon | |
| Spark | Coming soon | |
| Athena | Coming soon | |
| [BigQuery](/docs/concepts/adapters/bigquery) | Beta | `sqlbuild[bigquery]` |
| [Databricks](/docs/concepts/adapters/databricks) | Beta | `sqlbuild[databricks]` |
| [SQL Server](/docs/concepts/adapters/sqlserver) | Beta | `sqlbuild[sqlserver]` |
| ClickHouse | Planned | |
| Redshift | Planned | |
| Trino | Planned | |
| Spark | Planned | |
| Athena | Planned | |

Set the adapter in `sqlbuild_project.toml`:

Expand Down
6 changes: 6 additions & 0 deletions website/src/content/docs/docs/concepts/adapters/bigquery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: "BigQuery"
description: "BigQuery adapter configuration for SQLBuild."
---

import Note from '../../../../../components/mintlify/Note.astro';

<Note>
The BigQuery adapter is in beta: builds, tests and plans work, but it has had less production use so far. Please [report issues](https://github.com/chio-labs/sqlbuild/issues).
</Note>

BigQuery requires the optional `google-cloud-bigquery` dependency:

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: "Databricks"
description: "Databricks adapter configuration for SQLBuild."
---

import Note from '../../../../../components/mintlify/Note.astro';

<Note>
The Databricks adapter is in beta: builds, tests and plans work, but it has had less production use so far. Please [report issues](https://github.com/chio-labs/sqlbuild/issues).
</Note>

Databricks requires the optional `databricks-sql-connector` dependency:

```bash
Expand Down
6 changes: 6 additions & 0 deletions website/src/content/docs/docs/concepts/adapters/sqlserver.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: "SQL Server"
description: "Microsoft SQL Server adapter configuration for SQLBuild."
---

import Note from '../../../../../components/mintlify/Note.astro';

<Note>
The SQL Server adapter is in beta: builds, tests and plans work, but it has had less production use so far. Please [report issues](https://github.com/chio-labs/sqlbuild/issues).
</Note>

SQL Server requires the optional `pymssql` dependency:

```bash
Expand Down
27 changes: 27 additions & 0 deletions website/src/content/docs/docs/roadmap.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Roadmap"
description: "What's coming next in SQLBuild."
---

SQLBuild is free and open source, and will stay that way. There is no paid tier, no commercial edition
and no feature held back for one. Everything below ships in the open-source project and works on its own.

## Next: the SQLBuild UI

A self-hosted web app for your SQLBuild project:

- Browse models, lineage and column types.
- Follow runs, tests and audits as they happen.
- Run builds and set them on a schedule.
- See what your builds cost.
- Sign in with SSO, with fine-grained permissions and audit logs.

## Later

- Moving BigQuery, Databricks and SQL Server from beta to supported.
- More warehouses, such as ClickHouse, Redshift and Trino.

## Not planned

- **Virtual environments.** They add a lot of complexity, and most of what they offer can be done more
simply in other ways, without the need for an external state store.
5 changes: 3 additions & 2 deletions website/src/navigation.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export const sidebar = [
"docs",
"docs/quickstart",
"docs/feature-comparison",
"docs/roadmap",
"docs/benchmarks"
]
},
Expand All @@ -27,12 +28,12 @@ export const sidebar = [
"collapsed": true,
"items": [
"docs/concepts/adapters",
"docs/concepts/adapters/snowflake",
"docs/concepts/adapters/duckdb",
"docs/concepts/adapters/motherduck",
"docs/concepts/adapters/snowflake",
"docs/concepts/adapters/postgres",
"docs/concepts/adapters/bigquery",
"docs/concepts/adapters/databricks",
"docs/concepts/adapters/postgres",
"docs/concepts/adapters/sqlserver"
]
},
Expand Down
Loading