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 18:13:33
Message-ID: AANLkTi=4uJpPGvu_kHh5GRmkXQDWYAk0XNGBJpb42+z9@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

On Mon, Mar 7, 2011 at 12:59 PM, Thom Brown <thom(at)linux(dot)com> wrote:
> On 7 March 2011 22:39, Robert Haas <robertmhaas(at)gmail(dot)com> wrote:
>> 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.
>
> Yes, absolutely.  In fact that's what I was looking for when I first
> visited that page.
>
> So it would look like this:
>
> where event can be one of:
>
>    INSERT [ OF column ]
>    UPDATE [ OF column ]
>    DELETE [ OF column ]
>    TRUNCATE

Well, the existing documentation says that OF column is only allowed for UPDATE.

--
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 Tom Lane 2011-03-07 18:16:31 Re: [HACKERS] Sync rep doc corrections
Previous Message Robert Haas 2011-03-07 18:11:50 Re: [HACKERS] Sync rep doc corrections

Browse pgsql-hackers by date

  From Date Subject
Next Message Robert Haas 2011-03-07 18:15:59 Re: How should the primary behave when the sync standby goes away? Re: Sync Rep v17
Previous Message Robert Haas 2011-03-07 18:11:50 Re: [HACKERS] Sync rep doc corrections