Re: to_regtype() Raises Error

From: "David E(dot) Wheeler" <david(at)justatheory(dot)com>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Chapman Flack <chap(at)anastigmatix(dot)net>, Erik Wienhold <ewie(at)ewie(dot)name>, Vik Fearing <vik(at)postgresfriends(dot)org>, "pgsql-hackers(at)lists(dot)postgresql(dot)org" <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: to_regtype() Raises Error
Date: 2024-02-04 19:20:38
Message-ID: 11B52667-0E1B-492D-86F1-DF2382288E76@justatheory.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Feb 2, 2024, at 15:33, David E. Wheeler <david(at)justatheory(dot)com> wrote:

> Anyway, I’m happy to submit a documentation patch along the lines you suggested.

How’s this?

--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -25460,11 +25460,12 @@ SELECT collation for ('foo' COLLATE "de_DE");
<returnvalue>regtype</returnvalue>
</para>
<para>
- Translates a textual type name to its OID. A similar result is
+ Parses a string of text, extracts a potential type name from it, and
+ translates that name into an OID. A similar result is
obtained by casting the string to type <type>regtype</type> (see
- <xref linkend="datatype-oid"/>); however, this function will return
- <literal>NULL</literal> rather than throwing an error if the name is
- not found.
+ <xref linkend="datatype-oid"/>). Failure to extract a valid potential
+ type name results in an error; however, if the extracted names is not
+ known to the system, this function will return <literal>NULL</literal>.
</para></entry>
</row>
</tbody>

Does similar wording need to apply to other `to_reg*` functions?

Best,

David

Attachment Content-Type Size
v1-0001-Update-to_regtype-docs-regarding-error-condition.patch application/octet-stream 1.8 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Smith 2024-02-04 21:12:18 Re: src/bin/pg_upgrade/t/004_subscription.pl test comment fix
Previous Message David E. Wheeler 2024-02-04 19:07:25 Re: Patch: Add parse_type Function