Skip to content

Commit 6d3cdc2

Browse files
docs: small updates (#2506)
- 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
1 parent 51f1808 commit 6d3cdc2

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

docs/howto/vet.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ sql:
147147
- schema: "query.sql"
148148
queries: "query.sql"
149149
engine: "postgresql"
150+
database:
151+
uri: "postgresql://postgres:postgres@localhost:5432/postgres"
150152
gen:
151153
go:
152154
package: "db"
@@ -155,8 +157,7 @@ sql:
155157
- debug
156158
rules:
157159
- name: debug
158-
message: "Debug"
159-
rule: has(postgresql.explain)
160+
rule: "!has(postgresql.explain)" # A dummy rule to trigger explain
160161
```
161162

162163
Please note that `sqlc` does not manage or migrate your database. Use your

docs/reference/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ The `gen` mapping supports the following keys:
148148
- If true, "Id" in json tags will be uppercase. If false, will be camelcase. Defaults to `false`
149149
- `json_tags_case_style`:
150150
- `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
151+
- `omit_unused_structs`:
152+
- If `true`, sqlc won't generate table and enum structs that aren't used in queries for a given package. Defaults to `false`.
151153
- `output_batch_file_name`:
152154
- Customize the name of the batch file. Defaults to `batch.go`.
153155
- `output_db_file_name`:
@@ -456,6 +458,7 @@ packages:
456458
emit_enum_valid_method: false
457459
emit_all_enum_values: false
458460
json_tags_case_style: "camel"
461+
omit_unused_structs: false
459462
output_batch_file_name: "batch.go"
460463
output_db_file_name: "db.go"
461464
output_models_file_name: "models.go"
@@ -508,6 +511,8 @@ Each mapping in the `packages` collection has the following keys:
508511
that returns all valid enum values.
509512
- `json_tags_case_style`:
510513
- `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
514+
- `omit_unused_structs`:
515+
- If `true`, sqlc won't generate table and enum structs that aren't used in queries for a given package. Defaults to `false`.
511516
- `output_batch_file_name`:
512517
- Customize the name of the batch file. Defaults to `batch.go`.
513518
- `output_db_file_name`:

0 commit comments

Comments
 (0)