table comments (#91)

oyvindberg · Apr 22, 2024 · 1b296da · 1b296da
1 parent b00a33f
commit 1b296da
Show file tree

Hide file tree

Showing 547 changed files with 1,156 additions and 9 deletions.
diff --git a/...norm@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...norm@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -21,6 +21,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -21,6 +21,9 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -19,6 +19,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...r-anorm@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...r-anorm@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -25,6 +25,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...norm@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...norm@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -21,6 +21,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -21,6 +21,9 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -19,6 +19,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...r-anorm@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...r-anorm@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -25,6 +25,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...-anorm@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...-anorm@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -21,6 +21,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -21,6 +21,9 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -19,6 +19,8 @@ import scala.collection.immutable.ListMap
 import scala.util.Try
 import testdb.hardcoded.Text
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...ter-anorm@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...ter-anorm@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -25,6 +25,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...obie@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...obie@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...-doobie@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...-doobie@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...edFiles/testdb/hardcoded/testInsert.scala → ...edFiles/testdb/hardcoded/TestInsert.scala b/...edFiles/testdb/hardcoded/testInsert.scala → ...edFiles/testdb/hardcoded/TestInsert.scala
diff --git a/...obie@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...obie@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...-doobie@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...-doobie@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...doobie@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...doobie@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import io.circe.Decoder
 import io.circe.Encoder
 import java.sql.ResultSet
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...er-doobie@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...er-doobie@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import testdb.hardcoded.myschema.Sector
 import testdb.hardcoded.myschema.football_club.FootballClubId
 import testdb.hardcoded.myschema.marital_status.MaritalStatusId
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...jdbc@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...jdbc@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...2/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...io-jdbc@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...io-jdbc@jvm212/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...edFiles/testdb/hardcoded/testInsert.scala → ...edFiles/testdb/hardcoded/TestInsert.scala b/...edFiles/testdb/hardcoded/testInsert.scala → ...edFiles/testdb/hardcoded/TestInsert.scala
diff --git a/...jdbc@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...jdbc@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...io-jdbc@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...io-jdbc@jvm213/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/...o-jdbc@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala b/...o-jdbc@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/compositepk/person/PersonRow.scala
@@ -16,6 +16,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: compositepk.person
+    Composite primary key: one, two */
 case class PersonRow(
   /** Default: auto-increment */
   one: Long,

diff --git a/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala b/...3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/football_club/FootballClubRow.scala
@@ -16,6 +16,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.football_club
+    football club
+    Primary key: id */
 case class FootballClubRow(
   id: FootballClubId,
   name: /* max 100 chars */ String

diff --git a/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala b/...scripts.GenHardcodedFiles/testdb/hardcoded/myschema/marital_status/MaritalStatusRow.scala
@@ -15,6 +15,8 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.marital_status
+    Primary key: id */
 case class MaritalStatusRow(
   id: MaritalStatusId
 )

diff --git a/...-zio-jdbc@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala b/...-zio-jdbc@jvm3/scripts.GenHardcodedFiles/testdb/hardcoded/myschema/person/PersonRow.scala
@@ -20,6 +20,9 @@ import zio.json.JsonEncoder
 import zio.json.ast.Json
 import zio.json.internal.Write
 
+/** Table: myschema.person
+    person table
+    Primary key: id */
 case class PersonRow(
   /** Default: auto-increment */
   id: PersonId,

diff --git a/sql/custom/table_comments.sql b/sql/custom/table_comments.sql
@@ -0,0 +1,6 @@
+SELECT n.nspname                                     as schema,
+       c.relname                                     as name,
+       pg_catalog.obj_description(c.oid, 'pg_class') as description
+FROM pg_catalog.pg_class c
+         JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+WHERE c.relkind = 'r';
diff --git a/typo-scripts/src/scala/scripts/GenHardcodedFiles.scala b/typo-scripts/src/scala/scripts/GenHardcodedFiles.scala
@@ -17,6 +17,7 @@ object GenHardcodedFiles extends BleepCodegenScript("GenHardcodedFiles") {
 
   val person = db.Table(
     name = db.RelationName(Some("myschema"), "person"),
+    comment = Some("person table"),
     cols = NonEmptyList(
       db.Col(ParsedName.of("id"), db.Type.Int8, Some("int8"), Nullability.NoNulls, columnDefault = Some("auto-increment"), None, None, Nil, DebugJson.Empty),
       db.Col(
@@ -90,6 +91,7 @@ object GenHardcodedFiles extends BleepCodegenScript("GenHardcodedFiles") {
   )
   val football_club = db.Table(
     name = db.RelationName(Some("myschema"), "football_club"),
+    comment = Some("football club"),
     cols = NonEmptyList(
       db.Col(ParsedName.of("id"), db.Type.Int8, Some("int8"), Nullability.NoNulls, columnDefault = None, None, None, Nil, DebugJson.Empty),
       db.Col(ParsedName.of("name"), db.Type.VarChar(Some(100)), Some("varchar"), Nullability.NoNulls, columnDefault = None, None, None, Nil, DebugJson.Empty)
@@ -100,6 +102,7 @@ object GenHardcodedFiles extends BleepCodegenScript("GenHardcodedFiles") {
   )
   val marital_status = db.Table(
     name = db.RelationName(Some("myschema"), "marital_status"),
+    comment = None,
     cols = NonEmptyList(
       db.Col(ParsedName.of("id"), db.Type.Int8, Some("int8"), Nullability.NoNulls, columnDefault = None, None, None, Nil, DebugJson.Empty)
     ),
@@ -110,6 +113,7 @@ object GenHardcodedFiles extends BleepCodegenScript("GenHardcodedFiles") {
 
   val cpk_person = db.Table(
     name = db.RelationName(Some("compositepk"), "person"), // name clash to ensure we handle it
+    comment = None,
     cols = NonEmptyList(
       db.Col(ParsedName.of("one"), db.Type.Int8, Some("int8"), Nullability.NoNulls, columnDefault = Some("auto-increment"), None, None, Nil, DebugJson.Empty),
       db.Col(ParsedName.of("two"), db.Type.Text, Some("text"), Nullability.Nullable, columnDefault = Some("auto-increment"), None, None, Nil, DebugJson.Empty),

diff --git a/typo-tester-anorm/generated-and-checked-in/adventureworks/hr/d/DViewRow.scala b/typo-tester-anorm/generated-and-checked-in/adventureworks/hr/d/DViewRow.scala
@@ -20,6 +20,7 @@ import play.api.libs.json.Reads
 import scala.collection.immutable.ListMap
 import scala.util.Try
 
+/** View: hr.d */
 case class DViewRow(
   /** Points to [[humanresources.department.DepartmentRow.departmentid]] */
   id: DepartmentId,

diff --git a/typo-tester-anorm/generated-and-checked-in/adventureworks/hr/e/EViewRow.scala b/typo-tester-anorm/generated-and-checked-in/adventureworks/hr/e/EViewRow.scala
@@ -25,6 +25,7 @@ import play.api.libs.json.Writes
 import scala.collection.immutable.ListMap
 import scala.util.Try
 
+/** View: hr.e */
 case class EViewRow(
   /** Points to [[humanresources.employee.EmployeeRow.businessentityid]] */
   id: BusinessentityId,