Re: Column-level trigger doc typo fix

From: Robert Haas <robertmhaas(at)gmail(dot)com>
To: Thom Brown <thom(at)linux(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>, PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Column-level trigger doc typo fix
Date: 2011-03-07 17:09:18
Message-ID: AANLkTikAFXQXqm8H9drXfEFmgDnNGtVNHT70tmXVgGB6@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Mon, Mar 7, 2011 at 7:05 AM, Thom Brown <thom(at)linux(dot)com> wrote:
> This was spotted by someone who sent in a doc comment, although didn't
> go with their suggestion.  Patch attached.

That's not really a typo so much as a think-o, I think. Maybe a
little more text would help clarify: A column-specific trigger (one
defined using the <literal>UPDATE OF
<replaceable>column_name</replaceable></literal> syntax) will fire
when...

I think it would also be worth modifying this page so that the
definition of event is in the syntax synopsis.

Right now:

rhaas=# \h create trigger
Command: CREATE TRIGGER
Description: define a new trigger
Syntax:
CREATE [ CONSTRAINT ] TRIGGER name { BEFORE | AFTER | INSTEAD OF } {
event [ OR ... ] }
ON table
[ FROM referenced_table_name ]
{ NOT DEFERRABLE | [ DEFERRABLE ] { INITIALLY IMMEDIATE |
INITIALLY DEFERRED } }
[ FOR [ EACH ] { ROW | STATEMENT } ]
[ WHEN ( condition ) ]
EXECUTE PROCEDURE function_name ( arguments )

It should really go on to say... "where event can be one of...", like
EXPLAIN and COPY do, shouldn't it? Otherwise it's pretty hard to tell
what you should put there without looking up the main docs.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Thom Brown 2011-03-07 17:23:17 Re: Sync rep doc corrections
Previous Message Robert Haas 2011-03-07 17:01:19 Re: Sync rep doc corrections

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2011-03-07 17:16:59 Re: Theory of operation of collation patch
Previous Message Robert Haas 2011-03-07 17:01:19 Re: Sync rep doc corrections