Re: Remove name as valid parameter for catalog functions

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Thom Brown <thom(at)linux(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Remove name as valid parameter for catalog functions
Date: 2011-03-07 18:00:53
Message-ID: 8687.1299520853@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgadmin-hackers pgsql-docs

Thom Brown <thom(at)linux(dot)com> writes:
> On 7 March 2011 20:49, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote:
>> 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?

Well, the table entries for those functions already show that the
parameter is of type regclass. I think the purpose of the text
descriptions is to help out people who might not immediately get the
implications of that.

Maybe we could say "the name or OID of a table", or some such phrase,
so as to subtly avoid the expectation that what is being referred to
is the datatype named "name"?

regards, tom lane

In response to

Responses

Browse pgadmin-hackers by date

  From Date Subject
Next Message Thom Brown 2011-03-07 18:07:12 Re: Remove name as valid parameter for catalog functions
Previous Message Thom Brown 2011-03-07 17:36:12 Re: [DOCS] Remove name as valid parameter for catalog functions

Browse pgsql-docs by date

  From Date Subject
Next Message Thom Brown 2011-03-07 18:04:48 Re: [HACKERS] Sync rep doc corrections
Previous Message Thom Brown 2011-03-07 17:59:06 Re: Column-level trigger doc typo fix