Help Center/ GaussDB/ Developer Guide(Centralized_V2.0-2.x)/ System Catalogs and System Views/ System Catalogs/ PG_SHDESCRIPTION

Updated on 2025-08-19 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 the \d command.

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

PG_SHDESCRIPTION is shared among all databases of a database instance. That is, there is only one PG_SHDESCRIPTION for each instance, not for each database.

**Table 1** PG_SHDESCRIPTION columns
Name	Type	Reference	Description
objoid	oid	Any OID column	OID of the described object.
classoid	oid	oid in PG_CLASS	OID of the system catalog where the object appears.
description	text	-	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.

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