Skip to content

Allow for mixed parameters types ($1 or ?) and sqlc.arg() #1072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 15, 2021
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
39 changes: 29 additions & 10 deletions internal/compiler/parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"sort"
"strings"

"github.com/kyleconroy/sqlc/internal/config"
"github.com/kyleconroy/sqlc/internal/debug"
"github.com/kyleconroy/sqlc/internal/metadata"
"github.com/kyleconroy/sqlc/internal/opts"
Expand Down Expand Up @@ -37,7 +38,8 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
if err := validate.ParamStyle(stmt); err != nil {
return nil, err
}
if err := validate.ParamRef(stmt); err != nil {
numbers, dollar, err := validate.ParamRef(stmt)
if err != nil {
return nil, err
}
raw, ok := stmt.(*ast.RawStmt)
Expand Down Expand Up @@ -75,7 +77,7 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
return nil, err
}

raw, namedParams, edits := rewrite.NamedParameters(c.conf.Engine, raw)
raw, namedParams, edits := rewrite.NamedParameters(c.conf.Engine, raw, numbers, dollar)
rvs := rangeVars(raw.Stmt)
refs := findParameters(raw.Stmt)
if o.UsePositionalParameters {
Expand All @@ -84,8 +86,12 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
return nil, err
}
} else {
refs = uniqueParamRefs(refs)
sort.Slice(refs, func(i, j int) bool { return refs[i].ref.Number < refs[j].ref.Number })
refs = uniqueParamRefs(refs, dollar)
if c.conf.Engine == config.EngineMySQL || !dollar {
sort.Slice(refs, func(i, j int) bool { return refs[i].ref.Location < refs[j].ref.Location })
} else {
sort.Slice(refs, func(i, j int) bool { return refs[i].ref.Number < refs[j].ref.Number })
}
}
qc, err := buildQueryCatalog(c.catalog, raw.Stmt)
if err != nil {
Expand Down Expand Up @@ -122,7 +128,6 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
if err != nil {
return nil, err
}

return &Query{
Cmd: cmd,
Comments: comments,
Expand All @@ -145,13 +150,27 @@ func rangeVars(root ast.Node) []*ast.RangeVar {
return vars
}

func uniqueParamRefs(in []paramRef) []paramRef {
m := make(map[int]struct{}, len(in))
func uniqueParamRefs(in []paramRef, dollar bool) []paramRef {
m := make(map[int]bool, len(in))
o := make([]paramRef, 0, len(in))
for _, v := range in {
if _, ok := m[v.ref.Number]; !ok {
m[v.ref.Number] = struct{}{}
o = append(o, v)
if !m[v.ref.Number] {
m[v.ref.Number] = true
if v.ref.Number != 0 {
o = append(o, v)
}
}
}
if !dollar {
start := 1
for _, v := range in {
if v.ref.Number == 0 {
for m[start] {
start++
}
v.ref.Number = start
o = append(o, v)
}
}
}
return o
Expand Down
2 changes: 1 addition & 1 deletion internal/endtoend/testdata/invalid_params/pgx/stderr.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
query.sql:4:1: could not determine data type of parameter $1
query.sql:7:1: could not determine data type of parameter $2
query.sql:10:8: column "foo" does not exist
query.sql:13:1: query mixes positional parameters ($1) and named parameters (sqlc.arg or @arg)
query.sql:13:1: could not determine data type of parameter $2
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
query.sql:4:1: could not determine data type of parameter $1
query.sql:7:1: could not determine data type of parameter $2
query.sql:10:8: column "foo" does not exist
query.sql:13:1: query mixes positional parameters ($1) and named parameters (sqlc.arg or @arg)
query.sql:13:1: could not determine data type of parameter $2
29 changes: 29 additions & 0 deletions internal/endtoend/testdata/mix_param_types/mysql/go/db.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions internal/endtoend/testdata/mix_param_types/mysql/go/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

57 changes: 57 additions & 0 deletions internal/endtoend/testdata/mix_param_types/mysql/go/test.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions internal/endtoend/testdata/mix_param_types/mysql/sqlc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "1",
"packages": [
{
"path": "go",
"name": "querytest",
"schema": "test.sql",
"queries": "test.sql",
"engine": "mysql"
}
]
}
14 changes: 14 additions & 0 deletions internal/endtoend/testdata/mix_param_types/mysql/test.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
CREATE TABLE bar (
id serial not null,
name text not null,
phone text not null
);

-- name: CountOne :one
SELECT count(1) FROM bar WHERE id = sqlc.arg(id) AND name <> ?;

-- name: CountTwo :one
SELECT count(1) FROM bar WHERE id = ? AND name <> sqlc.arg(name);

-- name: CountThree :one
SELECT count(1) FROM bar WHERE id > ? AND phone <> sqlc.arg(phone) AND name <> ?;
29 changes: 29 additions & 0 deletions internal/endtoend/testdata/mix_param_types/postgresql/go/db.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions internal/endtoend/testdata/mix_param_types/postgresql/go/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions internal/endtoend/testdata/mix_param_types/postgresql/sqlc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "1",
"packages": [
{
"path": "go",
"name": "querytest",
"schema": "test.sql",
"queries": "test.sql",
"engine": "postgresql"
}
]
}
17 changes: 17 additions & 0 deletions internal/endtoend/testdata/mix_param_types/postgresql/test.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
CREATE TABLE bar (
id serial not null,
name text not null,
phone text not null
);

-- name: CountOne :one
SELECT count(1) FROM bar WHERE id = sqlc.arg(id) AND name <> $1 LIMIT sqlc.arg('limit');

-- name: CountTwo :one
SELECT count(1) FROM bar WHERE id = $1 AND name <> sqlc.arg(name);

-- name: CountThree :one
SELECT count(1) FROM bar WHERE id > $2 AND phone <> sqlc.arg(phone) AND name <> $1;

-- name: CountFour :one
SELECT count(1) FROM bar WHERE id > ? AND phone <> sqlc.arg(phone) AND name <> ?;
4 changes: 2 additions & 2 deletions internal/endtoend/testdata/sqlc_arg_invalid/mysql/stderr.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# package querytest
query.sql:7:1: function "sqlc.argh" does not exist
query.sql:10:45: expected 1 parameter to sqlc.arg; got 2
query.sql:13:45: expected parameter to sqlc.arg to be string or reference; got *ast.FuncCall
query.sql:16:1: query mixes positional parameters ($1) and named parameters (sqlc.arg or @arg)
query.sql:13:54: Invalid argument to sqlc.arg()
query.sql:16:54: Invalid argument to sqlc.arg()
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# package querytest
query.sql:7:1: function "sqlc.argh" does not exist
query.sql:10:45: expected 1 parameter to sqlc.arg; got 2
query.sql:13:45: expected parameter to sqlc.arg to be string or reference; got *ast.FuncCall
query.sql:16:1: query mixes positional parameters ($1) and named parameters (sqlc.arg or @arg)
query.sql:13:54: Invalid argument to sqlc.arg()
query.sql:16:54: Invalid argument to sqlc.arg()
Loading