Re: [GENERAL] item descriptions in psql

Mike Mascari <mascarm@mascari.com>

From: Mike Mascari <mascarm@mascari.com>
To: "Gene Selkov, Jr." <selkovjr@mcs.anl.gov>
Cc: "J. Roeleveld" <j.roeleveld@softhome.net>, pgsql-general@postgreSQL.org
Date: 1999-12-22T08:29:59Z
Lists: pgsql-general
"Gene Selkov, Jr." wrote:
> 
> > Hi,
> >
> > I just found a reference to descriptions to functions/tables/...etc.
> > and am now wondering how to add them myself?
> >
> > Joost Roeleveld
> 
> not sure if there is a shortcut to this (it's short enough already):
> 
> INSERT INTO pg_description (objoid, description)
>   SELECT oid, 'your description' FROM pg_class WHERE relname = 'your_table_name';
> 
> INSERT INTO pg_description (objoid, description)
>   SELECT oid, 'your description' FROM pg_proc WHERE proname = 'your_procedure_name';
> 
> INSERT INTO pg_description (objoid, description)
>   SELECT oid, 'your description' FROM pg_type WHERE typname = 'your_type_name';
> 
> INSERT INTO pg_description (objoid, description)
>   SELECT oid, 'your description' FROM pg_operator WHERE oprname = 'your_operator_name';
> 
> (in case of operators, oprname is '=', '<=', '>>~', etc.)
> 
> in older versions (pre-6.3), one had to typecast the names and descriptions:
> 
> INSERT INTO pg_description (objoid, description)
>   SELECT oid, 'your description'::text FROM pg_type WHERE typname = 'your_type_name'::name;
> 
> --Gene

And also note that pg_dump does not yet dump descriptions.
So, until the next release, if your going to document your
database schema, be sure to dump pg_description before
performing any dump..blow-away..reload sequence.

Mike Mascari