Re: Remove name as valid parameter for catalog functions - Mailing list pgsql-docs

From Thom Brown
Subject Re: Remove name as valid parameter for catalog functions
Date
Msg-id AANLkTinZa6Gg5M=jT689bm5qA=40vMuEh60zE+5KmDb7@mail.gmail.com
Whole thread Raw
In response to Re: Remove name as valid parameter for catalog functions  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Remove name as valid parameter for catalog functions
List pgsql-docs
On 7 March 2011 20:49, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> Thom Brown <thom@linux.com> writes:
>> Patch attached which corrects the docs where catalog functions no
>> longer accept values of type name.  Originally a note submitted by
>> someone on the docs, but this affects more than just the one they
>> mentioned.
>
> The reason those are phrased as "OID or name" is that what they take is
> regclass, which means that things like pg_total_relation_size('table_name')
> do in fact work.  I think the proposed wording would leave people with
> the idea that they had to supply a numeric OID, which is a PITA and not
> by any means the expected usage.  I agree that maybe the original
> wording could use some improvement, but I don't think that just removing
> "or name" is an improvement.

That's fair enough, but it still needs changing, as whilst an OID
won't cause an error, a field with the type of name will.  Is it
reasonable to refer to a parameter as required to be of type regclass?

--
Thom Brown
Twitter: @darkixion
IRC (freenode): dark_ixion
Registered Linux user: #516935

pgsql-docs by date:

Previous
From: Thom Brown
Date:
Subject: Re: Sync rep doc corrections
Next
From: David Fetter
Date:
Subject: Re: [HACKERS] Sync rep doc corrections