Better on-disk representations (#206)

* Include full function definitions in on-disk representations * Pretty print constraint definitions * Use prettier type names for columns * Test that numeric type precision is represented * Remove column order from col reps and add them to tables' objreps * Show diff in README
mzabani · Dec 20, 2024 · 4664af3 · 4664af3
1 parent 700f705
commit 4664af3
Show file tree

Hide file tree

Showing 35 changed files with 111 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ $ psql -c "SELECT popular_name FROM animals"
 $ psql -c "ALTER TABLE animals ALTER COLUMN popular_name TYPE VARCHAR(30)"
 ALTER TABLE
 $ codd verify-schema
-Error: DB and expected schemas do not match. Differing objects and their current DB schemas are: {"schemas/public/tables/animals/cols/popular_name":["different-schemas",{"collation":"default","collation_nsp":"pg_catalog","default":null,"generated":"","hasdefault":false,"identity":"","inhcount":0,"local":true,"notnull":true,"order":2,"privileges":null,"type":"varchar","typmod":34}]}
+Error: DB and expected schemas do not match. Differing objects and their current DB schemas are: {"schemas/public/tables/animals/cols/popular_name":["different-schemas",{"collation":"default","collation_nsp":"pg_catalog","default":null,"generated":"","hasdefault":false,"identity":"","inhcount":0,"local":true,"notnull":true,"privileges":null,"type":"character varying(30)"}],"schemas/public/tables/animals/statistics/test_stat_with_expr":["different-schemas",{"definition":"id, popular_name, lower(popular_name::text), (id * 42)","kind":["d","e","f","m"],"owner":"codd_admin"}]}
 ````
 
 </td>
@@ -99,6 +99,18 @@ Automatic merge failed; fix conflicts and then commit the result.
 </td>
 </tr>
 
+<tr>
+<td>Useful diffs</td>
+<td>
+
+````diff
+- "definition": "CHECK (value >= 0::numeric)",
++ "definition": "CHECK (value > 0::numeric)",
+````
+
+</td>
+</tr>
+
 </table>
 
 ¹ Some SQL must run without explicit transactions; single-transaction application only works when none of that is present.  

diff --git a/expected-schema/schemas/public/routines/floatmultirange; b/expected-schema/schemas/public/routines/floatmultirange;
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/floatmultirange;_floatrange b/expected-schema/schemas/public/routines/floatmultirange;_floatrange
@@ -5,7 +5,7 @@
     "argnames": null,
     "args": "VARIADIC public.floatrange[]",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/floatmultirange;floatrange b/expected-schema/schemas/public/routines/floatmultirange;floatrange
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "public.floatrange",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/floatrange;float8,float8 b/expected-schema/schemas/public/routines/floatrange;float8,float8
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "double precision, double precision",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/floatrange;float8,float8,text b/expected-schema/schemas/public/routines/floatrange;float8,float8,text
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "double precision, double precision, text",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/time_subtype_diff;time,time b/expected-schema/schemas/public/routines/time_subtype_diff;time,time
@@ -6,7 +6,7 @@
     ],
     "args": "x time without time zone, y time without time zone",
     "config": null,
-    "definition_md5": "c537e192bed99154c059e7da6626c528",
+    "definition": "SELECT EXTRACT(EPOCH FROM (x - y))",
     "kind": "f",
     "lang": "sql",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/timemultirange; b/expected-schema/schemas/public/routines/timemultirange;
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/timemultirange;_timerange b/expected-schema/schemas/public/routines/timemultirange;_timerange
@@ -5,7 +5,7 @@
     "argnames": null,
     "args": "VARIADIC public.timerange[]",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/timemultirange;timerange b/expected-schema/schemas/public/routines/timemultirange;timerange
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "public.timerange",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/timerange;time,time b/expected-schema/schemas/public/routines/timerange;time,time
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "time without time zone, time without time zone",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/routines/timerange;time,time,text b/expected-schema/schemas/public/routines/timerange;time,time,text
@@ -3,7 +3,7 @@
     "argnames": null,
     "args": "time without time zone, time without time zone, text",
     "config": null,
-    "definition_md5": null,
+    "definition": null,
     "kind": "f",
     "lang": "internal",
     "leakproof": false,

diff --git a/expected-schema/schemas/public/tables/animals/cols/id b/expected-schema/schemas/public/tables/animals/cols/id
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 1,
     "privileges": null,
-    "type": "int4",
-    "typmod": -1
+    "type": "integer"
 }
diff --git a/expected-schema/schemas/public/tables/animals/cols/popular_name b/expected-schema/schemas/public/tables/animals/cols/popular_name
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 2,
     "privileges": null,
-    "type": "text",
-    "typmod": -1
+    "type": "text"
 }
diff --git a/expected-schema/schemas/public/tables/animals/objrep b/expected-schema/schemas/public/tables/animals/objrep
@@ -1,6 +1,10 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [
+        "id",
+        "popular_name"
+    ],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/tables/employee/cols/employee_id b/expected-schema/schemas/public/tables/employee/cols/employee_id
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 1,
     "privileges": null,
-    "type": "int4",
-    "typmod": -1
+    "type": "integer"
 }
