Skip to content

UPDATED: sqlc.narg() - allow user-specified nullability #1536

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.

Sign up for GitHub

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 12 commits into from
Apr 30, 2022
Merged

UPDATED: sqlc.narg() - allow user-specified nullability #1536

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8ee0ea8
refactor named parameters to use specific type
skabbes Apr 7, 2022
48598af
refactor rewrite.NamedParameters to use types
skabbes Apr 7, 2022
5095f2e
add "inferred null" vs "user defined null"
skabbes Apr 9, 2022
0d480bc
test: add tests for named.Param
skabbes Apr 9, 2022
20be86b
implement nullability overrides with `!` and `?` suffixes
skabbes Apr 9, 2022
2c5239e
test: add tests for optional and required parameters
skabbes Apr 9, 2022
b95ee5f
add named.ParamSet to represent a set of parameters in a query
skabbes Apr 9, 2022
6dd44da
Merge branch 'main' into sqlc_arg_nullable
skabbes Apr 30, 2022
a7fa41c
revert sqlc.arg tests with `!?`
skabbes Apr 30, 2022
e4c23a3
add sqlc.narg for params users can override to nullable
skabbes Apr 30, 2022
a19061a
add end-to-end test for sqlc.narg
skabbes Apr 30, 2022
8a9dfab
commit generated output for sqlc.narg
skabbes Apr 30, 2022
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
1 change: 1 addition & 0 deletions internal/compiler/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ func (c *Compiler) parseQuery(stmt ast.Node, src string, o opts.Parser) (*Query,
if err != nil {
return nil, err
}

params, err := c.resolveCatalogRefs(qc, rvs, refs, namedParams)
if err != nil {
return nil, err
Expand Down
92 changes: 54 additions & 38 deletions internal/compiler/resolve.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/kyleconroy/sqlc/internal/sql/ast"
"github.com/kyleconroy/sqlc/internal/sql/astutils"
"github.com/kyleconroy/sqlc/internal/sql/catalog"
"github.com/kyleconroy/sqlc/internal/sql/named"
"github.com/kyleconroy/sqlc/internal/sql/sqlerr"
)

Expand All @@ -18,26 +19,14 @@ func dataType(n *ast.TypeName) string {
}
}

func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar, args []paramRef, names map[int]string) ([]Parameter, error) {
func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar, args []paramRef, params *named.ParamSet) ([]Parameter, error) {
c := comp.catalog

aliasMap := map[string]*ast.TableName{}
// TODO: Deprecate defaultTable
var defaultTable *ast.TableName
var tables []*ast.TableName

parameterName := func(n int, defaultName string) string {
if n, ok := names[n]; ok {
return n
}
return defaultName
}

isNamedParam := func(n int) bool {
_, ok := names[n]
return ok
}

typeMap := map[string]map[string]map[string]*catalog.Column{}
indexTable := func(table catalog.Table) error {
tables = append(tables, table.Rel)
Expand Down Expand Up @@ -92,24 +81,28 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
switch n := ref.parent.(type) {

case *limitOffset:
defaultP := named.NewInferredParam("offset", true)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, "offset"),
Name: p.Name(),
DataType: "integer",
NotNull: true,
IsNamedParam: isNamedParam(ref.ref.Number),
NotNull: p.NotNull(),
IsNamedParam: isNamed,
},
})

case *limitCount:
defaultP := named.NewInferredParam("limit", true)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, "limit"),
Name: p.Name(),
DataType: "integer",
NotNull: true,
IsNamedParam: isNamedParam(ref.ref.Number),
NotNull: p.NotNull(),
IsNamedParam: isNamed,
},
})

Expand All @@ -127,12 +120,16 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
if astutils.Join(n.Name, ".") == "||" {
dataType = "string"
}

defaultP := named.NewUnspecifiedParam("")
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, ""),
Name: p.Name(),
DataType: dataType,
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
NotNull: p.NotNull(),
},
})
continue
Expand Down Expand Up @@ -185,16 +182,19 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
if ref.name != "" {
key = ref.name
}

defaultP := named.NewInferredParam(key, c.IsNotNull)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, key),
Name: p.Name(),
DataType: dataType(&c.Type),
NotNull: c.IsNotNull,
NotNull: p.NotNull(),
IsArray: c.IsArray,
Length: c.Length,
Table: table,
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
},
})
}
Expand Down Expand Up @@ -242,15 +242,17 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
}

if c, ok := typeMap[schema][table.Name][key]; ok {
defaultP := named.NewInferredParam(key, c.IsNotNull)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: number,
Column: &Column{
Name: parameterName(ref.ref.Number, key),
Name: p.Name(),
DataType: dataType(&c.Type),
NotNull: c.IsNotNull,
NotNull: p.NotNull(),
IsArray: c.IsArray,
Table: table,
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
},
})
}
Expand Down Expand Up @@ -309,12 +311,16 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
if argName != "" {
defaultName = argName
}

