config: Change database URL to URI (#2407)

kyleconroy · web-flow · commit 5134490bb09b · 2023-07-06T08:11:30.000-07:00
* config: Change database URL to URI

* Fix error message
diff --git a/examples/authors/sqlc.yaml b/examples/authors/sqlc.yaml
@@ -4,7 +4,7 @@ sql:
   queries: postgresql/query.sql
   engine: postgresql
   database:
-    url: postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/authors
+    uri: postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/authors
   rules:
   - sqlc/db-prepare
   gen:
@@ -15,7 +15,7 @@ sql:
   queries: mysql/query.sql
   engine: mysql
   database:
-    url: root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/authors?multiStatements=true&parseTime=true
+    uri: root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/authors?multiStatements=true&parseTime=true
   rules:
   - sqlc/db-prepare
   gen:
@@ -26,7 +26,7 @@ sql:
   queries: sqlite/query.sql
   engine: sqlite
   database:
-    url: file:authors?mode=memory&cache=shared
+    uri: file:authors?mode=memory&cache=shared
   rules:
   - sqlc/db-prepare
   gen:
diff --git a/examples/batch/sqlc.json b/examples/batch/sqlc.json
@@ -8,7 +8,7 @@
       "queries": "postgresql/query.sql",
       "engine": "postgresql",
       "database": {
-        "url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/batch"
+        "uri": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/batch"
       },
       "rules": [
         "sqlc/db-prepare"
diff --git a/examples/booktest/sqlc.json b/examples/booktest/sqlc.json
@@ -8,7 +8,7 @@
       "queries": "postgresql/query.sql",
       "engine": "postgresql",
       "database": {
-        "url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/booktest"
+        "uri": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/booktest"
       },
       "rules": [
         "sqlc/db-prepare"
@@ -21,7 +21,7 @@
       "queries": "mysql/query.sql",
       "engine": "mysql",
       "database": {
-        "url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/booktest?multiStatements=true&parseTime=true"
+        "uri": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/booktest?multiStatements=true&parseTime=true"
       },
       "rules": [
         "sqlc/db-prepare"
@@ -34,7 +34,7 @@
       "queries": "sqlite/query.sql",
       "engine": "sqlite",
       "database": {
-        "url": "file:booktest?mode=memory&cache=shared"
+        "uri": "file:booktest?mode=memory&cache=shared"
       },
       "rules": [
         "sqlc/db-prepare"
diff --git a/examples/jets/sqlc.json b/examples/jets/sqlc.json
@@ -8,7 +8,7 @@
       "queries": "postgresql/query-building.sql",
       "engine": "postgresql",
       "database": {
-        "url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/jets"
+        "uri": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/jets"
       },
       "rules": [
         "sqlc/db-prepare"
diff --git a/examples/ondeck/sqlc.json b/examples/ondeck/sqlc.json
@@ -8,7 +8,7 @@
       "queries": "postgresql/query",
       "engine": "postgresql",
       "database": {
-        "url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/ondeck"
+        "uri": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/ondeck"
       },
       "rules": [
         "sqlc/db-prepare"
@@ -24,7 +24,7 @@
       "queries": "mysql/query",
       "engine": "mysql",
       "database": {
-        "url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/ondeck?multiStatements=true&parseTime=true"
+        "uri": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/ondeck?multiStatements=true&parseTime=true"
       },
       "rules": [
         "sqlc/db-prepare"
@@ -40,7 +40,7 @@
       "queries": "sqlite/query",
       "engine": "sqlite",
       "database": {
-        "url": "file:ondeck?mode=memory&cache=shared"
+        "uri": "file:ondeck?mode=memory&cache=shared"
       },
       "rules": [
         "sqlc/db-prepare"
diff --git a/internal/cmd/vet.go b/internal/cmd/vet.go
@@ -255,7 +255,7 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
 		if c.NoDatabase {
 			return fmt.Errorf("database: connections disabled via command line flag")
 		}
-		dburl, err := c.DSN(s.Database.URL)
+		dburl, err := c.DSN(s.Database.URI)
 		if err != nil {
 			return err
 		}
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -69,7 +69,7 @@ type Project struct {
 }
 
 type Database struct {
-	URL string `json:"url" yaml:"url"`
+	URI string `json:"uri" yaml:"uri"`
 }
 
 type Cloud struct {
diff --git a/internal/config/validate.go b/internal/config/validate.go
@@ -12,8 +12,8 @@ func Validate(c *Config) error {
 			return fmt.Errorf("invalid config: emit_methods_with_db_argument and emit_prepared_queries settings are mutually exclusive")
 		}
 		if sql.Database != nil {
-			if sql.Database.URL == "" {
-				return fmt.Errorf("invalid config: database must have a non-empty URL")
+			if sql.Database.URI == "" {
+				return fmt.Errorf("invalid config: database must have a non-empty URI")
 			}
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -255,7 +255,7 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {`
`255`	`255`	`if c.NoDatabase {`
`256`	`256`	`return fmt.Errorf("database: connections disabled via command line flag")`
`257`	`257`	`}`
`258`		`- dburl, err := c.DSN(s.Database.URL)`
	`258`	`+ dburl, err := c.DSN(s.Database.URI)`
`259`	`259`	`if err != nil {`
`260`	`260`	`return err`
`261`	`261`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ type Project struct {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`type Database struct {`
`72`		- URL string `json:"url" yaml:"url"`
	`72`	+ URI string `json:"uri" yaml:"uri"`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`type Cloud struct {`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,8 @@ func Validate(c *Config) error {`
`12`	`12`	`return fmt.Errorf("invalid config: emit_methods_with_db_argument and emit_prepared_queries settings are mutually exclusive")`
`13`	`13`	`}`
`14`	`14`	`if sql.Database != nil {`
`15`		`- if sql.Database.URL == "" {`
`16`		`- return fmt.Errorf("invalid config: database must have a non-empty URL")`
	`15`	`+ if sql.Database.URI == "" {`
	`16`	`+ return fmt.Errorf("invalid config: database must have a non-empty URI")`
`17`	`17`	`}`
`18`	`18`	`}`
`19`	`19`	`}`