begriffs open source - ai-pg/blob - full-docs/txt/catalog-pg-description.txt

   1
   2 52.19. pg_description #
   3
   4    The catalog pg_description stores optional descriptions (comments) for
   5    each database object. Descriptions can be manipulated with the COMMENT
   6    command and viewed with psql's \d commands. Descriptions of many
   7    built-in system objects are provided in the initial contents of
   8    pg_description.
   9
  10    See also pg_shdescription, which performs a similar function for
  11    descriptions involving objects that are shared across a database
  12    cluster.
  13
  14    Table 52.19. pg_description Columns
  15
  16    Column Type
  17
  18    Description
  19
  20    objoid oid (references any OID column)
  21
  22    The OID of the object this description pertains to
  23
  24    classoid oid (references pg_class.oid)
  25
  26    The OID of the system catalog this object appears in
  27
  28    objsubid int4
  29
  30    For a comment on a table column, this is the column number (the objoid
  31    and classoid refer to the table itself). For all other object types,
  32    this column is zero.
  33
  34    description text
  35
  36    Arbitrary text that serves as the description of this object