defaultP := named.NewInferredParam(defaultName, false)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, defaultName),
Name: p.Name(),
DataType: "any",
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
NotNull: p.NotNull(),
},
})
continue
Expand All @@ -340,13 +346,15 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
paramName = funcName
}

defaultP := named.NewInferredParam(paramName, true)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, paramName),
Name: p.Name(),
DataType: dataType(paramType),
NotNull: true,
IsNamedParam: isNamedParam(ref.ref.Number),
NotNull: p.NotNull(),
IsNamedParam: isNamed,
},
})
}
Expand Down Expand Up @@ -399,16 +407,18 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
}

if c, ok := tableMap[key]; ok {
defaultP := named.NewInferredParam(key, c.IsNotNull)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: ref.ref.Number,
Column: &Column{
Name: parameterName(ref.ref.Number, key),
Name: p.Name(),
DataType: dataType(&c.Type),
NotNull: c.IsNotNull,
NotNull: p.NotNull(),
IsArray: c.IsArray,
Table: &ast.TableName{Schema: schema, Name: rel},
Length: c.Length,
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
},
})
} else {
Expand All @@ -424,7 +434,11 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
return nil, fmt.Errorf("*ast.TypeCast has nil type name")
}
col := toColumn(n.TypeName)
col.Name = parameterName(ref.ref.Number, col.Name)
defaultP := named.NewInferredParam(col.Name, col.NotNull)
p, _ := params.FetchMerge(ref.ref.Number, defaultP)

col.Name = p.Name()
col.NotNull = p.NotNull()
a = append(a, Parameter{
Number: ref.ref.Number,
Column: col,
Expand Down Expand Up @@ -500,15 +514,17 @@ func (comp *Compiler) resolveCatalogRefs(qc *QueryCatalog, rvs []*ast.RangeVar,
if ref.name != "" {
key = ref.name
}
defaultP := named.NewInferredParam(key, c.IsNotNull)
p, isNamed := params.FetchMerge(ref.ref.Number, defaultP)
a = append(a, Parameter{
Number: number,
Column: &Column{
Name: parameterName(ref.ref.Number, key),
Name: p.Name(),
DataType: dataType(&c.Type),
NotNull: c.IsNotNull,
IsArray: c.IsArray,
Table: table,
IsNamedParam: isNamedParam(ref.ref.Number),
IsNamedParam: isNamed,
},
})
}
Expand Down
7 changes: 5 additions & 2 deletions internal/endtoend/testdata/sqlc_arg/mysql/go/models.go
View file
Open in desktop

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

19 changes: 19 additions & 0 deletions internal/endtoend/testdata/sqlc_arg/mysql/go/query.sql.go
View file
Open in desktop

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

8 changes: 7 additions & 1 deletion internal/endtoend/testdata/sqlc_arg/mysql/query.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
CREATE TABLE foo (name text not null);
CREATE TABLE foo (name text not null, description text);

/* name: FuncParamIdent :many */
SELECT name FROM foo WHERE name = sqlc.arg(slug);

/* name: FuncParamString :many */
SELECT name FROM foo WHERE name = sqlc.arg('slug');

/* name: FuncParamStringOptional :exec */
UPDATE foo SET name = coalesce(sqlc.arg('slug?'), name);

/* name: FuncParamStringRequired :exec */
UPDATE foo SET description = sqlc.arg('slug!');
7 changes: 5 additions & 2 deletions internal/endtoend/testdata/sqlc_arg/postgresql/pgx/go/models.go
View file
Open in desktop

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

19 changes: 19 additions & 0 deletions internal/endtoend/testdata/sqlc_arg/postgresql/pgx/go/query.sql.go
View file
Open in desktop

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

8 changes: 7 additions & 1 deletion internal/endtoend/testdata/sqlc_arg/postgresql/pgx/query.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
CREATE TABLE foo (name text not null);
CREATE TABLE foo (name text not null, description text);

-- name: FuncParamIdent :many
SELECT name FROM foo WHERE name = sqlc.arg(slug);

-- name: FuncParamString :many
SELECT name FROM foo WHERE name = sqlc.arg('slug');

-- name: FuncParamStringOptional :exec
UPDATE foo SET name = coalesce(sqlc.arg('slug?'), name);

-- name: FuncParamStringRequired :exec
UPDATE foo SET description = sqlc.arg('slug!');
7 changes: 5 additions & 2 deletions internal/endtoend/testdata/sqlc_arg/postgresql/stdlib/go/models.go
View file
Open in desktop

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

19 changes: 19 additions & 0 deletions internal/endtoend/testdata/sqlc_arg/postgresql/stdlib/go/query.sql.go
View file
Open in desktop

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

Loading