public inbox for [email protected]  

help / color / mirror / Atom feed

From: Alvaro Herrera <[email protected]>
To: [email protected]
To: [email protected]
Subject: Re: Adding a Column documentation is misleading
Date: Wed, 6 Nov 2019 10:13:30 -0300
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

On 2019-Nov-06, PG Doc comments form wrote:

> Page: https://www.postgresql.org/docs/12/ddl-alter.html
> Description:
> 
> In 5.6.1. Adding a Column, there is a kind of example 'ALTER TABLE products
> ADD COLUMN description text;'
> 
> The words 'description' and 'text' are misleading -- as according to the
> formal documentation of the SQL command
> (https://www.postgresql.org/docs/12/sql-altertable.html), they should be
> 'column_name' and 'data_type'.

Well, it's an example, so "description" is the column name and "text" is
its data type.  If you had a table called products, you could run that
command and it would work just fine (assuming you don't already have a
column called description, doh).

Maybe the example could be made clearer by using some other column name
and some other data type, so that they don't resemble english prose or
keywords.  Maybe "alter table cities add column year_founded integer".
Do you want to propose something better than that?

> A similar problem exists for removing a column, and other actions.

Let's hear your proposed changes.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

view thread (4+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Adding a Column documentation is misleading
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox