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
5 changes: 5 additions & 0 deletions docs/howto/analyze.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
5 changes: 5 additions & 0 deletions docs/howto/fmt.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/howto/parse.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down