From f50d8207dcc466fa6adec7b687c66c939d71ebbb Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 27 Aug 2026 17:11:11 +0000 Subject: [PATCH] docs: note that analyze, parse and fmt are in beta Add a GitHub alert at the top of each command's page so readers know the flags and output are still subject to change, and that fmt rewrites query files in place. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01DnqiFw1XAw6b14bSf1GQZb --- docs/howto/analyze.md | 5 +++++ docs/howto/fmt.md | 5 +++++ docs/howto/parse.md | 4 ++++ 3 files changed, 14 insertions(+) diff --git a/docs/howto/analyze.md b/docs/howto/analyze.md index 778eb20212..e7c2c66b41 100644 --- a/docs/howto/analyze.md +++ b/docs/howto/analyze.md @@ -1,5 +1,10 @@ # `analyze` - Analyzing query result types +> [!NOTE] +> `analyze` is in beta. Its flags and JSON output may change in a +> future release, and the types it reports can differ from the ones +> `generate` produces. + `sqlc analyze` analyzes a query against a schema and prints the inferred result columns and parameters as a single JSON document. diff --git a/docs/howto/fmt.md b/docs/howto/fmt.md index 1d874b40b1..5840d48acf 100644 --- a/docs/howto/fmt.md +++ b/docs/howto/fmt.md @@ -1,5 +1,10 @@ # `fmt` - Formatting queries +> [!NOTE] +> `fmt` is in beta. It rewrites your query files in place, so commit +> or back them up first. The formatting it produces may change in a +> future release. + `sqlc fmt` rewrites the query files referenced by your configuration file in a canonical format. Each query is parsed with the engine's parser and printed back from the syntax tree, so formatting never depends on how the query was diff --git a/docs/howto/parse.md b/docs/howto/parse.md index d8ebe59c97..2227c1f2b6 100644 --- a/docs/howto/parse.md +++ b/docs/howto/parse.md @@ -1,5 +1,9 @@ # `parse` - Parsing SQL into an AST +> [!NOTE] +> `parse` is in beta. Its flags and the shape of the JSON AST it +> prints may change in a future release. + `sqlc parse` parses SQL from a file or standard input and prints the abstract syntax tree (AST) as a single JSON document. It does not require a configuration file or a database connection.