begriffs open source - ai-pg/blob - full-docs/src/sgml/html/catalog-pg-description.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>52.19. pg_description</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="catalog-pg-depend.html" title="52.18. pg_depend" /><link rel="next" href="catalog-pg-enum.html" title="52.20. pg_enum" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">52.19. <code class="structname">pg_description</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="catalog-pg-depend.html" title="52.18. pg_depend">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="catalogs.html" title="Chapter 52. System Catalogs">Up</a></td><th width="60%" align="center">Chapter 52. System Catalogs</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="catalog-pg-enum.html" title="52.20. pg_enum">Next</a></td></tr></table><hr /></div><div class="sect1" id="CATALOG-PG-DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both">52.19. <code class="structname">pg_description</code> <a href="#CATALOG-PG-DESCRIPTION" class="id_link">#</a></h2></div></div></div><a id="id-1.10.4.21.2" class="indexterm"></a><p>
   3    The catalog <code class="structname">pg_description</code> stores optional descriptions
   4    (comments) for each database object.  Descriptions can be manipulated
   5    with the <a class="link" href="sql-comment.html" title="COMMENT"><code class="command">COMMENT</code></a> command and viewed with
   6    <span class="application">psql</span>'s <code class="literal">\d</code> commands.
   7    Descriptions of many built-in system objects are provided in the initial
   8    contents of <code class="structname">pg_description</code>.
   9   </p><p>
  10    See also <a class="link" href="catalog-pg-shdescription.html" title="52.49. pg_shdescription"><code class="structname">pg_shdescription</code></a>,
  11    which performs a similar function for descriptions involving objects that
  12    are shared across a database cluster.
  13   </p><div class="table" id="id-1.10.4.21.5"><p class="title"><strong>Table 52.19. <code class="structname">pg_description</code> Columns</strong></p><div class="table-contents"><table class="table" summary="pg_description Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">
  14        Column Type
  15       </p>
  16       <p>
  17        Description
  18       </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
  19        <code class="structfield">objoid</code> <code class="type">oid</code>
  20        (references any OID column)
  21       </p>
  22       <p>
  23        The OID of the object this description pertains to
  24       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  25        <code class="structfield">classoid</code> <code class="type">oid</code>
  26        (references <a class="link" href="catalog-pg-class.html" title="52.11. pg_class"><code class="structname">pg_class</code></a>.<code class="structfield">oid</code>)
  27       </p>
  28       <p>
  29        The OID of the system catalog this object appears in
  30       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  31        <code class="structfield">objsubid</code> <code class="type">int4</code>
  32       </p>
  33       <p>
  34        For a comment on a table column, this is the column number (the
  35        <code class="structfield">objoid</code> and <code class="structfield">classoid</code> refer to
  36        the table itself).  For all other object types, this column is
  37        zero.
  38       </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
  39        <code class="structfield">description</code> <code class="type">text</code>
  40       </p>
  41       <p>
  42        Arbitrary text that serves as the description of this object
  43       </p></td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="catalog-pg-depend.html" title="52.18. pg_depend">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="catalogs.html" title="Chapter 52. System Catalogs">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="catalog-pg-enum.html" title="52.20. pg_enum">Next</a></td></tr><tr><td width="40%" align="left" valign="top">52.18. <code class="structname">pg_depend</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 52.20. <code class="structname">pg_enum</code></td></tr></table></div></body></html>