diff --git a/docs/index.rst b/docs/index.rst index f71a8c5866..f914f3ec41 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,6 +42,7 @@ code ever again. :hidden: howto/generate.md + howto/push.md howto/verify.md howto/vet.md diff --git a/docs/reference/cli.md b/docs/reference/cli.md index e5872cd2d3..fc244da3ae 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -1,17 +1,18 @@ # CLI -``` +```sh Usage: sqlc [command] Available Commands: compile Statically check SQL for syntax and type errors completion Generate the autocompletion script for the specified shell + createdb Create an ephemeral database diff Compare the generated files to the existing files - generate Generate Go code from SQL + generate Generate source code from SQL help Help about any command init Create an empty sqlc.yaml settings file - push Push schema, queries, and configuration for this project + push Push the schema, queries, and configuration for this project verify Verify schema, queries, and configuration for this project version Print the sqlc version number vet Vet examines queries diff --git a/docs/reference/language-support.rst b/docs/reference/language-support.rst index 37a4e192b6..7e957aae6c 100644 --- a/docs/reference/language-support.rst +++ b/docs/reference/language-support.rst @@ -5,6 +5,7 @@ Database and language support Language Plugin MySQL PostgreSQL SQLite ======== =================== ============ ============ =============== Go (built-in) Stable Stable Beta +Go `sqlc-gen-go`_ Stable Stable Beta Kotlin `sqlc-gen-kotlin`_ Beta Beta Not implemented Python `sqlc-gen-python`_ Beta Beta Not implemented ======== =================== ============ ============ =============== @@ -18,6 +19,7 @@ Language Plugin MySQL PostgreSQL SQLite F# `kaashyapan/sqlc-gen-fsharp`_ Not implemented Beta Beta ======== ============================== =============== ============ =============== +.. _sqlc-gen-go: https://github.com/sqlc-dev/sqlc-gen-go .. _kaashyapan/sqlc-gen-fsharp: https://github.com/kaashyapan/sqlc-gen-fsharp .. _sqlc-gen-kotlin: https://github.com/sqlc-dev/sqlc-gen-kotlin .. _sqlc-gen-python: https://github.com/sqlc-dev/sqlc-gen-python