diff --git a/expected-schema/schemas/public/tables/employee/cols/employee_name b/expected-schema/schemas/public/tables/employee/cols/employee_name
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 2,
     "privileges": null,
-    "type": "text",
-    "typmod": -1
+    "type": "text"
 }
diff --git a/expected-schema/schemas/public/tables/employee/cols/experience b/expected-schema/schemas/public/tables/employee/cols/experience
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": false,
-    "order": 3,
     "privileges": null,
-    "type": "experience",
-    "typmod": -1
+    "type": "public.experience"
 }
diff --git a/expected-schema/schemas/public/tables/employee/cols/surname b/expected-schema/schemas/public/tables/employee/cols/surname
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": false,
-    "order": 4,
     "privileges": null,
-    "type": "text",
-    "typmod": -1
+    "type": "text"
 }
diff --git a/expected-schema/schemas/public/tables/employee/objrep b/expected-schema/schemas/public/tables/employee/objrep
@@ -1,6 +1,12 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [
+        "employee_id",
+        "employee_name",
+        "experience",
+        "surname"
+    ],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/tables/no_cols_table/objrep b/expected-schema/schemas/public/tables/no_cols_table/objrep
@@ -1,6 +1,7 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/tables/people/objrep b/expected-schema/schemas/public/tables/people/objrep
@@ -1,6 +1,7 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/tables/table_created_with_no_parse_mig/objrep b/expected-schema/schemas/public/tables/table_created_with_no_parse_mig/objrep
@@ -1,6 +1,7 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/tables/transactions/cols/anonymous b/expected-schema/schemas/public/tables/transactions/cols/anonymous
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 5,
     "privileges": null,
-    "type": "bool",
-    "typmod": -1
+    "type": "boolean"
 }
diff --git a/expected-schema/schemas/public/tables/transactions/cols/id b/expected-schema/schemas/public/tables/transactions/cols/id
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 1,
     "privileges": null,
-    "type": "int8",
-    "typmod": -1
+    "type": "bigint"
 }
diff --git a/expected-schema/schemas/public/tables/transactions/cols/payer b/expected-schema/schemas/public/tables/transactions/cols/payer
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 2,
     "privileges": null,
-    "type": "text",
-    "typmod": -1
+    "type": "text"
 }
diff --git a/expected-schema/schemas/public/tables/transactions/cols/receiver b/expected-schema/schemas/public/tables/transactions/cols/receiver
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": true,
-    "order": 3,
     "privileges": null,
-    "type": "text",
-    "typmod": -1
+    "type": "text"
 }
diff --git a/expected-schema/schemas/public/tables/transactions/cols/value b/expected-schema/schemas/public/tables/transactions/cols/value
@@ -8,8 +8,6 @@
     "inhcount": 0,
     "local": true,
     "notnull": false,
-    "order": 4,
     "privileges": null,
-    "type": "numeric",
-    "typmod": 655366
+    "type": "numeric(10,2)"
 }
diff --git a/expected-schema/schemas/public/tables/transactions/constraints/transactions_value_check b/expected-schema/schemas/public/tables/transactions/constraints/transactions_value_check
@@ -1,7 +1,7 @@
 {
     "deferrable": false,
     "deferred": false,
-    "definition": "CHECK ((value > (0)::numeric))",
+    "definition": "CHECK (value > 0::numeric)",
     "fk_deltype": " ",
     "fk_matchtype": " ",
     "fk_ref_table": null,

diff --git a/expected-schema/schemas/public/tables/transactions/objrep b/expected-schema/schemas/public/tables/transactions/objrep
@@ -1,6 +1,13 @@
 {
     "accessmethod": "heap",
     "amoptions": null,
+    "columns_in_order": [
+        "id",
+        "payer",
+        "receiver",
+        "value",
+        "anonymous"
+    ],
     "compositetype": null,
     "forcerowsecurity": false,
     "kind": "r",

diff --git a/expected-schema/schemas/public/types/non_empty_text b/expected-schema/schemas/public/types/non_empty_text
@@ -4,7 +4,7 @@
     "collation_nsp": "pg_catalog",
     "comp_type_table": null,
     "composite_type_attrs": "",
-    "constraints": "false;new_constraint;CHECK ((VALUE <> 'empty'::text)) NOT VALID;true;non_empty_text_check;CHECK ((VALUE <> ''::text))",
+    "constraints": "false;new_constraint;CHECK (VALUE <> 'empty'::text) NOT VALID;true;non_empty_text_check;CHECK (VALUE <> ''::text)",
     "default": null,
     "delim": ",",
     "domain_basetype": "text",

diff --git a/expected-schema/schemas/public/types/non_whitespace_text b/expected-schema/schemas/public/types/non_whitespace_text
@@ -4,7 +4,7 @@
     "collation_nsp": "pg_catalog",
     "comp_type_table": null,
     "composite_type_attrs": "",
-    "constraints": "true;non_whitespace_text_check;CHECK ((TRIM(BOTH FROM VALUE) <> ''::text))",
+    "constraints": "true;non_whitespace_text_check;CHECK (TRIM(BOTH FROM VALUE) <> ''::text)",
     "default": null,
     "delim": ",",
     "domain_basetype": "text",