diff --git a/docs/reference/query-annotations.md b/docs/reference/query-annotations.md index 4fabe05aae..57eed12d4c 100644 --- a/docs/reference/query-annotations.md +++ b/docs/reference/query-annotations.md @@ -77,6 +77,9 @@ func (q *Queries) InsertAuthor(ctx context.Context, name string) (int64, error) } ``` +SQL Server's driver reports no last insert ID, so `:execlastid` is not +supported there. Return the ID with `OUTPUT INSERTED.id` and `:one` instead. + ## `:many` The generated method will return a slice of records via diff --git a/internal/cmd/generate.go b/internal/cmd/generate.go index fbdb084409..d8af330261 100644 --- a/internal/cmd/generate.go +++ b/internal/cmd/generate.go @@ -343,7 +343,11 @@ func codegen(ctx context.Context, combo config.CombinedSettings, sql OutputPair, case sql.Gen.Go != nil: out = combo.Go.Out - handler = ext.HandleFunc(golang.Generate) + generator := golang.Generator{} + if result.ExecutionCapabilities != nil { + generator.ExecutionCapabilities = result.ExecutionCapabilities.ExecutionCapabilities(sql.Gen.Go.SqlPackage, sql.Gen.Go.SqlDriver) + } + handler = ext.HandleFunc(generator.Generate) opts, err := json.Marshal(sql.Gen.Go) if err != nil { return "", nil, fmt.Errorf("opts marshal failed: %w", err) diff --git a/internal/codegen/golang/gen.go b/internal/codegen/golang/gen.go index 725f5970cf..261d8d70b6 100644 --- a/internal/codegen/golang/gen.go +++ b/internal/codegen/golang/gen.go @@ -14,6 +14,7 @@ import ( "github.com/sqlc-dev/sqlc/internal/codegen/golang/opts" "github.com/sqlc-dev/sqlc/internal/codegen/sdk" "github.com/sqlc-dev/sqlc/internal/metadata" + sqlopts "github.com/sqlc-dev/sqlc/internal/opts" "github.com/sqlc-dev/sqlc/internal/plugin" ) @@ -110,7 +111,17 @@ func (t *tmplCtx) codegenQueryRetval(q Query) (string, error) { } } +// Generator receives execution restrictions from the engine/driver integration, +// rather than deciding them from the request's engine name. +type Generator struct { + ExecutionCapabilities sqlopts.ExecutionCapabilities +} + func Generate(ctx context.Context, req *plugin.GenerateRequest) (*plugin.GenerateResponse, error) { + return (Generator{}).Generate(ctx, req) +} + +func (g Generator) Generate(ctx context.Context, req *plugin.GenerateRequest) (*plugin.GenerateResponse, error) { options, err := opts.Parse(req) if err != nil { return nil, err @@ -138,7 +149,7 @@ func Generate(ctx context.Context, req *plugin.GenerateRequest) (*plugin.Generat return nil, err } - return generate(req, options, enums, structs, queries) + return generate(req, options, enums, structs, queries, g.ExecutionCapabilities) } func validate(options *opts.Options, enums []Enum, structs []Struct, queries []Query) error { @@ -168,7 +179,7 @@ func validate(options *opts.Options, enums []Enum, structs []Struct, queries []Q return nil } -func generate(req *plugin.GenerateRequest, options *opts.Options, enums []Enum, structs []Struct, queries []Query) (*plugin.GenerateResponse, error) { +func generate(req *plugin.GenerateRequest, options *opts.Options, enums []Enum, structs []Struct, queries []Query, capabilities sqlopts.ExecutionCapabilities) (*plugin.GenerateResponse, error) { i := &importer{ Options: options, Engine: req.Settings.Engine, @@ -212,6 +223,14 @@ func generate(req *plugin.GenerateRequest, options *opts.Options, enums []Enum, tctx.SQLDriver = opts.SQLDriverGoSQLDriverMySQL } + if capabilities.LastInsertIDUnsupportedReason != "" { + for _, q := range queries { + if q.Cmd == metadata.CmdExecLastId { + return nil, fmt.Errorf("query %q: :execlastid %s", q.MethodName, capabilities.LastInsertIDUnsupportedReason) + } + } + } + if tctx.UsesBatch && !tctx.SQLDriver.IsPGX() { return nil, errors.New(":batch* commands are only supported by pgx") } diff --git a/internal/compiler/compile.go b/internal/compiler/compile.go index b6f703d1cb..478c3e539f 100644 --- a/internal/compiler/compile.go +++ b/internal/compiler/compile.go @@ -240,9 +240,11 @@ func (c *Compiler) parseQueries(o opts.Parser) (*Result, error) { return nil, fmt.Errorf("no queries contained in paths %s", strings.Join(c.conf.Queries, ",")) } + capabilities, _ := c.parser.(opts.ExecutionCapabilitiesProvider) return &Result{ - Catalog: c.catalog, - Queries: q, + ExecutionCapabilities: capabilities, + Catalog: c.catalog, + Queries: q, }, nil } diff --git a/internal/compiler/result.go b/internal/compiler/result.go index 3647da630f..80273e9e75 100644 --- a/internal/compiler/result.go +++ b/internal/compiler/result.go @@ -1,10 +1,12 @@ package compiler import ( + "github.com/sqlc-dev/sqlc/internal/opts" "github.com/sqlc-dev/sqlc/internal/sql/catalog" ) type Result struct { - Catalog *catalog.Catalog - Queries []*Query + Catalog *catalog.Catalog + Queries []*Query + ExecutionCapabilities opts.ExecutionCapabilitiesProvider } diff --git a/internal/endtoend/testdata/analyze_convert_style/mssql/exec.json b/internal/endtoend/testdata/analyze_convert_style/mssql/exec.json new file mode 100644 index 0000000000..253b05abbf --- /dev/null +++ b/internal/endtoend/testdata/analyze_convert_style/mssql/exec.json @@ -0,0 +1,5 @@ +{ + "command": "analyze", + "args": ["--dialect", "mssql", "--schema", "schema.sql", "query.sql"], + "contexts": ["base"] +} diff --git a/internal/endtoend/testdata/analyze_convert_style/mssql/query.sql b/internal/endtoend/testdata/analyze_convert_style/mssql/query.sql new file mode 100644 index 0000000000..3e4f34f892 --- /dev/null +++ b/internal/endtoend/testdata/analyze_convert_style/mssql/query.sql @@ -0,0 +1,2 @@ +-- name: Styled :many +SELECT CONVERT(nvarchar(30), at, @style) AS styled, CONVERT(varchar(10), at, 23) AS fixed FROM t; diff --git a/internal/endtoend/testdata/analyze_convert_style/mssql/schema.sql b/internal/endtoend/testdata/analyze_convert_style/mssql/schema.sql new file mode 100644 index 0000000000..64963bfc13 --- /dev/null +++ b/internal/endtoend/testdata/analyze_convert_style/mssql/schema.sql @@ -0,0 +1 @@ +CREATE TABLE t (id INT NOT NULL, name NVARCHAR(50) NULL, at DATETIME2 NOT NULL); diff --git a/internal/endtoend/testdata/analyze_convert_style/mssql/stdout.json b/internal/endtoend/testdata/analyze_convert_style/mssql/stdout.json new file mode 100644 index 0000000000..e8ba8dfda0 --- /dev/null +++ b/internal/endtoend/testdata/analyze_convert_style/mssql/stdout.json @@ -0,0 +1,42 @@ +[ + { + "name": "Styled", + "cmd": ":many", + "columns": [ + { + "name": "styled", + "type": { + "name": "nvarchar", + "nullable": true, + "args": [ + { + "int": 30 + } + ] + } + }, + { + "name": "fixed", + "type": { + "name": "varchar", + "args": [ + { + "int": 10 + } + ] + } + } + ], + "params": [ + { + "number": 1, + "column": { + "name": "style", + "type": { + "name": "int" + } + } + } + ] + } +] diff --git a/internal/endtoend/testdata/analyze_top_percent/mssql/exec.json b/internal/endtoend/testdata/analyze_top_percent/mssql/exec.json new file mode 100644 index 0000000000..253b05abbf --- /dev/null +++ b/internal/endtoend/testdata/analyze_top_percent/mssql/exec.json @@ -0,0 +1,5 @@ +{ + "command": "analyze", + "args": ["--dialect", "mssql", "--schema", "schema.sql", "query.sql"], + "contexts": ["base"] +} diff --git a/internal/endtoend/testdata/analyze_top_percent/mssql/query.sql b/internal/endtoend/testdata/analyze_top_percent/mssql/query.sql new file mode 100644 index 0000000000..82a8380d35 --- /dev/null +++ b/internal/endtoend/testdata/analyze_top_percent/mssql/query.sql @@ -0,0 +1,2 @@ +-- name: TopPercent :many +SELECT TOP (@pct) PERCENT id, name FROM authors ORDER BY id; diff --git a/internal/endtoend/testdata/analyze_top_percent/mssql/schema.sql b/internal/endtoend/testdata/analyze_top_percent/mssql/schema.sql new file mode 100644 index 0000000000..d48c43b40e --- /dev/null +++ b/internal/endtoend/testdata/analyze_top_percent/mssql/schema.sql @@ -0,0 +1,4 @@ +CREATE TABLE authors ( + id BIGINT IDENTITY(1,1) PRIMARY KEY, + name NVARCHAR(100) NOT NULL +); diff --git a/internal/endtoend/testdata/analyze_top_percent/mssql/stdout.json b/internal/endtoend/testdata/analyze_top_percent/mssql/stdout.json new file mode 100644 index 0000000000..deee4f1830 --- /dev/null +++ b/internal/endtoend/testdata/analyze_top_percent/mssql/stdout.json @@ -0,0 +1,38 @@ +[ + { + "name": "TopPercent", + "cmd": ":many", + "columns": [ + { + "name": "id", + "type": { + "name": "bigint" + }, + "table": "authors" + }, + { + "name": "name", + "type": { + "name": "nvarchar", + "args": [ + { + "int": 100 + } + ] + }, + "table": "authors" + } + ], + "params": [ + { + "number": 1, + "column": { + "name": "pct", + "type": { + "name": "float" + } + } + } + ] + } +] diff --git a/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/exec.json b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/exec.json new file mode 100644 index 0000000000..f4e21983b6 --- /dev/null +++ b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/exec.json @@ -0,0 +1 @@ +{"contexts": ["base"]} diff --git a/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/query.sql b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/query.sql new file mode 100644 index 0000000000..8d1d2a89ef --- /dev/null +++ b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/query.sql @@ -0,0 +1,2 @@ +-- name: CopyBooks :copyfrom +INSERT INTO books (id, title) VALUES (@id, @title); diff --git a/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/schema.sql b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/schema.sql new file mode 100644 index 0000000000..9e32b120d1 --- /dev/null +++ b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/schema.sql @@ -0,0 +1 @@ +CREATE TABLE books (id INT NOT NULL, title NVARCHAR(200) NOT NULL); diff --git a/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/sqlc.yaml b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/sqlc.yaml new file mode 100644 index 0000000000..94b0dc8896 --- /dev/null +++ b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/sqlc.yaml @@ -0,0 +1,10 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" + sql_package: "database/sql" diff --git a/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/stderr.txt b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/stderr.txt new file mode 100644 index 0000000000..3509d2bee5 --- /dev/null +++ b/internal/endtoend/testdata/mssql_copyfrom_unsupported/mssql/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +error generating code: :copyfrom is only supported by pgx and github.com/go-sql-driver/mysql diff --git a/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/exec.json b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/exec.json new file mode 100644 index 0000000000..e38046cf57 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/exec.json @@ -0,0 +1,4 @@ +{ + "contexts": ["base"], + "process": "sqlc-gen-json" +} diff --git a/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/gen/codegen.json b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/gen/codegen.json new file mode 100644 index 0000000000..78f6da7218 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/gen/codegen.json @@ -0,0 +1,118 @@ +{ + "settings": { + "version": "2", + "engine": "mssql", + "schema": [ + "schema.sql" + ], + "queries": [ + "query.sql" + ], + "codegen": { + "out": "gen", + "plugin": "jsonb", + "options": "eyJmaWxlbmFtZSI6ImNvZGVnZW4uanNvbiIsImluZGVudCI6IiAgIn0=", + "env": [], + "process": { + "cmd": "sqlc-gen-json" + }, + "wasm": null + } + }, + "catalog": { + "comment": "", + "default_schema": "public", + "name": "", + "schemas": [ + { + "comment": "", + "name": "public", + "tables": [], + "enums": [], + "composite_types": [] + }, + { + "comment": "", + "name": "public", + "tables": [ + { + "rel": { + "catalog": "", + "schema": "public", + "name": "books" + }, + "columns": [ + { + "name": "id", + "not_null": true, + "is_array": false, + "comment": "", + "length": -1, + "is_named_param": false, + "is_func_call": false, + "scope": "", + "table": { + "catalog": "", + "schema": "public", + "name": "books" + }, + "table_alias": "", + "type": { + "catalog": "", + "schema": "", + "name": "int" + }, + "is_sqlc_slice": false, + "embed_table": null, + "original_name": "", + "unsigned": false, + "array_dims": 0, + "type_expr": { + "name": "int", + "nullable": false, + "args": [] + } + } + ], + "comment": "" + } + ], + "enums": [], + "composite_types": [] + }, + { + "comment": "", + "name": "sys", + "tables": [], + "enums": [], + "composite_types": [] + }, + { + "comment": "", + "name": "information_schema", + "tables": [], + "enums": [], + "composite_types": [] + } + ] + }, + "queries": [ + { + "text": "INSERT INTO books (id) VALUES (1);", + "name": "CreateBook", + "cmd": ":execlastid", + "columns": [], + "params": [], + "comments": [], + "filename": "query.sql", + "insert_into_table": { + "catalog": "", + "schema": "", + "name": "books" + } + } + ], + "sqlc_version": "v1.31.1", + "plugin_options": "eyJmaWxlbmFtZSI6ImNvZGVnZW4uanNvbiIsImluZGVudCI6IiAgIn0=", + "global_options": "" +} diff --git a/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/query.sql b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/query.sql new file mode 100644 index 0000000000..ef81004a63 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/query.sql @@ -0,0 +1,2 @@ +-- name: CreateBook :execlastid +INSERT INTO books (id) VALUES (1); diff --git a/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/schema.sql b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/schema.sql new file mode 100644 index 0000000000..5111ae138e --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/schema.sql @@ -0,0 +1 @@ +CREATE TABLE books (id INT NOT NULL); diff --git a/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/sqlc.json b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/sqlc.json new file mode 100644 index 0000000000..652d367695 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_plugin/mssql/sqlc.json @@ -0,0 +1,28 @@ +{ + "version": "2", + "sql": [ + { + "engine": "mssql", + "schema": "schema.sql", + "queries": "query.sql", + "codegen": [ + { + "out": "gen", + "plugin": "jsonb", + "options": { + "indent": " ", + "filename": "codegen.json" + } + } + ] + } + ], + "plugins": [ + { + "name": "jsonb", + "process": { + "cmd": "sqlc-gen-json" + } + } + ] +} diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/exec.json b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/exec.json new file mode 100644 index 0000000000..2e996ca79d --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/exec.json @@ -0,0 +1,3 @@ +{ + "contexts": ["base"] +} diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/query.sql b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/query.sql new file mode 100644 index 0000000000..ef81004a63 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/query.sql @@ -0,0 +1,2 @@ +-- name: CreateBook :execlastid +INSERT INTO books (id) VALUES (1); diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/schema.sql b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/schema.sql new file mode 100644 index 0000000000..5111ae138e --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/schema.sql @@ -0,0 +1 @@ +CREATE TABLE books (id INT NOT NULL); diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/sqlc.yaml b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/sqlc.yaml new file mode 100644 index 0000000000..3ccfc8f56a --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/sqlc.yaml @@ -0,0 +1,9 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/stderr.txt b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/stderr.txt new file mode 100644 index 0000000000..73b2d2edf0 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/default_package/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +error generating code: query "CreateBook": :execlastid is not supported for SQL Server, whose driver reports no last insert ID; use OUTPUT INSERTED. with :one diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/exec.json b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/exec.json new file mode 100644 index 0000000000..f4e21983b6 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/exec.json @@ -0,0 +1 @@ +{"contexts": ["base"]} diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/query.sql b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/query.sql new file mode 100644 index 0000000000..d1caf2a305 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/query.sql @@ -0,0 +1,2 @@ +-- name: CreateBook :execlastid +INSERT INTO books (id, title) VALUES (@id, @title); diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/schema.sql b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/schema.sql new file mode 100644 index 0000000000..9e32b120d1 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/schema.sql @@ -0,0 +1 @@ +CREATE TABLE books (id INT NOT NULL, title NVARCHAR(200) NOT NULL); diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/sqlc.yaml b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/sqlc.yaml new file mode 100644 index 0000000000..94b0dc8896 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/sqlc.yaml @@ -0,0 +1,10 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" + sql_package: "database/sql" diff --git a/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/stderr.txt b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/stderr.txt new file mode 100644 index 0000000000..73b2d2edf0 --- /dev/null +++ b/internal/endtoend/testdata/mssql_execlastid_unsupported/mssql/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +error generating code: query "CreateBook": :execlastid is not supported for SQL Server, whose driver reports no last insert ID; use OUTPUT INSERTED. with :one diff --git a/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/exec.json b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/exec.json new file mode 100644 index 0000000000..f4e21983b6 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/exec.json @@ -0,0 +1 @@ +{"contexts": ["base"]} diff --git a/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/query.sql b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/query.sql new file mode 100644 index 0000000000..6376e1f909 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/query.sql @@ -0,0 +1,5 @@ +-- name: Ids :many +SELECT id FROM t WHERE name = '@not_a_param' /* @nor_this */ AND id > @min; + +-- name: Sample :many +SELECT id FROM t WITH (INDEX(@ix)); diff --git a/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/schema.sql b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/schema.sql new file mode 100644 index 0000000000..15ae02025c --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/schema.sql @@ -0,0 +1 @@ +CREATE TABLE t (id INT NOT NULL, name NVARCHAR(50) NULL); diff --git a/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/sqlc.yaml b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/sqlc.yaml new file mode 100644 index 0000000000..94b0dc8896 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/sqlc.yaml @@ -0,0 +1,10 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" + sql_package: "database/sql" diff --git a/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/stderr.txt b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/stderr.txt new file mode 100644 index 0000000000..8303d18af0 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_placeholder/mssql/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +query.sql:5:30: placeholder @ix is not supported where it is used diff --git a/internal/endtoend/testdata/mssql_unsupported_statement/mssql/exec.json b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/exec.json new file mode 100644 index 0000000000..f4e21983b6 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/exec.json @@ -0,0 +1 @@ +{"contexts": ["base"]} diff --git a/internal/endtoend/testdata/mssql_unsupported_statement/mssql/query.sql b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/query.sql new file mode 100644 index 0000000000..00a92a27ec --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/query.sql @@ -0,0 +1,8 @@ +-- name: ListAuthors :many +SELECT id, name FROM authors; + +-- name: UpsertAuthor :exec +MERGE authors AS t +USING (SELECT @id AS id, @name AS name) s ON t.id = s.id +WHEN MATCHED THEN UPDATE SET name = s.name +WHEN NOT MATCHED THEN INSERT (name) VALUES (s.name); diff --git a/internal/endtoend/testdata/mssql_unsupported_statement/mssql/schema.sql b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/schema.sql new file mode 100644 index 0000000000..00557ccd53 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/schema.sql @@ -0,0 +1,12 @@ +CREATE TABLE authors ( + id BIGINT IDENTITY(1,1) PRIMARY KEY, + name NVARCHAR(100) NOT NULL +); + +CREATE TABLE books ( + id BIGINT IDENTITY(1,1) PRIMARY KEY, + author_id BIGINT NOT NULL, + title NVARCHAR(200) NOT NULL +); + +CREATE PROCEDURE list_authors AS SELECT id, name FROM authors; diff --git a/internal/endtoend/testdata/mssql_unsupported_statement/mssql/sqlc.yaml b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/sqlc.yaml new file mode 100644 index 0000000000..94b0dc8896 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/sqlc.yaml @@ -0,0 +1,10 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" + sql_package: "database/sql" diff --git a/internal/endtoend/testdata/mssql_unsupported_statement/mssql/stderr.txt b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/stderr.txt new file mode 100644 index 0000000000..531a736e9f --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement/mssql/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +query.sql:5:1: Merge statements are not supported diff --git a/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/exec.json b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/exec.json new file mode 100644 index 0000000000..f4e21983b6 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/exec.json @@ -0,0 +1 @@ +{"contexts": ["base"]} diff --git a/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/query.sql b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/query.sql new file mode 100644 index 0000000000..a4c10b1c8b --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/query.sql @@ -0,0 +1,7 @@ +/* name: ListAuthors :many */ +SELECT id, name FROM authors; + +/* name: DeleteAll :exec */ +MERGE authors AS t +USING (SELECT @id AS id) s ON t.id = s.id +WHEN MATCHED THEN DELETE; diff --git a/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/schema.sql b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/schema.sql new file mode 100644 index 0000000000..00557ccd53 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/schema.sql @@ -0,0 +1,12 @@ +CREATE TABLE authors ( + id BIGINT IDENTITY(1,1) PRIMARY KEY, + name NVARCHAR(100) NOT NULL +); + +CREATE TABLE books ( + id BIGINT IDENTITY(1,1) PRIMARY KEY, + author_id BIGINT NOT NULL, + title NVARCHAR(200) NOT NULL +); + +CREATE PROCEDURE list_authors AS SELECT id, name FROM authors; diff --git a/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/sqlc.yaml b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/sqlc.yaml new file mode 100644 index 0000000000..94b0dc8896 --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/sqlc.yaml @@ -0,0 +1,10 @@ +version: "2" +sql: + - engine: "mssql" + schema: "schema.sql" + queries: "query.sql" + gen: + go: + package: "querytest" + out: "go" + sql_package: "database/sql" diff --git a/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/stderr.txt b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/stderr.txt new file mode 100644 index 0000000000..531a736e9f --- /dev/null +++ b/internal/endtoend/testdata/mssql_unsupported_statement_block_comment/mssql/stderr.txt @@ -0,0 +1,2 @@ +# package querytest +query.sql:5:1: Merge statements are not supported diff --git a/internal/engine/mssql/capabilities.go b/internal/engine/mssql/capabilities.go new file mode 100644 index 0000000000..d443b52716 --- /dev/null +++ b/internal/engine/mssql/capabilities.go @@ -0,0 +1,17 @@ +package mssql + +import "github.com/sqlc-dev/sqlc/internal/opts" + +func (p *Parser) ExecutionCapabilities(sqlPackage, sqlDriver string) opts.ExecutionCapabilities { + if sqlPackage != "" && sqlPackage != "database/sql" { + return opts.ExecutionCapabilities{} + } + if sqlDriver != "" && sqlDriver != "github.com/microsoft/go-mssqldb" { + return opts.ExecutionCapabilities{} + } + // The default Go binding uses go-mssqldb, whose LastInsertId always + // errors. Other bindings may return identities through a different API. + return opts.ExecutionCapabilities{ + LastInsertIDUnsupportedReason: "is not supported for SQL Server, whose driver reports no last insert ID; use OUTPUT INSERTED. with :one", + } +} diff --git a/internal/engine/mssql/convert.go b/internal/engine/mssql/convert.go index bdef335bc6..e4d29eeac9 100644 --- a/internal/engine/mssql/convert.go +++ b/internal/engine/mssql/convert.go @@ -224,9 +224,13 @@ func (c *cc) convertQuerySpecification(n *tsql.QuerySpecification) *ast.SelectSt } } - // TOP n; TOP n PERCENT does not translate to a row count. - if n.TopRowFilter != nil && !n.TopRowFilter.Percent { + // TOP n. TOP n PERCENT is no row count, but a float a placeholder for + // it is typed as. + if n.TopRowFilter != nil { stmt.LimitCount = c.convertScalarExpression(n.TopRowFilter.Expression) + if n.TopRowFilter.Percent { + stmt.LimitCount = &ast.TypeCast{Arg: stmt.LimitCount, TypeName: &ast.TypeName{Name: "float"}} + } } if n.UniqueRowFilter == "Distinct" { @@ -561,8 +565,18 @@ func (c *cc) convertScalarExpression(expr tsql.ScalarExpression) ast.Node { Location: c.loc(e), } case *tsql.ConvertCall: + arg := c.convertScalarExpression(e.Parameter) + // A style given as other than a literal, as @style, is an int + // passed through "convert style", which may return NULL. + if _, literal := e.Style.(*tsql.IntegerLiteral); e.Style != nil && !literal { + arg = &ast.FuncCall{ + Funcname: &ast.List{Items: []ast.Node{&ast.String{Str: "convert style"}}}, + Args: &ast.List{Items: []ast.Node{arg, &ast.TypeCast{Arg: c.convertScalarExpression(e.Style), TypeName: &ast.TypeName{Name: "int"}}}}, + Location: c.loc(e), + } + } return &ast.TypeCast{ - Arg: c.convertScalarExpression(e.Parameter), + Arg: arg, TypeName: dataTypeName(e.DataType), Location: c.loc(e), } diff --git a/internal/engine/mssql/dialect/functions.jsonl b/internal/engine/mssql/dialect/functions.jsonl index e0cd45408c..72d3a5db86 100644 --- a/internal/engine/mssql/dialect/functions.jsonl +++ b/internal/engine/mssql/dialect/functions.jsonl @@ -74,3 +74,4 @@ {"name": "rtrim", "args": [{"type": "nvarchar"}], "returns": "nvarchar"} {"name": "trim", "args": [{"type": "varchar"}], "returns": "varchar"} {"name": "trim", "args": [{"type": "nvarchar"}], "returns": "nvarchar"} +{"name": "convert style", "args": [{"type": "any"}, {"type": "int"}], "returns": "$1", "nullable": true} diff --git a/internal/engine/mssql/parse.go b/internal/engine/mssql/parse.go index e222708ece..3d6d9d5f56 100644 --- a/internal/engine/mssql/parse.go +++ b/internal/engine/mssql/parse.go @@ -3,13 +3,17 @@ package mssql import ( "bytes" "context" + "fmt" "io" + "regexp" + "strings" "unicode/utf8" "github.com/sqlc-dev/teesql/parser" "github.com/sqlc-dev/sqlc/internal/source" "github.com/sqlc-dev/sqlc/internal/sql/ast" + "github.com/sqlc-dev/sqlc/internal/sql/sqlerr" ) func NewParser() *Parser { @@ -47,10 +51,26 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) { converter := &cc{toByte: toByte} out := converter.convert(stmt) if _, ok := out.(*ast.TODO); ok { + // A schema holds statements sqlc has no use for, which are + // skipped. A named query sqlc cannot analyze is an error, + // rather than a query missing from the generated code. + if namedQuery.Match(blob[loc:end]) { + kind := strings.TrimSuffix(strings.TrimPrefix(fmt.Sprintf("%T", stmt), "*ast."), "Statement") + return nil, &sqlerr.Error{ + Message: fmt.Sprintf("%s statements are not supported", kind), + Location: start, + } + } loc = end continue } + if namedQuery.Match(blob[loc:end]) { + if err := checkPlaceholders(blob, start, end, converter.namedParams); err != nil { + return nil, err + } + } + stmts = append(stmts, ast.Statement{ Raw: &ast.RawStmt{ Stmt: out, @@ -65,6 +85,80 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) { return stmts, nil } +// namedQuery matches the comment that names a query, in either comment +// style. +var namedQuery = regexp.MustCompile(`(?m)^\s*(--|/\*)\s*name:\s*\S+`) + +// checkPlaceholders reports a placeholder in a query's text that did not +// become one of its parameters, which a construct the converter does not +// follow drops, leaving generated code that passes the query too few +// arguments. +func checkPlaceholders(blob []byte, start, end int, params map[string]namedParam) error { + for _, p := range placeholders(blob[start:end]) { + if _, ok := params[strings.ToLower(p.name)]; !ok { + return &sqlerr.Error{ + Message: fmt.Sprintf("placeholder @%s is not supported where it is used", p.name), + Location: start + p.offset, + } + } + } + return nil +} + +type placeholder struct { + name string + offset int +} + +// placeholders are the @name placeholders in sql, leaving out @@ system +// variables and anything inside a string, a quoted or bracketed +// identifier or a comment. +func placeholders(sql []byte) []placeholder { + var out []placeholder + skipTo := func(i int, close string) int { + if j := bytes.Index(sql[i:], []byte(close)); j >= 0 { + return i + j + len(close) + } + return len(sql) + } + for i := 0; i < len(sql); { + switch c := sql[i]; { + case c == '\'' || c == '"': + // A doubled quote inside is an escaped one, which the scan + // steps over as the end of one string and the start of the + // next. + i = skipTo(i+1, string(c)) + case c == '[': + i = skipTo(i+1, "]") + case c == '-' && i+1 < len(sql) && sql[i+1] == '-': + i = skipTo(i, "\n") + case c == '/' && i+1 < len(sql) && sql[i+1] == '*': + i = skipTo(i+2, "*/") + case c == '@': + j := i + 1 + for j < len(sql) && isNameByte(sql[j]) { + j++ + } + if i+1 < len(sql) && sql[i+1] == '@' { + i = j + continue + } + if j > i+1 { + out = append(out, placeholder{name: string(sql[i+1 : j]), offset: i}) + } + i = j + default: + i++ + } + } + return out +} + +func isNameByte(b byte) bool { + return b == '_' || b == '#' || b == '$' || b == '@' || + 'a' <= b && b <= 'z' || 'A' <= b && b <= 'Z' || '0' <= b && b <= '9' || b >= utf8.RuneSelf +} + // byteOffsets returns a function mapping a UTF-16 code-unit offset — how // teesql records source spans, mirroring ScriptDom — to a byte offset in // blob. For ASCII input the two are identical and the identity is returned. diff --git a/internal/opts/execution.go b/internal/opts/execution.go new file mode 100644 index 0000000000..9da96b1d57 --- /dev/null +++ b/internal/opts/execution.go @@ -0,0 +1,14 @@ +package opts + +// ExecutionCapabilities describes restrictions of a particular driver binding. +// Empty fields retain the generator's historical behavior. +type ExecutionCapabilities struct { + LastInsertIDUnsupportedReason string +} + +// ExecutionCapabilitiesProvider is optional: engines without one do not add +// restrictions. Package and driver describe the selected execution binding, +// not the database's ability to express equivalent SQL. +type ExecutionCapabilitiesProvider interface { + ExecutionCapabilities(sqlPackage, sqlDriver string) ExecutionCapabilities +} diff --git a/internal/sql/validate/cmd.go b/internal/sql/validate/cmd.go index e9d9dd03cb..0837965405 100644 --- a/internal/sql/validate/cmd.go +++ b/internal/sql/validate/cmd.go @@ -27,7 +27,7 @@ func validateCopyfrom(n ast.Node) error { if !ok { return nil } - if len(sel.FromClause.Items) > 0 { + if sel.FromClause != nil && len(sel.FromClause.Items) > 0 { return errors.New(":copyfrom is not compatible with INSERT INTO ... SELECT") } if sel.ValuesLists == nil || len(sel.ValuesLists.Items) != 1 {