| --- |
| title: pg_shdescription |
| --- |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| The `pg_shdescription` system catalog table stores optional descriptions (comments) for shared database objects. Descriptions can be manipulated with the `COMMENT` command and viewed with `psql`'s `\d` meta-commands. See also [pg\_description](pg_description.html#topic1), which performs a similar function for descriptions involving objects within a single database. Unlike most system catalogs, `pg_shdescription` is shared across all databases of a HAWQ system: there is only one copy of `pg_shdescription` per system, not one per database. |
| |
| <a id="topic1__hp143898"></a> |
| <span class="tablecap">Table 1. pg\_catalog.pg\_shdescription</span> |
| |
| |
| | column | type | references | description | |
| |---------------|------|----------------|---------------------------------------------------------------| |
| | `objoid` | oid | any OID column | The OID of the object this description pertains to. | |
| | `classoid` | oid | pg\_class.oid | The OID of the system catalog this object appears in | |
| | `description` | text | | Arbitrary text that serves as the description of this object. | |
| |
| |
| |
