Skip to content
Open
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
6 changes: 6 additions & 0 deletions docs/howto/vet.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ message Query
message Parameter
{
int32 number = 1;
string name = 2;
}
```

Expand Down Expand Up @@ -69,6 +70,7 @@ sql:
- no-delete
- only-one-param
- no-exec
- no-anonymous-params
rules:
- name: no-pg
message: "invalid engine: postgresql"
Expand All @@ -86,6 +88,10 @@ rules:
message: "don't use exec"
rule: |
query.cmd == "exec"
- name: no-anonymous-params
message: "don't use anonymous parameters"
rule: |
query.params.exists(p, p.name == "")
```

### Rules using `EXPLAIN ...` output
Expand Down
1 change: 1 addition & 0 deletions internal/cmd/vet.go
Original file line number Diff line number Diff line change
Expand Up @@ -693,6 +693,7 @@ func vetQuery(q *plugin.Query) *vet.Query {
for _, p := range q.Params {
params = append(params, &vet.Parameter{
Number: p.Number,
Name: p.Column.GetName(),
})
}
return &vet.Query{
Expand Down
3 changes: 3 additions & 0 deletions internal/endtoend/testdata/vet_anonymous_params/exec.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"command": "vet"
}
7 changes: 7 additions & 0 deletions internal/endtoend/testdata/vet_anonymous_params/query.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
-- name: ListByIDs :many
SELECT id FROM bar
WHERE id = ANY($1::bigint[]);

-- name: GetByID :one
SELECT id FROM bar
WHERE id = $1;
1 change: 1 addition & 0 deletions internal/endtoend/testdata/vet_anonymous_params/schema.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CREATE TABLE bar (id bigserial NOT NULL);
16 changes: 16 additions & 0 deletions internal/endtoend/testdata/vet_anonymous_params/sqlc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
sql:
- schema: "schema.sql"
queries: "query.sql"
engine: "postgresql"
gen:
go:
package: "querytest"
out: "db"
rules:
- no-anonymous-params
rules:
- name: no-anonymous-params
message: "query has an anonymous parameter; name it with sqlc.arg() or @name"
rule: |
query.params.exists(p, p.name == "")
1 change: 1 addition & 0 deletions internal/endtoend/testdata/vet_anonymous_params/stderr.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
query.sql: ListByIDs: no-anonymous-params: query has an anonymous parameter; name it with sqlc.arg() or @name
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"command": "vet"
}
11 changes: 11 additions & 0 deletions internal/endtoend/testdata/vet_anonymous_params_pass/query.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
-- name: GetByInferredName :one
SELECT id FROM bar
WHERE id = $1;

-- name: GetByArg :one
SELECT id FROM bar
WHERE id = sqlc.arg(target_id);

-- name: GetByAtParam :one
SELECT id FROM bar
WHERE id = @min_id;
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CREATE TABLE bar (id bigserial NOT NULL);
16 changes: 16 additions & 0 deletions internal/endtoend/testdata/vet_anonymous_params_pass/sqlc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
version: 2
sql:
- schema: "schema.sql"
queries: "query.sql"
engine: "postgresql"
gen:
go:
package: "querytest"
out: "db"
rules:
- no-anonymous-params
rules:
- name: no-anonymous-params
message: "query has an anonymous parameter; name it with sqlc.arg() or @name"
rule: |
query.params.exists(p, p.name == "")
Empty file.
482 changes: 246 additions & 236 deletions internal/vet/vet.pb.go

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions protos/vet/vet.proto
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package vet;

message Parameter {
int32 number = 1 [json_name = "number"];
string name = 2 [json_name = "name"];
}

message Config {
Expand Down
Loading