From d6d5a07f8b566fc0d81cc577613d2925b5dfaa8b Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 17 Sep 2026 19:41:59 +1000 Subject: [PATCH] docs: group landing page examples under an Example Queries heading Add an "Example Queries" H2 with an intro sentence to the `snowflake` provider landing page so the existing example sections nest under a single ToC entry (matching the clickhouse microsite), and regenerate the website landing page. Co-Authored-By: Claude Fable 5.1 --- .../docgen/provider-data/headerContent2.txt | 14 +++++++++----- website/docs/index.md | 14 +++++++++----- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index e4beb2e..683c0f4 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -63,7 +63,11 @@ stackql.exe shell --auth=$Auth ``` -## Database inventory +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Database inventory All databases in the account, with ownership and retention settings: @@ -79,7 +83,7 @@ WHERE endpoint = 'myorg-myaccount' ORDER BY name; ``` -## Grant audit +### Grant audit Grants are REST resources - granting is an `INSERT`, revoking is a `DELETE`, and auditing is a `SELECT`. Every grant held by a role, straight from the account: @@ -98,7 +102,7 @@ AND endpoint = 'myorg-myaccount'; Repeat per grantee (`role`, `user`, `database-role`, `application-role`, `share`) to audit the whole account - no state file to drift, nothing to reconcile. -## Declarative warehouse definition +### Declarative warehouse definition `REPLACE` maps to Snowflake's `CREATE OR ALTER` semantics - the statement below creates the warehouse if it does not exist, or alters it to match if it does. Idempotent and re-runnable, no state required: @@ -113,7 +117,7 @@ WHERE warehouse_name = 'REPORTING_WH' AND endpoint = 'myorg-myaccount'; ``` -## Cortex AI inference +### Cortex AI inference Cortex inference is a `SELECT` - `WHERE` members feed the request body, and the completion projects as columns. The OpenAI-compatible and Anthropic-compatible endpoints are both available: @@ -130,7 +134,7 @@ AND endpoint = 'myorg-myaccount'; > Streaming (SSE) responses are out of scope; completions return in JSON mode. Model availability varies by account and region. -## Data plane: submit a statement +### Data plane: submit a statement Statement submission is an `INSERT` with a `RETURNING` clause - inventory the control plane and query the data inside it in the same session: diff --git a/website/docs/index.md b/website/docs/index.md index c6e681e..89e089e 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -91,7 +91,11 @@ stackql.exe shell --auth=$Auth ``` -## Database inventory +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Database inventory All databases in the account, with ownership and retention settings: @@ -107,7 +111,7 @@ WHERE endpoint = 'myorg-myaccount' ORDER BY name; ``` -## Grant audit +### Grant audit Grants are REST resources - granting is an `INSERT`, revoking is a `DELETE`, and auditing is a `SELECT`. Every grant held by a role, straight from the account: @@ -126,7 +130,7 @@ AND endpoint = 'myorg-myaccount'; Repeat per grantee (`role`, `user`, `database-role`, `application-role`, `share`) to audit the whole account - no state file to drift, nothing to reconcile. -## Declarative warehouse definition +### Declarative warehouse definition `REPLACE` maps to Snowflake's `CREATE OR ALTER` semantics - the statement below creates the warehouse if it does not exist, or alters it to match if it does. Idempotent and re-runnable, no state required: @@ -141,7 +145,7 @@ WHERE warehouse_name = 'REPORTING_WH' AND endpoint = 'myorg-myaccount'; ``` -## Cortex AI inference +### Cortex AI inference Cortex inference is a `SELECT` - `WHERE` members feed the request body, and the completion projects as columns. The OpenAI-compatible and Anthropic-compatible endpoints are both available: @@ -158,7 +162,7 @@ AND endpoint = 'myorg-myaccount'; > Streaming (SSE) responses are out of scope; completions return in JSON mode. Model availability varies by account and region. -## Data plane: submit a statement +### Data plane: submit a statement Statement submission is an `INSERT` with a `RETURNING` clause - inventory the control plane and query the data inside it in the same session: