Help Center/ GaussDB/ Developer Guide(Distributed_2.x)/ System Catalogs and System Views/ System Catalogs/ PG_SHDESCRIPTION

Updated on 2023-10-23 GMT+08:00

View PDF

PG_SHDESCRIPTION

PG_SHDESCRIPTION records optional comments for shared database objects. Descriptions can be manipulated with the COMMENT command and viewed with psql's \d commands.

See also PG_DESCRIPTION, which provides a similar function for descriptions involving objects within a single database.

Unlike most system catalogs, PG_SHDESCRIPTION is shared across all databases of a cluster. There is only one copy of PG_SHDESCRIPTION per cluster, not one per database.

**Table 1** PG_SHDESCRIPTION columns
Name	Type	Reference	Description
objoid	oid	Any OID column	OID of the object that this description pertains to
classoid	oid	PG_CLASS.oid	OID of the system catalog where the object appears
description	text	-	Arbitrary text that serves as the description of the object

Parent topic: System Catalogs

Previous topic: PG_SHDEPEND

Next topic: PG_SHSECLABEL

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.