mysql type overrides (#281)

* adds support for mysql type overrides

* adds terminal color package

* adjusts config fields for compatability

* cleans up tests

* adds mysql override tests

* removes changes to booktest and colored warning

* patches example

Author: cmoog

README.md

@@ -331,14 +331,14 @@ instead.
   "overrides": [
       {
           "go_type": "github.com/gofrs/uuid.UUID",
-          "postgres_type": "uuid"
+          "db_type": "uuid"
       }
   ]
 }
 ```
 
 Each override document has the following keys:
-- `postgres_type`:
+- `db_type`:
   - 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.

examples/booktest/mysql/models.go

@@ -25,22 +25,13 @@ INSERT INTO books (
     title,
     yr,
     available,
-    tags,
-    is_hardcover,
-    rating,
-    front_cover_img,
-    back_cover_img
+    tags
 ) VALUES (
     ?,
     ?,
     ?,
     ?,
     ?,
-    ?,
-    ?,
-    ?,
-    ?, 
-    ?,
     ?
 );
 

examples/booktest/mysql/query.sql

@@ -19,11 +19,7 @@ CREATE TABLE books (
           title text NOT NULL DEFAULT '',
           yr integer NOT NULL DEFAULT 2000,
           available datetime NOT NULL DEFAULT NOW(),
-          tags text NOT NULL DEFAULT '',
-          is_hardcover BOOL NOT NULL DEFAULT 0,
-          rating decimal(13, 2),
-          front_cover_img varchar(255),
-          back_cover_img varchar(255)
+          tags text NOT NULL DEFAULT ''
           -- CONSTRAINT FOREIGN KEY (author_id) REFERENCES authors(author_id)
 ) ENGINE=InnoDB;
 

examples/booktest/mysql/query.sql.go

@@ -65,6 +65,8 @@ github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.m
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/evanphx/json-patch v4.5.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
+github.com/fatih/color v1.9.0 h1:8xPHl4/q1VyqGIPif1F+1V3Y3lSmrq01EabUW3CoW5s=
+github.com/fatih/color v1.9.0/go.mod h1:eQcE1qtQxscV5RaZvpXrrb8Drkc3/DdQ+uUYCNjL+zU=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
 github.com/ghodss/yaml v0.0.0-20161207003320-04f313413ffd/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
@@ -211,8 +213,10 @@ github.com/logrusorgru/aurora v0.0.0-20181002194514-a7b3b318ed4e/go.mod h1:7rIyQ
 github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
 github.com/magiconair/properties v1.8.1/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czPbwD3XqdrwzmxQ=
 github.com/matoous/godox v0.0.0-20190911065817-5d6d842e92eb/go.mod h1:1BELzlh859Sh1c6+90blK8lbYy0kwQf1bYlBhBysy1s=
+github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
+github.com/mattn/go-isatty v0.0.11 h1:FxPOTFNqGkuDUGi3H/qkUbQO4ZiBa2brKq5r0l8TGeM=
 github.com/mattn/go-isatty v0.0.11/go.mod h1:PhnuNfih5lzO57/f3n+odYbM4JtupLOxQOAqxQCu2WE=
 github.com/mattn/go-runewidth v0.0.1/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mattn/goveralls v0.0.2/go.mod h1:8d1ZMHsd7fW6IRPKQh46F2WRpyib5/X4FOpevwGNQEw=

examples/booktest/mysql/schema.sql

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"go/types"
 	"io"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -58,43 +59,74 @@ type Override struct {
 	GoType string `json:"go_type"`
 
 	// fully qualified name of the Go type, e.g. `github.com/segmentio/ksuid.KSUID`
-	PostgresType string `json:"postgres_type"`
+	DBType                  string `json:"db_type"`
+	Deprecated_PostgresType string `json:"postgres_type"`
+
+	// for global overrides only when two different engines are in use
+	Engine Engine `json:"engine,omitempty"`
 
 	// True if the GoType should override if the maching postgres type is nullable
 	Null bool `json:"null"`
 
 	// fully qualified name of the column, e.g. `accounts.id`
 	Column string `json:"column"`
 
-	columnName  string
-	table       pg.FQN
-	goTypeName  string
+	ColumnName  string
+	Table       pg.FQN
+	GoTypeName  string
 	goPackage   string
 	goBasicType bool
 }
 
+func (c *GenerateSettings) ValidateGlobalOverrides() error {
+	engines := map[Engine]struct{}{}
+	for _, pkg := range c.Packages {
+		if _, ok := engines[pkg.Engine]; !ok {
+			engines[pkg.Engine] = struct{}{}
+		}
+	}
+
+	usesMultipleEngines := len(engines) > 1
+	for _, oride := range c.Overrides {
+		if usesMultipleEngines && oride.Engine == "" {
+			return fmt.Errorf(`the "engine" field is required for global type overrides because your configuration uses multiple database engines`)
+		}
+	}
+	return nil
+}
+
 func (o *Override) Parse() error {
+
+	// validate deprecated postgres_type field
+	if o.Deprecated_PostgresType != "" {
+		fmt.Fprintf(os.Stderr, "WARNING: \"postgres_type\" is deprecated. Instead, use \"db_type\" to specify a type override.\n")
+		if o.DBType != "" {
+			return fmt.Errorf(`Type override configurations cannot have "db_type" and "postres_type" together. Use "db_type" alone`)
+		}
+		o.DBType = o.Deprecated_PostgresType
+	}
+
 	// validate option combinations
 	switch {
-	case o.Column != "" && o.PostgresType != "":
-		return fmt.Errorf("Override specifying both `column` (%q) and `postgres_type` (%q) is not valid.", o.Column, o.PostgresType)
-	case o.Column == "" && o.PostgresType == "":
-		return fmt.Errorf("Override must specify one of either `column` or `postgres_type`")
+	case o.Column != "" && o.DBType != "":
+		return fmt.Errorf("Override specifying both `column` (%q) and `db_type` (%q) is not valid.", o.Column, o.DBType)
+	case o.Column == "" && o.DBType == "":
+		return fmt.Errorf("Override must specify one of either `column` or `db_type`")
 	}
 
 	// validate Column
 	if o.Column != "" {
 		colParts := strings.Split(o.Column, ".")
 		switch len(colParts) {
 		case 2:
-			o.columnName = colParts[1]
-			o.table = pg.FQN{Schema: "public", Rel: colParts[0]}
+			o.ColumnName = colParts[1]
+			o.Table = pg.FQN{Schema: "public", Rel: colParts[0]}
 		case 3:
-			o.columnName = colParts[2]
-			o.table = pg.FQN{Schema: colParts[0], Rel: colParts[1]}
+			o.ColumnName = colParts[2]
+			o.Table = pg.FQN{Schema: colParts[0], Rel: colParts[1]}
 		case 4:
-			o.columnName = colParts[3]
-			o.table = pg.FQN{Catalog: colParts[0], Schema: colParts[1], Rel: colParts[2]}
+			o.ColumnName = colParts[3]
+			o.Table = pg.FQN{Catalog: colParts[0], Schema: colParts[1], Rel: colParts[2]}
 		default:
 			return fmt.Errorf("Override `column` specifier %q is not the proper format, expected '[catalog.][schema.]colname.tablename'", o.Column)
 		}
@@ -144,11 +176,11 @@ func (o *Override) Parse() error {
 		}
 		o.goPackage = o.GoType[:lastDot]
 	}
-	o.goTypeName = typename
+	o.GoTypeName = typename
 	isPointer := o.GoType[0] == '*'
 	if isPointer {
 		o.goPackage = o.goPackage[1:]
-		o.goTypeName = "*" + o.goTypeName
+		o.GoTypeName = "*" + o.GoTypeName
 	}
 
 	return nil
@@ -176,6 +208,9 @@ func ParseConfig(rd io.Reader) (GenerateSettings, error) {
 	if len(config.Packages) == 0 {
 		return config, ErrNoPackages
 	}
+	if err := config.ValidateGlobalOverrides(); err != nil {
+		return config, err
+	}
 	for i := range config.Overrides {
 		if err := config.Overrides[i].Parse(); err != nil {
 			return config, err

go.sum

@@ -71,8 +71,8 @@ func TestTypeOverrides(t *testing.T) {
 	}{
 		{
 			Override{
-				PostgresType: "uuid",
-				GoType:       "github.com/segmentio/ksuid.KSUID",
+				DBType: "uuid",
+				GoType: "github.com/segmentio/ksuid.KSUID",
 			},
 			"github.com/segmentio/ksuid",
 			"ksuid.KSUID",
@@ -82,7 +82,7 @@ func TestTypeOverrides(t *testing.T) {
 		//
 		// {
 		// 	Override{
-		// 		PostgresType: "uuid",
+		// 		DBType: "uuid",
 		// 		GoType:       "github.com/segmentio/*ksuid.KSUID",
 		// 	},
 		// 	"github.com/segmentio/ksuid",
@@ -91,8 +91,8 @@ func TestTypeOverrides(t *testing.T) {
 		// },
 		{
 			Override{
-				PostgresType: "citext",
-				GoType:       "string",
+				DBType: "citext",
+				GoType: "string",
 			},
 			"",
 			"string",
@@ -104,7 +104,7 @@ func TestTypeOverrides(t *testing.T) {
 			if err := tt.override.Parse(); err != nil {
 				t.Fatalf("override parsing failed; %s", err)
 			}
-			if diff := cmp.Diff(tt.typeName, tt.override.goTypeName); diff != "" {
+			if diff := cmp.Diff(tt.typeName, tt.override.GoTypeName); diff != "" {
 				t.Errorf("type name mismatch;\n%s", diff)
 			}
 			if diff := cmp.Diff(tt.pkg, tt.override.goPackage); diff != "" {
@@ -121,15 +121,15 @@ func TestTypeOverrides(t *testing.T) {
 	}{
 		{
 			Override{
-				PostgresType: "uuid",
-				GoType:       "Pointer",
+				DBType: "uuid",
+				GoType: "Pointer",
 			},
 			"Package override `go_type` specifier \"Pointer\" is not a Go basic type e.g. 'string'",
 		},
 		{
 			Override{
-				PostgresType: "uuid",
-				GoType:       "untyped rune",
+				DBType: "uuid",
+				GoType: "untyped rune",
 			},
 			"Package override `go_type` specifier \"untyped rune\" is not a Go basic type e.g. 'string'",
 		},