diff --git a/website/public/index.html b/website/public/index.html index 19e30fee54..d4b3f27551 100644 --- a/website/public/index.html +++ b/website/public/index.html @@ -408,13 +408,13 @@
pip install sqlbuild diff --git a/website/public/styles.css b/website/public/styles.css index bf9b218e28..cda5822f58 100644 --- a/website/public/styles.css +++ b/website/public/styles.css @@ -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; diff --git a/website/src/content/docs/docs/concepts/adapters.mdx b/website/src/content/docs/docs/concepts/adapters.mdx index fd0e6a7b1b..82a506cbae 100644 --- a/website/src/content/docs/docs/concepts/adapters.mdx +++ b/website/src/content/docs/docs/concepts/adapters.mdx @@ -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`: diff --git a/website/src/content/docs/docs/concepts/adapters/bigquery.mdx b/website/src/content/docs/docs/concepts/adapters/bigquery.mdx index 8804c3c5e7..3c9ec55a5d 100644 --- a/website/src/content/docs/docs/concepts/adapters/bigquery.mdx +++ b/website/src/content/docs/docs/concepts/adapters/bigquery.mdx @@ -3,6 +3,12 @@ title: "BigQuery" description: "BigQuery adapter configuration for SQLBuild." --- +import Note from '../../../../../components/mintlify/Note.astro'; + ++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). + + BigQuery requires the optional `google-cloud-bigquery` dependency: ```bash diff --git a/website/src/content/docs/docs/concepts/adapters/databricks.mdx b/website/src/content/docs/docs/concepts/adapters/databricks.mdx index dcf8504fef..a1ef6f4f4a 100644 --- a/website/src/content/docs/docs/concepts/adapters/databricks.mdx +++ b/website/src/content/docs/docs/concepts/adapters/databricks.mdx @@ -3,6 +3,12 @@ title: "Databricks" description: "Databricks adapter configuration for SQLBuild." --- +import Note from '../../../../../components/mintlify/Note.astro'; + ++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). + + Databricks requires the optional `databricks-sql-connector` dependency: ```bash diff --git a/website/src/content/docs/docs/concepts/adapters/sqlserver.mdx b/website/src/content/docs/docs/concepts/adapters/sqlserver.mdx index 0d746ed3fe..13f0132d91 100644 --- a/website/src/content/docs/docs/concepts/adapters/sqlserver.mdx +++ b/website/src/content/docs/docs/concepts/adapters/sqlserver.mdx @@ -3,6 +3,12 @@ title: "SQL Server" description: "Microsoft SQL Server adapter configuration for SQLBuild." --- +import Note from '../../../../../components/mintlify/Note.astro'; + ++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). + + SQL Server requires the optional `pymssql` dependency: ```bash diff --git a/website/src/content/docs/docs/roadmap.mdx b/website/src/content/docs/docs/roadmap.mdx new file mode 100644 index 0000000000..691c69a353 --- /dev/null +++ b/website/src/content/docs/docs/roadmap.mdx @@ -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. diff --git a/website/src/navigation.mjs b/website/src/navigation.mjs index b0e003cb0e..fd8f105fb0 100644 --- a/website/src/navigation.mjs +++ b/website/src/navigation.mjs @@ -6,6 +6,7 @@ export const sidebar = [ "docs", "docs/quickstart", "docs/feature-comparison", + "docs/roadmap", "docs/benchmarks" ] }, @@ -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" ] },