Use "nullable" instead of "null" in configuration (sqlc-dev#571)

kyleconroy · web-flow · commit b4fac24e82f1 · 2020-06-26T10:25:13.000-07:00
* config: Add the nullable field to overrides

Deprecate the problematic null field
diff --git a/README.md b/README.md
@@ -330,7 +330,7 @@ Each override document has the following keys:
   - The PostgreSQL type to override. Find the full list of supported types in [gen.go](https://github.com/kyleconroy/sqlc/blob/master/internal/dinosql/gen.go#L438).
 - `go_type`:
   - A fully qualified name to a Go type to use in the generated code.
-- `null`:
+- `nullable`:
   - If true, use this type when a column is nullable. Defaults to `false`.
 
 ### Per-Column Type Overrides
diff --git a/internal/codegen/golang/go_type.go b/internal/codegen/golang/go_type.go
@@ -28,7 +28,7 @@ func goInnerType(r *compiler.Result, col *compiler.Column, settings config.Combi
 
 	// package overrides have a higher precedence
 	for _, oride := range settings.Overrides {
-		if oride.DBType != "" && oride.DBType == columnType && oride.Null != notNull {
+		if oride.DBType != "" && oride.DBType == columnType && oride.Nullable != notNull {
 			return oride.GoTypeName
 		}
 	}
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -140,7 +140,9 @@ type Override struct {
 	Engine Engine `json:"engine,omitempty" yaml:"engine"`
 
 	// True if the GoType should override if the maching postgres type is nullable
-	Null bool `json:"null" yaml:"null"`
+	Nullable bool `json:"nullable" yaml:"nullable"`
+	// Deprecated. Use the `nullable` property instead
+	Deprecated_Null bool `json:"null" yaml:"null"`
 
 	// fully qualified name of the column, e.g. `accounts.id`
 	Column string `json:"column" yaml:"column"`
@@ -163,6 +165,12 @@ func (o *Override) Parse() error {
 		o.DBType = o.Deprecated_PostgresType
 	}
 
+	// validate deprecated null field
+	if o.Deprecated_Null {
+		fmt.Fprintf(os.Stderr, "WARNING: \"null\" is deprecated. Instead, use the \"nullable\" field.\n")
+		o.Nullable = true
+	}
+
 	// validate option combinations
 	switch {
 	case o.Column != "" && o.DBType != "":
diff --git a/internal/endtoend/testdata/overrides_nullable/go/db.go b/internal/endtoend/testdata/overrides_nullable/go/db.go
diff --git a/internal/endtoend/testdata/overrides_nullable/go/models.go b/internal/endtoend/testdata/overrides_nullable/go/models.go
diff --git a/internal/endtoend/testdata/overrides_nullable/go/query.sql.go b/internal/endtoend/testdata/overrides_nullable/go/query.sql.go
diff --git a/internal/endtoend/testdata/overrides_nullable/query.sql b/internal/endtoend/testdata/overrides_nullable/query.sql
@@ -0,0 +1,8 @@
+CREATE TABLE foo (
+  bar text,
+  bam name,
+  baz name not null
+);
+
+-- name: ListFoo :many
+SELECT * FROM foo;
diff --git a/internal/endtoend/testdata/overrides_nullable/sqlc.json b/internal/endtoend/testdata/overrides_nullable/sqlc.json
@@ -0,0 +1,28 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "engine": "postgresql",
+      "path": "go",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql"
+    }
+  ],
+  "overrides": [
+    {
+      "db_type": "name",
+      "go_type": "github.com/jackc/pgtype.Name"
+    },
+    {
+      "db_type": "name",
+      "go_type": "github.com/jackc/pgtype.Name",
+      "nullable": true
+    },
+    {
+      "db_type": "text",
+      "go_type": "github.com/jackc/pgtype.Text",
+      "null": true
+    }
+  ]
+}
diff --git a/internal/mysql/gen.go b/internal/mysql/gen.go
@@ -232,7 +232,7 @@ func (pGen PackageGenerator) goTypeCol(col Column) string {
 	colName := col.Name.String()
 
 	for _, oride := range pGen.Overrides {
-		shouldOverride := (oride.DBType != "" && oride.DBType == mySQLType && oride.Null != notNull) ||
+		shouldOverride := (oride.DBType != "" && oride.DBType == mySQLType && oride.Nullable != notNull) ||
 			(oride.ColumnName != "" && oride.ColumnName == colName && oride.Table.Rel == col.Table)
 		if shouldOverride {
 			return oride.GoTypeName

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ func goInnerType(r compiler.Result, col compiler.Column, settings config.Combi`
`28`	`28`
`29`	`29`	`// package overrides have a higher precedence`
`30`	`30`	`for _, oride := range settings.Overrides {`
`31`		`- if oride.DBType != "" && oride.DBType == columnType && oride.Null != notNull {`
	`31`	`+ if oride.DBType != "" && oride.DBType == columnType && oride.Nullable != notNull {`
`32`	`32`	`return oride.GoTypeName`
`33`	`33`	`}`
`34`	`34`	`}`