diff --git a/internal/endtoend/testdata/comment_syntax/mysql/go/db.go b/internal/endtoend/testdata/comment_syntax/mysql/go/db.go new file mode 100644 index 0000000000..6a99519302 --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/mysql/go/db.go @@ -0,0 +1,29 @@ +// Code generated by sqlc. DO NOT EDIT. + +package querytest + +import ( + "context" + "database/sql" +) + +type DBTX interface { + ExecContext(context.Context, string, ...interface{}) (sql.Result, error) + PrepareContext(context.Context, string) (*sql.Stmt, error) + QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error) + QueryRowContext(context.Context, string, ...interface{}) *sql.Row +} + +func New(db DBTX) *Queries { + return &Queries{db: db} +} + +type Queries struct { + db DBTX +} + +func (q *Queries) WithTx(tx *sql.Tx) *Queries { + return &Queries{ + db: tx, + } +} diff --git a/internal/endtoend/testdata/comment_syntax/mysql/go/models.go b/internal/endtoend/testdata/comment_syntax/mysql/go/models.go new file mode 100644 index 0000000000..8170fc4b5c --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/mysql/go/models.go @@ -0,0 +1,11 @@ +// Code generated by sqlc. DO NOT EDIT. + +package querytest + +import ( + "database/sql" +) + +type Foo struct { + Bar sql.NullString +} diff --git a/internal/endtoend/testdata/comment_syntax/mysql/go/query.sql.go b/internal/endtoend/testdata/comment_syntax/mysql/go/query.sql.go new file mode 100644 index 0000000000..3626b6a78f --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/mysql/go/query.sql.go @@ -0,0 +1,43 @@ +// Code generated by sqlc. DO NOT EDIT. +// source: query.sql + +package querytest + +import ( + "context" + "database/sql" +) + +const doubleDash = `-- name: DoubleDash :one +SELECT bar FROM foo LIMIT 1 +` + +func (q *Queries) DoubleDash(ctx context.Context) (sql.NullString, error) { + row := q.db.QueryRowContext(ctx, doubleDash) + var bar sql.NullString + err := row.Scan(&bar) + return bar, err +} + +const hash = `-- name: Hash :one +# name: Hash :one +SELECT bar FROM foo LIMIT 1 +` + +func (q *Queries) Hash(ctx context.Context) (sql.NullString, error) { + row := q.db.QueryRowContext(ctx, hash) + var bar sql.NullString + err := row.Scan(&bar) + return bar, err +} + +const slashStar = `-- name: SlashStar :one +SELECT bar FROM foo LIMIT 1 +` + +func (q *Queries) SlashStar(ctx context.Context) (sql.NullString, error) { + row := q.db.QueryRowContext(ctx, slashStar) + var bar sql.NullString + err := row.Scan(&bar) + return bar, err +} diff --git a/internal/endtoend/testdata/comment_syntax/mysql/query.sql b/internal/endtoend/testdata/comment_syntax/mysql/query.sql new file mode 100644 index 0000000000..1add2d737c --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/mysql/query.sql @@ -0,0 +1,10 @@ +CREATE TABLE foo (bar text); + +-- name: DoubleDash :one +SELECT * FROM foo LIMIT 1; + +/* name: SlashStar :one */ +SELECT * FROM foo LIMIT 1; + +# name: Hash :one +SELECT * FROM foo LIMIT 1; diff --git a/internal/endtoend/testdata/comment_syntax/mysql/sqlc.json b/internal/endtoend/testdata/comment_syntax/mysql/sqlc.json new file mode 100644 index 0000000000..20b7096718 --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/mysql/sqlc.json @@ -0,0 +1,12 @@ +{ + "version": "1", + "packages": [ + { + "path": "go", + "engine": "mysql:beta", + "name": "querytest", + "schema": "query.sql", + "queries": "query.sql" + } + ] +} diff --git a/internal/endtoend/testdata/comment_syntax/postgresql/go/db.go b/internal/endtoend/testdata/comment_syntax/postgresql/go/db.go new file mode 100644 index 0000000000..6a99519302 --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/postgresql/go/db.go @@ -0,0 +1,29 @@ +// Code generated by sqlc. DO NOT EDIT. + +package querytest + +import ( + "context" + "database/sql" +) + +type DBTX interface { + ExecContext(context.Context, string, ...interface{}) (sql.Result, error) + PrepareContext(context.Context, string) (*sql.Stmt, error) + QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error) + QueryRowContext(context.Context, string, ...interface{}) *sql.Row +} + +func New(db DBTX) *Queries { + return &Queries{db: db} +} + +type Queries struct { + db DBTX +} + +func (q *Queries) WithTx(tx *sql.Tx) *Queries { + return &Queries{ + db: tx, + } +} diff --git a/internal/endtoend/testdata/comment_syntax/postgresql/go/models.go b/internal/endtoend/testdata/comment_syntax/postgresql/go/models.go new file mode 100644 index 0000000000..8170fc4b5c --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/postgresql/go/models.go @@ -0,0 +1,11 @@ +// Code generated by sqlc. DO NOT EDIT. + +package querytest + +import ( + "database/sql" +) + +type Foo struct { + Bar sql.NullString +} diff --git a/internal/endtoend/testdata/comment_syntax/postgresql/go/query.sql.go b/internal/endtoend/testdata/comment_syntax/postgresql/go/query.sql.go new file mode 100644 index 0000000000..6271efbfe7 --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/postgresql/go/query.sql.go @@ -0,0 +1,31 @@ +// Code generated by sqlc. DO NOT EDIT. +// source: query.sql + +package querytest + +import ( + "context" + "database/sql" +) + +const doubleDash = `-- name: DoubleDash :one +SELECT bar FROM foo LIMIT 1 +` + +func (q *Queries) DoubleDash(ctx context.Context) (sql.NullString, error) { + row := q.db.QueryRowContext(ctx, doubleDash) + var bar sql.NullString + err := row.Scan(&bar) + return bar, err +} + +const slashStar = `-- name: SlashStar :one +SELECT bar FROM foo LIMIT 1 +` + +func (q *Queries) SlashStar(ctx context.Context) (sql.NullString, error) { + row := q.db.QueryRowContext(ctx, slashStar) + var bar sql.NullString + err := row.Scan(&bar) + return bar, err +} diff --git a/internal/endtoend/testdata/comment_syntax/postgresql/query.sql b/internal/endtoend/testdata/comment_syntax/postgresql/query.sql new file mode 100644 index 0000000000..2efd5e5a1c --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/postgresql/query.sql @@ -0,0 +1,7 @@ +CREATE TABLE foo (bar text); + +-- name: DoubleDash :one +SELECT * FROM foo LIMIT 1; + +/* name: SlashStar :one */ +SELECT * FROM foo LIMIT 1; diff --git a/internal/endtoend/testdata/comment_syntax/postgresql/sqlc.json b/internal/endtoend/testdata/comment_syntax/postgresql/sqlc.json new file mode 100644 index 0000000000..c72b6132d5 --- /dev/null +++ b/internal/endtoend/testdata/comment_syntax/postgresql/sqlc.json @@ -0,0 +1,12 @@ +{ + "version": "1", + "packages": [ + { + "path": "go", + "engine": "postgresql", + "name": "querytest", + "schema": "query.sql", + "queries": "query.sql" + } + ] +} diff --git a/internal/endtoend/testdata/ddl_alter_table_set_data_type/mysql/go/query.sql.go b/internal/endtoend/testdata/ddl_alter_table_set_data_type/mysql/go/query.sql.go new file mode 100644 index 0000000000..203f0fe62c --- /dev/null +++ b/internal/endtoend/testdata/ddl_alter_table_set_data_type/mysql/go/query.sql.go @@ -0,0 +1,17 @@ +// Code generated by sqlc. DO NOT EDIT. +// source: query.sql + +package querytest + +import ( + "context" +) + +const placeholder = `-- name: Placeholder :exec +SELECT 1 +` + +func (q *Queries) Placeholder(ctx context.Context) error { + _, err := q.db.ExecContext(ctx, placeholder) + return err +} diff --git a/internal/endtoend/testdata/ddl_alter_table_set_not_null/mysql/go/query.sql.go b/internal/endtoend/testdata/ddl_alter_table_set_not_null/mysql/go/query.sql.go new file mode 100644 index 0000000000..203f0fe62c --- /dev/null +++ b/internal/endtoend/testdata/ddl_alter_table_set_not_null/mysql/go/query.sql.go @@ -0,0 +1,17 @@ +// Code generated by sqlc. DO NOT EDIT. +// source: query.sql + +package querytest + +import ( + "context" +) + +const placeholder = `-- name: Placeholder :exec +SELECT 1 +` + +func (q *Queries) Placeholder(ctx context.Context) error { + _, err := q.db.ExecContext(ctx, placeholder) + return err +} diff --git a/internal/endtoend/testdata/ddl_comment/mysql/go/query.sql.go b/internal/endtoend/testdata/ddl_comment/mysql/go/query.sql.go new file mode 100644 index 0000000000..203f0fe62c --- /dev/null +++ b/internal/endtoend/testdata/ddl_comment/mysql/go/query.sql.go @@ -0,0 +1,17 @@ +// Code generated by sqlc. DO NOT EDIT. +// source: query.sql + +package querytest + +import ( + "context" +) + +const placeholder = `-- name: Placeholder :exec +SELECT 1 +` + +func (q *Queries) Placeholder(ctx context.Context) error { + _, err := q.db.ExecContext(ctx, placeholder) + return err +} diff --git a/internal/engine/dolphin/parse.go b/internal/engine/dolphin/parse.go index d412e8bb83..397fdafe88 100644 --- a/internal/engine/dolphin/parse.go +++ b/internal/engine/dolphin/parse.go @@ -81,6 +81,11 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) { return stmts, nil } +// https://dev.mysql.com/doc/refman/8.0/en/comments.html func (p *Parser) CommentSyntax() metadata.CommentSyntax { - return metadata.CommentSyntaxStar + return metadata.CommentSyntax{ + Dash: true, + SlashStar: true, + Hash: true, + } } diff --git a/internal/engine/postgresql/parse.go b/internal/engine/postgresql/parse.go index 1dfca9f476..4d414299a1 100644 --- a/internal/engine/postgresql/parse.go +++ b/internal/engine/postgresql/parse.go @@ -220,8 +220,12 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) { return stmts, nil } +// https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-COMMENTS func (p *Parser) CommentSyntax() metadata.CommentSyntax { - return metadata.CommentSyntaxDash + return metadata.CommentSyntax{ + Dash: true, + SlashStar: true, + } } func translate(node nodes.Node) (ast.Node, error) { diff --git a/internal/engine/sqlite/parse.go b/internal/engine/sqlite/parse.go index 1e8719e21a..91746abe93 100644 --- a/internal/engine/sqlite/parse.go +++ b/internal/engine/sqlite/parse.go @@ -85,5 +85,7 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) { } func (p *Parser) CommentSyntax() metadata.CommentSyntax { - return metadata.CommentSyntaxDash + return metadata.CommentSyntax{ + Dash: true, + } } diff --git a/internal/metadata/meta.go b/internal/metadata/meta.go index b10c2d430e..d3b00c507b 100644 --- a/internal/metadata/meta.go +++ b/internal/metadata/meta.go @@ -6,13 +6,11 @@ import ( "unicode" ) -type CommentSyntax int - -const ( - CommentSyntaxDash CommentSyntax = iota - CommentSyntaxStar // Note: this is the only style supported by the MySQL sqlparser - CommentSyntaxHash -) +type CommentSyntax struct { + Dash bool + Hash bool + SlashStar bool +} const ( CmdExec = ":exec" @@ -43,15 +41,34 @@ func validateQueryName(name string) error { func Parse(t string, commentStyle CommentSyntax) (string, string, error) { for _, line := range strings.Split(t, "\n") { - if commentStyle == CommentSyntaxDash && !strings.HasPrefix(line, "-- name:") { + var prefix string + if strings.HasPrefix(line, "--") { + if !commentStyle.Dash { + continue + } + prefix = "-- name:" + } + if strings.HasPrefix(line, "/*") { + if !commentStyle.SlashStar { + continue + } + prefix = "/* name:" + } + if strings.HasPrefix(line, "#") { + if !commentStyle.Hash { + continue + } + prefix = "# name:" + } + if prefix == "" { continue } - if commentStyle == CommentSyntaxStar && !strings.HasPrefix(line, "/* name:") { + if !strings.HasPrefix(line, prefix) { continue } - part := strings.Split(strings.TrimSpace(line), " ") - if commentStyle == CommentSyntaxStar { + part := strings.Split(strings.TrimSpace(line), " ") + if strings.HasPrefix(line, "/*") { part = part[:len(part)-1] // removes the trailing "*/" element } if len(part) == 2 { diff --git a/internal/metadata/meta_test.go b/internal/metadata/meta_test.go index 3602b12ceb..37e99307c6 100644 --- a/internal/metadata/meta_test.go +++ b/internal/metadata/meta_test.go @@ -11,7 +11,7 @@ func TestParseMetadata(t *testing.T) { `-- name: CreateFoo :one something`, `-- name: `, } { - if _, _, err := Parse(query, CommentSyntaxDash); err == nil { + if _, _, err := Parse(query, CommentSyntax{Dash: true}); err == nil { t.Errorf("expected invalid metadata: %q", query) } } diff --git a/internal/mysql/parse.go b/internal/mysql/parse.go index e14e40c9d6..955afd935f 100644 --- a/internal/mysql/parse.go +++ b/internal/mysql/parse.go @@ -141,7 +141,7 @@ func (q *Query) parseNameAndCmd() error { return fmt.Errorf("cannot parse name and cmd from null query") } _, comments := sqlparser.SplitMarginComments(q.SQL) - name, cmd, err := metadata.Parse(comments.Leading, metadata.CommentSyntaxStar) + name, cmd, err := metadata.Parse(comments.Leading, metadata.CommentSyntax{SlashStar: true}) if err != nil { return err } else if name == "" || cmd == "" {