blob: 4fe42a4ad1d288b34476eee482afd04bb29f51b9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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>51.47. pg_shdescription</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 V1.79.1" /><link rel="prev" href="catalog-pg-shdepend.html" title="51.46. pg_shdepend" /><link rel="next" href="catalog-pg-shseclabel.html" title="51.48. pg_shseclabel" /></head><body id="docContent" class="container-fluid col-10"><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">51.47. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_shdescription</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="catalog-pg-shdepend.html" title="51.46. pg_shdepend">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="catalogs.html" title="Chapter 51. System Catalogs">Up</a></td><th width="60%" align="center">Chapter 51. System Catalogs</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="catalog-pg-shseclabel.html" title="51.48. pg_shseclabel">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="CATALOG-PG-SHDESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both">51.47. <code class="structname">pg_shdescription</code></h2></div></div></div><a id="id-1.10.4.49.2" class="indexterm"></a><p>
The catalog <code class="structname">pg_shdescription</code> stores optional
descriptions (comments) for shared database objects. Descriptions can be
manipulated with the <a class="xref" href="sql-comment.html" title="COMMENT"><span class="refentrytitle">COMMENT</span></a> command and viewed with
<span class="application">psql</span>'s <code class="literal">\d</code> commands.
</p><p>
See also <a class="link" href="catalog-pg-description.html" title="51.19. pg_description"><code class="structname">pg_description</code></a>,
which performs a similar function for descriptions involving objects
within a single database.
</p><p>
Unlike most system catalogs, <code class="structname">pg_shdescription</code>
is shared across all databases of a cluster: there is only one
copy of <code class="structname">pg_shdescription</code> per cluster, not
one per database.
</p><div class="table" id="id-1.10.4.49.6"><p class="title"><strong>Table 51.47. <code class="structname">pg_shdescription</code> Columns</strong></p><div class="table-contents"><table class="table" summary="pg_shdescription Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">
Column Type
</p>
<p>
Description
</p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
<code class="structfield">objoid</code> <code class="type">oid</code>
(references any OID column)
</p>
<p>
The OID of the object this description pertains to
</p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
<code class="structfield">classoid</code> <code class="type">oid</code>
(references <a class="link" href="catalog-pg-class.html" title="51.11. pg_class"><code class="structname">pg_class</code></a>.<code class="structfield">oid</code>)
</p>
<p>
The OID of the system catalog this object appears in
</p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
<code class="structfield">description</code> <code class="type">text</code>
</p>
<p>
Arbitrary text that serves as the description of this object
</p></td></tr></tbody></table></div></div><br class="table-break" /></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="catalog-pg-shdepend.html" title="51.46. pg_shdepend">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="catalogs.html" title="Chapter 51. System Catalogs">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="catalog-pg-shseclabel.html" title="51.48. pg_shseclabel">Next</a></td></tr><tr><td width="40%" align="left" valign="top">51.46. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_shdepend</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 51.48. <code xmlns="http://www.w3.org/1999/xhtml" class="structname">pg_shseclabel</code></td></tr></table></div></body></html>
|
