From 80b5842969c5684a9fece2b2ba2f71d97f30ed09 Mon Sep 17 00:00:00 2001
From: Andrew Benton <andrew@sqlc.dev>
Date: Mon, 24 Jul 2023 14:13:18 -0400
Subject: [PATCH] docs: small updates

- add `database` configuration for sqlc vet debug example
- alter the rule for sqlc vet debug example to make it not fail
- add undocumented `omit_unused_structs` flag to config docs
---
 docs/howto/vet.md        | 5 +++--
 docs/reference/config.md | 5 +++++
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/docs/howto/vet.md b/docs/howto/vet.md
index 38b3269a88..e3bf05a3b1 100644
--- a/docs/howto/vet.md
+++ b/docs/howto/vet.md
@@ -147,6 +147,8 @@ sql:
   - schema: "query.sql"
     queries: "query.sql"
     engine: "postgresql"
+    database:
+      uri: "postgresql://postgres:postgres@localhost:5432/postgres"
     gen:
       go:
         package: "db"
@@ -155,8 +157,7 @@ sql:
       - debug
 rules:
 - name: debug
-  message: "Debug"
-  rule: has(postgresql.explain)
+  rule: "!has(postgresql.explain)" # A dummy rule to trigger explain
 ```
 
 Please note that `sqlc` does not manage or migrate your database. Use your
diff --git a/docs/reference/config.md b/docs/reference/config.md
index b23af00937..b9d4e85f13 100644
--- a/docs/reference/config.md
+++ b/docs/reference/config.md
@@ -148,6 +148,8 @@ The `gen` mapping supports the following keys:
   - If true, "Id" in json tags will be uppercase. If false, will be camelcase. Defaults to `false`
 - `json_tags_case_style`:
   - `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
+- `omit_unused_structs`:
+  - If `true`, sqlc won't generate table and enum structs that aren't used in queries for a given package. Defaults to `false`.
 - `output_batch_file_name`:
   - Customize the name of the batch file. Defaults to `batch.go`.
 - `output_db_file_name`:
@@ -456,6 +458,7 @@ packages:
     emit_enum_valid_method: false
     emit_all_enum_values: false
     json_tags_case_style: "camel"
+    omit_unused_structs: false
     output_batch_file_name: "batch.go"
     output_db_file_name: "db.go"
     output_models_file_name: "models.go"
@@ -508,6 +511,8 @@ Each mapping in the `packages` collection has the following keys:
     that returns all valid enum values.
 - `json_tags_case_style`:
   - `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
+- `omit_unused_structs`:
+  - If `true`, sqlc won't generate table and enum structs that aren't used in queries for a given package. Defaults to `false`.
 - `output_batch_file_name`:
   - Customize the name of the batch file. Defaults to `batch.go`.
 - `output_db_file_name`: