Re: Use uppercase keywords in foreign key tutorial

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Nathan Bossart <nathandbossart(at)gmail(dot)com>, Euler Taveira <euler(at)eulerto(dot)com>, David Rowley <dgrowleyml(at)gmail(dot)com>, Erik Wienhold <ewie(at)ewie(dot)name>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Use uppercase keywords in foreign key tutorial
Date: 2025-10-29 20:48:44
Message-ID: 2903384.1761770924@sss.pgh.pa.us
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Bruce Momjian <bruce(at)momjian(dot)us> writes:
> On Tue, Oct 28, 2025 at 04:34:45PM -0500, Nathan Bossart wrote:
>> I noticed the patch also changes some column types to lowercase:
>> ...
>> - category_N TEXT
>> + category_N text
>>
>> FWIW I tend to use uppercase for those, too, but I'm not sure there is a
>> preferred style for the docs.

> Agreed, uppercase is better for type names.

"text" is not a keyword according to either us or the SQL standard.
I agree that there's some reason to capitalize things that are
grammar keywords, such as INTEGER or VARCHAR, but it's a big stretch
to go from that to capitalizing everything that is a type name.
Would you capitalize user-defined type names?

A concrete reason for worrying about this distinction is that the
keywords will be interpreted the same regardless of search_path,
but ordinary-identifier names will not.

But having said that, I think 100% consistency about this sort of
stylistic choice is neither achievable (for any long period) nor
particularly desirable. In the worst case it could mislead novices
into thinking that case is significant when it isn't.

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David Rowley 2025-10-29 21:24:30 Re: Use uppercase keywords in foreign key tutorial
Previous Message Bruce Momjian 2025-10-29 20:34:24 Re: Use uppercase keywords in foreign key tutorial