Skip to content

Commit 56d7417

Browse files
kyleconroykyleconroy
authored
Rename driver to sql_package (#1114)
* config: Rename driver to sql_package * Update all the testing configs
1 parent 6617cff commit 56d7417

File tree

149 files changed

+208
-208
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+208
-208
lines changed

‎internal/codegen/golang/driver.go‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎internal/codegen/golang/gen.go‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ type Generateable interface {
2020
}
2121

2222
type tmplCtx struct {
23-
Q string
24-
Package string
25-
Driver Driver
26-
Enums []Enum
27-
Structs []Struct
28-
GoQueries []Query
29-
Settings config.Config
23+
Q string
24+
Package string
25+
SQLPackage SQLPackage
26+
Enums []Enum
27+
Structs []Struct
28+
GoQueries []Query
29+
Settings config.Config
3030

3131
// TODO: Race conditions
3232
SourceName string
@@ -82,7 +82,7 @@ func generate(settings config.CombinedSettings, enums []Enum, structs []Struct,
8282
EmitDBTags: golang.EmitDBTags,
8383
EmitPreparedQueries: golang.EmitPreparedQueries,
8484
EmitEmptySlices: golang.EmitEmptySlices,
85-
Driver: DriverFromString(golang.Driver),
85+
SQLPackage: SQLPackageFromString(golang.SQLPackage),
8686
Q: "`",
8787
Package: golang.Package,
8888
GoQueries: queries,

‎internal/codegen/golang/imports.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ func (i *importer) dbImports() fileImports {
119119
{Path: "context"},
120120
}
121121

122-
driver := DriverFromString(i.Settings.Go.Driver)
123-
switch driver {
124-
case PgxDriver:
122+
sqlpkg := SQLPackageFromString(i.Settings.Go.SQLPackage)
123+
switch sqlpkg {
124+
case SQLPackagePGX:
125125
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgconn"})
126126
pkg = append(pkg, ImportSpec{Path: "github.com/jackc/pgx/v4"})
127127
default:
@@ -169,11 +169,11 @@ func (i *importer) interfaceImports() fileImports {
169169

170170
pkg := make(map[ImportSpec]struct{})
171171

172-
driver := DriverFromString(i.Settings.Go.Driver)
172+
sqlpkg := SQLPackageFromString(i.Settings.Go.SQLPackage)
173173
for _, q := range i.Queries {
174174
if q.Cmd == metadata.CmdExecResult {
175-
switch driver {
176-
case PgxDriver:
175+
switch sqlpkg {
176+
case SQLPackagePGX:
177177
pkg[ImportSpec{Path: "github.com/jackc/pgconn"}] = struct{}{}
178178
default:
179179
std["database/sql"] = struct{}{}
@@ -370,12 +370,12 @@ func (i *importer) queryImports(filename string) fileImports {
370370
std["database/sql"] = struct{}{}
371371
}
372372

373-
driver := DriverFromString(i.Settings.Go.Driver)
373+
sqlpkg := SQLPackageFromString(i.Settings.Go.SQLPackage)
374374

375375
for _, q := range gq {
376376
if q.Cmd == metadata.CmdExecResult {
377-
switch driver {
378-
case PgxDriver:
377+
switch sqlpkg {
378+
case SQLPackagePGX:
379379
pkg[ImportSpec{Path: "github.com/jackc/pgconn"}] = struct{}{}
380380
default:
381381
std["database/sql"] = struct{}{}
@@ -396,7 +396,7 @@ func (i *importer) queryImports(filename string) fileImports {
396396
overrideTypes[o.GoTypeName] = o.GoImportPath
397397
}
398398

399-
if sliceScan() && driver != PgxDriver {
399+
if sliceScan() && sqlpkg != SQLPackagePGX {
400400
pkg[ImportSpec{Path: "github.com/lib/pq"}] = struct{}{}
401401
}
402402

‎internal/codegen/golang/query.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ import (
77
)
88

99
type QueryValue struct {
10-
Emit bool
11-
Name string
12-
Struct *Struct
13-
Typ string
14-
Driver Driver
10+
Emit bool
11+
Name string
12+
Struct *Struct
13+
Typ string
14+
SQLPackage SQLPackage
1515
}
1616

1717
func (v QueryValue) EmitStruct() bool {
@@ -49,14 +49,14 @@ func (v QueryValue) Params() string {
4949
}
5050
var out []string
5151
if v.Struct == nil {
52-
if strings.HasPrefix(v.Typ, "[]") && v.Typ != "[]byte" && v.Driver != PgxDriver {
52+
if strings.HasPrefix(v.Typ, "[]") && v.Typ != "[]byte" && v.SQLPackage != SQLPackagePGX {
5353
out = append(out, "pq.Array("+v.Name+")")
5454
} else {
5555
out = append(out, v.Name)
5656
}
5757
} else {
5858
for _, f := range v.Struct.Fields {
59-
if strings.HasPrefix(f.Type, "[]") && f.Type != "[]byte" && v.Driver != PgxDriver {
59+
if strings.HasPrefix(f.Type, "[]") && f.Type != "[]byte" && v.SQLPackage != SQLPackagePGX {
6060
out = append(out, "pq.Array("+v.Name+"."+f.Name+")")
6161
} else {
6262
out = append(out, v.Name+"."+f.Name)
@@ -73,14 +73,14 @@ func (v QueryValue) Params() string {
7373
func (v QueryValue) Scan() string {
7474
var out []string
7575
if v.Struct == nil {
76-
if strings.HasPrefix(v.Typ, "[]") && v.Typ != "[]byte" && v.Driver != PgxDriver {
76+
if strings.HasPrefix(v.Typ, "[]") && v.Typ != "[]byte" && v.SQLPackage != SQLPackagePGX {
7777
out = append(out, "pq.Array(&"+v.Name+")")
7878
} else {
7979
out = append(out, "&"+v.Name)
8080
}
8181
} else {
8282
for _, f := range v.Struct.Fields {
83-
if strings.HasPrefix(f.Type, "[]") && f.Type != "[]byte" && v.Driver != PgxDriver {
83+
if strings.HasPrefix(f.Type, "[]") && f.Type != "[]byte" && v.SQLPackage != SQLPackagePGX {
8484
out = append(out, "pq.Array(&"+v.Name+"."+f.Name+")")
8585
} else {
8686
out = append(out, "&"+v.Name+"."+f.Name)

‎internal/codegen/golang/result.go‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -161,13 +161,14 @@ func buildQueries(r *compiler.Result, settings config.CombinedSettings, structs
161161
SQL: query.SQL,
162162
Comments: query.Comments,
163163
}
164+
sqlpkg := SQLPackageFromString(settings.Go.SQLPackage)
164165

165166
if len(query.Params) == 1 {
166167
p := query.Params[0]
167168
gq.Arg = QueryValue{
168-
Name: paramName(p),
169-
Typ: goType(r, p.Column, settings),
170-
Driver: DriverFromString(settings.Go.Driver),
169+
Name: paramName(p),
170+
Typ: goType(r, p.Column, settings),
171+
SQLPackage: sqlpkg,
171172
}
172173
} else if len(query.Params) > 1 {
173174
var cols []goColumn
@@ -178,19 +179,19 @@ func buildQueries(r *compiler.Result, settings config.CombinedSettings, structs
178179
})
179180
}
180181
gq.Arg = QueryValue{
181-
Emit: true,
182-
Name: "arg",
183-
Struct: columnsToStruct(r, gq.MethodName+"Params", cols, settings),
184-
Driver: DriverFromString(settings.Go.Driver),
182+
Emit: true,
183+
Name: "arg",
184+
Struct: columnsToStruct(r, gq.MethodName+"Params", cols, settings),
185+
SQLPackage: sqlpkg,
185186
}
186187
}
187188

188189
if len(query.Columns) == 1 {
189190
c := query.Columns[0]
190191
gq.Ret = QueryValue{
191-
Name: columnName(c, 0),
192-
Typ: goType(r, c, settings),
193-
Driver: DriverFromString(settings.Go.Driver),
192+
Name: columnName(c, 0),
193+
Typ: goType(r, c, settings),
194+
SQLPackage: sqlpkg,
194195
}
195196
} else if len(query.Columns) > 1 {
196197
var gs *Struct
@@ -228,10 +229,10 @@ func buildQueries(r *compiler.Result, settings config.CombinedSettings, structs
228229
emit = true
229230
}
230231
gq.Ret = QueryValue{
231-
Emit: emit,
232-
Name: "i",
233-
Struct: gs,
234-
Driver: DriverFromString(settings.Go.Driver),
232+
Emit: emit,
233+
Name: "i",
234+
Struct: gs,
235+
SQLPackage: sqlpkg,
235236
}
236237
}
237238

‎internal/codegen/golang/sql_package.go‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
package golang
2+
3+
type SQLPackage string
4+
5+
const (
6+
SQLPackagePGX SQLPackage = "pgx/v4"
7+
SQLPackageStandard SQLPackage = "database/sql"
8+
)
9+
10+
func SQLPackageFromString(s string) SQLPackage {
11+
switch s {
12+
case string(SQLPackagePGX):
13+
return SQLPackagePGX
14+
default:
15+
return SQLPackageStandard
16+
}
17+
}

‎internal/codegen/golang/templates/template.tmpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414

1515
{{define "dbCode"}}
1616

17-
{{if eq .Driver "pgx/v4"}}
17+
{{if eq .SQLPackage "pgx/v4"}}
1818
{{- template "dbCodeTemplatePgx" .}}
1919
{{else}}
2020
{{- template "dbCodeTemplateStd" .}}
@@ -37,7 +37,7 @@ import (
3737
{{end}}
3838

3939
{{define "interfaceCode"}}
40-
{{if eq .Driver "pgx/v4"}}
40+
{{if eq .SQLPackage "pgx/v4"}}
4141
{{- template "interfaceCodePgx" .}}
4242
{{else}}
4343
{{- template "interfaceCodeStd" .}}
@@ -110,9 +110,9 @@ import (
110110
{{end}}
111111

112112
{{define "queryCode"}}
113-
{{if eq .Driver "pgx/v4"}}
113+
{{if eq .SQLPackage "pgx/v4"}}
114114
{{- template "queryCodePgx" .}}
115115
{{else}}
116116
{{- template "queryCodeStd" .}}
117117
{{end}}
118-
{{end}}
118+
{{end}}

‎internal/config/config.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ import (
99
"os"
1010
"strings"
1111

12-
"gopkg.in/yaml.v3"
13-
1412
"github.com/kyleconroy/sqlc/internal/core"
13+
yaml "gopkg.in/yaml.v3"
1514
)
1615

1716
const errMessageNoVersion = `The configuration file must have a version number.
@@ -122,7 +121,7 @@ type SQLGo struct {
122121
Out string `json:"out" yaml:"out"`
123122
Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
124123
Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
125-
Driver string `json:"driver" yaml:"driver"`
124+
SQLPackage string `json:"sql_package" yaml:"sql_package"`
126125
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
127126
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
128127
OutputQuerierFileName string `json:"output_querier_file_name,omitempty" yaml:"output_querier_file_name"`

‎internal/config/v_one.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import (
55
"io"
66
"path/filepath"
77

8-
"gopkg.in/yaml.v3"
8+
yaml "gopkg.in/yaml.v3"
99
)
1010

1111
type V1GenerateSettings struct {
@@ -29,7 +29,7 @@ type v1PackageSettings struct {
2929
EmitEmptySlices bool `json:"emit_empty_slices,omitempty" yaml:"emit_empty_slices"`
3030
EmitExportedQueries bool `json:"emit_exported_queries,omitempty" yaml:"emit_exported_queries"`
3131
JSONTagsCaseStyle string `json:"json_tags_case_style,omitempty" yaml:"json_tags_case_style"`
32-
Driver string `json:"driver" yaml:"driver"`
32+
SQLPackage string `json:"sql_package" yaml:"sql_package"`
3333
Overrides []Override `json:"overrides" yaml:"overrides"`
3434
OutputDBFileName string `json:"output_db_file_name,omitempty" yaml:"output_db_file_name"`
3535
OutputModelsFileName string `json:"output_models_file_name,omitempty" yaml:"output_models_file_name"`
@@ -119,7 +119,7 @@ func (c *V1GenerateSettings) Translate() Config {
119119
EmitExportedQueries: pkg.EmitExportedQueries,
120120
Package: pkg.Name,
121121
Out: pkg.Path,
122-
Driver: pkg.Driver,
122+
SQLPackage: pkg.SQLPackage,
123123
Overrides: pkg.Overrides,
124124
JSONTagsCaseStyle: pkg.JSONTagsCaseStyle,
125125
OutputDBFileName: pkg.OutputDBFileName,

‎internal/endtoend/testdata/alias/postgresql/pgx/sqlc.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
{
55
"path": "go",
66
"engine": "postgresql",
7-
"driver": "pgx/v4",
7+
"sql_package": "pgx/v4",
88
"name": "querytest",
99
"schema": "query.sql",
1010
"queries": "query.sql"

0 commit comments

Comments
 (0)