Add deprecation warning for Python and Kotlin (#1930)

kyleconroy · web-flow · commit 821e24acf7e3 · 2022-11-08T19:40:40.000-08:00
* chore: Add kotlin output

* chore: Add python output

* Add deprecation warnings
diff --git a/internal/config/v_two.go b/internal/config/v_two.go
@@ -3,6 +3,7 @@ package config
 import (
 	"fmt"
 	"io"
+	"os"
 	"path/filepath"
 
 	yaml "gopkg.in/yaml.v3"
@@ -83,6 +84,11 @@ func v2ParseConfig(rd io.Reader) (Config, error) {
 			}
 		}
 		if conf.SQL[j].Gen.Kotlin != nil {
+			fmt.Fprintf(os.Stderr, "WARNING: Built-in Kotlin support is deprecated.\n")
+			fmt.Fprintf(os.Stderr, "  It will be removed in the next version (1.17.0).\n")
+			fmt.Fprintf(os.Stderr, "  You will need to migrate to the sqlc-gen-kotlin plugin. See the step-by-step guide here:\n")
+			fmt.Fprintf(os.Stderr, "  https://docs.sqlc.dev/en/latest/guides/migrating-to-sqlc-gen-kotlin.html\n")
+
 			if conf.SQL[j].Gen.Kotlin.Out == "" {
 				return conf, ErrNoOutPath
 			}
@@ -91,6 +97,11 @@ func v2ParseConfig(rd io.Reader) (Config, error) {
 			}
 		}
 		if conf.SQL[j].Gen.Python != nil {
+			fmt.Fprintf(os.Stderr, "WARNING: Built-in Python support is deprecated.\n")
+			fmt.Fprintf(os.Stderr, "  It will be removed in the next version (1.17.0).\n")
+			fmt.Fprintf(os.Stderr, "  You will need to migrate to the sqlc-gen-python plugin. See the step-by-step guide here:\n")
+			fmt.Fprintf(os.Stderr, "  https://docs.sqlc.dev/en/latest/guides/migrating-to-sqlc-gen-python.html\n")
+
 			if conf.SQL[j].Gen.Python.QueryParameterLimit != nil {
 				if *conf.SQL[j].Gen.Python.QueryParameterLimit < 0 {
 					return conf, ErrInvalidQueryParameterLimit
diff --git a/internal/endtoend/testdata/deprecated_kotlin/.gitignore b/internal/endtoend/testdata/deprecated_kotlin/.gitignore
@@ -0,0 +1,4 @@
+/.gradle/
+/.idea/
+/build/
+/out/
diff --git a/internal/endtoend/testdata/deprecated_kotlin/sqlc.json b/internal/endtoend/testdata/deprecated_kotlin/sqlc.json
@@ -0,0 +1,16 @@
+{
+  "version": "2",
+  "sql": [
+    {
+      "schema": "src/main/resources/authors/postgresql/schema.sql",
+      "queries": "src/main/resources/authors/postgresql/query.sql",
+      "engine": "postgresql",
+      "gen": {
+        "kotlin": {
+          "out": "src/main/kotlin/com/example/authors/postgresql",
+          "package": "com.example.authors.postgresql"
+        }
+      }
+    }
+  ]
+}
diff --git a/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/Models.kt b/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/Models.kt
@@ -0,0 +1,12 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.15.0
+
+package com.example.authors.postgresql
+
+data class Author (
+  val id: Long,
+  val name: String,
+  val bio: String?
+)
+
diff --git a/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/Queries.kt b/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/Queries.kt
@@ -0,0 +1,25 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.15.0
+
+package com.example.authors.postgresql
+
+import java.sql.Connection
+import java.sql.SQLException
+import java.sql.Statement
+
+interface Queries {
+  @Throws(SQLException::class)
+  fun createAuthor(name: String, bio: String?): Author?
+  
+  @Throws(SQLException::class)
+  fun deleteAuthor(id: Long)
+  
+  @Throws(SQLException::class)
+  fun getAuthor(id: Long): Author?
+  
+  @Throws(SQLException::class)
+  fun listAuthors(): List<Author>
+  
+}
+
diff --git a/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/QueriesImpl.kt b/internal/endtoend/testdata/deprecated_kotlin/src/main/kotlin/com/example/authors/postgresql/QueriesImpl.kt
@@ -0,0 +1,107 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.15.0
+
+package com.example.authors.postgresql
+
+import java.sql.Connection
+import java.sql.SQLException
+import java.sql.Statement
+
+const val createAuthor = """-- name: createAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  ?, ?
+)
+RETURNING id, name, bio
+"""
+
+const val deleteAuthor = """-- name: deleteAuthor :exec
+DELETE FROM authors
+WHERE id = ?
+"""
+
+const val getAuthor = """-- name: getAuthor :one
+SELECT id, name, bio FROM authors
+WHERE id = ? LIMIT 1
+"""
+
+const val listAuthors = """-- name: listAuthors :many
+SELECT id, name, bio FROM authors
+ORDER BY name
+"""
+
+class QueriesImpl(private val conn: Connection) : Queries {
+
+  @Throws(SQLException::class)
+  override fun createAuthor(name: String, bio: String?): Author? {
+    return conn.prepareStatement(createAuthor).use { stmt ->
+      stmt.setString(1, name)
+          stmt.setString(2, bio)
+
+      val results = stmt.executeQuery()
+      if (!results.next()) {
+        return null
+      }
+      val ret = Author(
+                results.getLong(1),
+                results.getString(2),
+                results.getString(3)
+            )
+      if (results.next()) {
+          throw SQLException("expected one row in result set, but got many")
+      }
+      ret
+    }
+  }
+
+  @Throws(SQLException::class)
+  override fun deleteAuthor(id: Long) {
+    conn.prepareStatement(deleteAuthor).use { stmt ->
+      stmt.setLong(1, id)
+
+      stmt.execute()
+    }
+  }
+
+  @Throws(SQLException::class)
+  override fun getAuthor(id: Long): Author? {
+    return conn.prepareStatement(getAuthor).use { stmt ->
+      stmt.setLong(1, id)
+
+      val results = stmt.executeQuery()
+      if (!results.next()) {
+        return null
+      }
+      val ret = Author(
+                results.getLong(1),
+                results.getString(2),
+                results.getString(3)
+            )
+      if (results.next()) {
+          throw SQLException("expected one row in result set, but got many")
+      }
+      ret
+    }
+  }
+
+  @Throws(SQLException::class)
+  override fun listAuthors(): List<Author> {
+    return conn.prepareStatement(listAuthors).use { stmt ->
+      
+      val results = stmt.executeQuery()
+      val ret = mutableListOf<Author>()
+      while (results.next()) {
+          ret.add(Author(
+                results.getLong(1),
+                results.getString(2),
+                results.getString(3)
+            ))
+      }
+      ret
+    }
+  }
+
+}
+
diff --git a/internal/endtoend/testdata/deprecated_kotlin/src/main/resources/authors/postgresql/query.sql b/internal/endtoend/testdata/deprecated_kotlin/src/main/resources/authors/postgresql/query.sql
@@ -0,0 +1,19 @@
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE id = $1 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING *;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;
diff --git a/internal/endtoend/testdata/deprecated_kotlin/src/main/resources/authors/postgresql/schema.sql b/internal/endtoend/testdata/deprecated_kotlin/src/main/resources/authors/postgresql/schema.sql
@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   BIGSERIAL PRIMARY KEY,
+          name text      NOT NULL,
+          bio  text
+);
diff --git a/internal/endtoend/testdata/deprecated_python/query.sql b/internal/endtoend/testdata/deprecated_python/query.sql
@@ -0,0 +1,19 @@
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE id = $1 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING *;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;
diff --git a/internal/endtoend/testdata/deprecated_python/schema.sql b/internal/endtoend/testdata/deprecated_python/schema.sql
@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   BIGSERIAL PRIMARY KEY,
+          name text      NOT NULL,
+          bio  text
+);
diff --git a/internal/endtoend/testdata/deprecated_python/sqlc.json b/internal/endtoend/testdata/deprecated_python/sqlc.json
@@ -0,0 +1,18 @@
+{
+  "version": "2",
+  "sql": [
+    {
+      "schema": "schema.sql",
+      "queries": "query.sql",
+      "engine": "postgresql",
+      "gen": {
+        "python": {
+          "out": "src/authors",
+          "package": "authors",
+          "emit_sync_querier": true,
+          "emit_async_querier": true
+        }
+      }
+    }
+  ]
+}
diff --git a/internal/endtoend/testdata/deprecated_python/src/authors/models.py b/internal/endtoend/testdata/deprecated_python/src/authors/models.py
@@ -0,0 +1,12 @@
+# Code generated by sqlc. DO NOT EDIT.
+# versions:
+#   sqlc v1.15.0
+import dataclasses
+from typing import Optional
+
+
+@dataclasses.dataclass()
+class Author:
+    id: int
+    name: str
+    bio: Optional[str]
diff --git a/internal/endtoend/testdata/deprecated_python/src/authors/query.py b/internal/endtoend/testdata/deprecated_python/src/authors/query.py
@@ -0,0 +1,112 @@
+# Code generated by sqlc. DO NOT EDIT.
+# versions:
+#   sqlc v1.15.0
+# source: query.sql
+from typing import AsyncIterator, Iterator, Optional
+
+import sqlalchemy
+import sqlalchemy.ext.asyncio
+
+from authors import models
+
+
+CREATE_AUTHOR = """-- name: create_author \\:one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  :p1, :p2
+)
+RETURNING id, name, bio
+"""
+
+
+DELETE_AUTHOR = """-- name: delete_author \\:exec
+DELETE FROM authors
+WHERE id = :p1
+"""
+
+
+GET_AUTHOR = """-- name: get_author \\:one
+SELECT id, name, bio FROM authors
+WHERE id = :p1 LIMIT 1
+"""
+
+
+LIST_AUTHORS = """-- name: list_authors \\:many
+SELECT id, name, bio FROM authors
+ORDER BY name
+"""
+
+
+class Querier:
+    def __init__(self, conn: sqlalchemy.engine.Connection):
+        self._conn = conn
+
+    def create_author(self, *, name: str, bio: Optional[str]) -> Optional[models.Author]:
+        row = self._conn.execute(sqlalchemy.text(CREATE_AUTHOR), {"p1": name, "p2": bio}).first()
+        if row is None:
+            return None
+        return models.Author(
+            id=row[0],
+            name=row[1],
+            bio=row[2],
+        )
+
+    def delete_author(self, *, id: int) -> None:
+        self._conn.execute(sqlalchemy.text(DELETE_AUTHOR), {"p1": id})
+
+    def get_author(self, *, id: int) -> Optional[models.Author]:
+        row = self._conn.execute(sqlalchemy.text(GET_AUTHOR), {"p1": id}).first()
+        if row is None:
+            return None
+        return models.Author(
+            id=row[0],
+            name=row[1],
+            bio=row[2],
+        )
+
+    def list_authors(self) -> Iterator[models.Author]:
+        result = self._conn.execute(sqlalchemy.text(LIST_AUTHORS))
+        for row in result:
+            yield models.Author(
+                id=row[0],
+                name=row[1],
+                bio=row[2],
+            )
+
+
+class AsyncQuerier:
+    def __init__(self, conn: sqlalchemy.ext.asyncio.AsyncConnection):
+        self._conn = conn
+
+    async def create_author(self, *, name: str, bio: Optional[str]) -> Optional[models.Author]:
+        row = (await self._conn.execute(sqlalchemy.text(CREATE_AUTHOR), {"p1": name, "p2": bio})).first()
+        if row is None:
+            return None
+        return models.Author(
+            id=row[0],
+            name=row[1],
+            bio=row[2],
+        )
+
+    async def delete_author(self, *, id: int) -> None:
+        await self._conn.execute(sqlalchemy.text(DELETE_AUTHOR), {"p1": id})
+
+    async def get_author(self, *, id: int) -> Optional[models.Author]:
+        row = (await self._conn.execute(sqlalchemy.text(GET_AUTHOR), {"p1": id})).first()
+        if row is None:
+            return None
+        return models.Author(
+            id=row[0],
+            name=row[1],
+            bio=row[2],
+        )
+
+    async def list_authors(self) -> AsyncIterator[models.Author]:
+        result = await self._conn.stream(sqlalchemy.text(LIST_AUTHORS))
+        async for row in result:
+            yield models.Author(
+                id=row[0],
+                name=row[1],
+                bio=row[2],
+            )

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package config`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`
`5`	`5`	`"io"`
	`6`	`+ "os"`
`6`	`7`	`"path/filepath"`
`7`	`8`
`8`	`9`	`yaml "gopkg.in/yaml.v3"`
`@@ -83,6 +84,11 @@ func v2ParseConfig(rd io.Reader) (Config, error) {`
`83`	`84`	`}`
`84`	`85`	`}`
`85`	`86`	`if conf.SQL[j].Gen.Kotlin != nil {`
	`87`	`+ fmt.Fprintf(os.Stderr, "WARNING: Built-in Kotlin support is deprecated.\n")`
	`88`	`+ fmt.Fprintf(os.Stderr, " It will be removed in the next version (1.17.0).\n")`
	`89`	`+ fmt.Fprintf(os.Stderr, " You will need to migrate to the sqlc-gen-kotlin plugin. See the step-by-step guide here:\n")`
	`90`	`+ fmt.Fprintf(os.Stderr, " https://docs.sqlc.dev/en/latest/guides/migrating-to-sqlc-gen-kotlin.html\n")`
	`91`	`+`
`86`	`92`	`if conf.SQL[j].Gen.Kotlin.Out == "" {`
`87`	`93`	`return conf, ErrNoOutPath`
`88`	`94`	`}`
`@@ -91,6 +97,11 @@ func v2ParseConfig(rd io.Reader) (Config, error) {`
`91`	`97`	`}`
`92`	`98`	`}`
`93`	`99`	`if conf.SQL[j].Gen.Python != nil {`
	`100`	`+ fmt.Fprintf(os.Stderr, "WARNING: Built-in Python support is deprecated.\n")`
	`101`	`+ fmt.Fprintf(os.Stderr, " It will be removed in the next version (1.17.0).\n")`
	`102`	`+ fmt.Fprintf(os.Stderr, " You will need to migrate to the sqlc-gen-python plugin. See the step-by-step guide here:\n")`
	`103`	`+ fmt.Fprintf(os.Stderr, " https://docs.sqlc.dev/en/latest/guides/migrating-to-sqlc-gen-python.html\n")`
	`104`	`+`
`94`	`105`	`if conf.SQL[j].Gen.Python.QueryParameterLimit != nil {`
`95`	`106`	`if *conf.SQL[j].Gen.Python.QueryParameterLimit < 0 {`
`96`	`107`	`return conf, ErrInvalidQueryParameterLimit`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/.gradle/
 +/.idea/
 +/build/
 +/out/