Hello,
While reading "Composite Types" manual page I've noticed that it is
somewhat hard to follow by trying out given examples. I suggest three
small changes which would make this page a little easier to follow for
me:
1. Clarify "different kind" by adding a link to a section of "create
type" page
> Note that the AS keyword is essential; without it, the system will
think a different kind of CREATE TYPE command is meant, and you will get
odd syntax errors.
Here there is no link to CREATE TYPE, so it's not so easy to go there to
see what is that "different kind" of CREATE TYPE. I suggest to add an
anchor for the "Base Types" section there and link the words "different
kind" there.
2. make first mention of CREATE TABLE a link
> The syntax is comparable to CREATE TABLE, except ...
It would be useful if this CREATE TABLE (first on this page) would
become a link.
3. Simplify CREATE TABLE example to make it self-sufficient
One of the examples on the same "Composite Types" page is an example of
CREATE TABLE:
CREATE TABLE inventory_item (
name text,
supplier_id integer REFERENCES suppliers,
price numeric CHECK (price > 0)
);
This example is not self-sufficient: it requires one to have "suppliers"
table with specific column to work as given. This table is actively used
in examples below, like
SELECT * FROM inventory_item c ORDER BY c;
and many others, so I think it's important to make this example easy to
reproduce. It seems to me that loosing "REFERENCES suppliers", while
loses something a bit interesting, adds something more important:
simplicity for the newcomers. So I suggest removing this part.
Please see attached patches as an example of these three changes.
Any comments? Do you think this is an improvement?
--
Anton Voloshin
Postgres Professional, The Russian Postgres Company
https://postgrespro.ruFrom df2a1b5cb323d639bcf75fac6799b89b40dec972 Mon Sep 17 00:00:00 2001
From: Anton Voloshin <a.volos...@postgrespro.ru>
Date: Fri, 12 Apr 2024 22:49:17 +0300
Subject: [PATCH 1/3] clarify "different kind" by adding a link to a section of
"create type" page
---
doc/src/sgml/ref/create_type.sgml | 2 +-
doc/src/sgml/rowtypes.sgml | 3 ++-
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/ref/create_type.sgml b/doc/src/sgml/ref/create_type.sgml
index 994dfc65268..b975531864b 100644
--- a/doc/src/sgml/ref/create_type.sgml
+++ b/doc/src/sgml/ref/create_type.sgml
@@ -188,7 +188,7 @@ CREATE TYPE <replaceable class="parameter">name</replaceable>
</para>
</refsect2>
- <refsect2>
+ <refsect2 id="sql-createtype-base">
<title>Base Types</title>
<para>
diff --git a/doc/src/sgml/rowtypes.sgml b/doc/src/sgml/rowtypes.sgml
index bbeac84d46a..9d658a70c41 100644
--- a/doc/src/sgml/rowtypes.sgml
+++ b/doc/src/sgml/rowtypes.sgml
@@ -39,7 +39,8 @@ CREATE TYPE inventory_item AS (
The syntax is comparable to <command>CREATE TABLE</command>, except that only
field names and types can be specified; no constraints (such as <literal>NOT
NULL</literal>) can presently be included. Note that the <literal>AS</literal> keyword
- is essential; without it, the system will think a different kind
+ is essential; without it, the system will think a <link
+ linkend="sql-createtype-base">different kind</link>
of <command>CREATE TYPE</command> command is meant, and you will get odd syntax
errors.
</para>
--
2.43.2
From 18ba7e3b722d707442bca2288f1338f5803f396a Mon Sep 17 00:00:00 2001
From: Anton Voloshin <a.volos...@postgrespro.ru>
Date: Fri, 12 Apr 2024 22:56:18 +0300
Subject: [PATCH 2/3] composite types: make first mention of CREATE TABLE a
link
---
doc/src/sgml/rowtypes.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/rowtypes.sgml b/doc/src/sgml/rowtypes.sgml
index 9d658a70c41..e6ae26a0446 100644
--- a/doc/src/sgml/rowtypes.sgml
+++ b/doc/src/sgml/rowtypes.sgml
@@ -36,7 +36,7 @@ CREATE TYPE inventory_item AS (
price numeric
);
</programlisting>
- The syntax is comparable to <command>CREATE TABLE</command>, except that only
+ The syntax is comparable to <xref linkend="sql-createtable"/>, except that only
field names and types can be specified; no constraints (such as <literal>NOT
NULL</literal>) can presently be included. Note that the <literal>AS</literal> keyword
is essential; without it, the system will think a <link
--
2.43.2
From 38d8dfca22cdb18fc5c9c538fc0433141e8d89ab Mon Sep 17 00:00:00 2001
From: Anton Voloshin <a.volos...@postgrespro.ru>
Date: Fri, 12 Apr 2024 22:58:45 +0300
Subject: [PATCH 3/3] Composite Types: simplify CREATE TABLE example to make it
self-sufficient
---
doc/src/sgml/rowtypes.sgml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/src/sgml/rowtypes.sgml b/doc/src/sgml/rowtypes.sgml
index e6ae26a0446..732cc2d7a6e 100644
--- a/doc/src/sgml/rowtypes.sgml
+++ b/doc/src/sgml/rowtypes.sgml
@@ -75,7 +75,7 @@ SELECT price_extension(item, 10) FROM on_hand;
<programlisting>
CREATE TABLE inventory_item (
name text,
- supplier_id integer REFERENCES suppliers,
+ supplier_id integer,
price numeric CHECK (price > 0)
);
</programlisting>
--
2.43.2
