Help Center/ GaussDB/ Developer Guide(Distributed_8.x)/ System Catalogs and System Views/ System Catalogs/ Other System Catalogs/ PG_DESCRIPTION

Updated on 2024-06-03 GMT+08:00

View PDF

PG_DESCRIPTION

PG_DESCRIPTION records optional descriptions (comments) for each database object. Descriptions of many built-in system objects are provided in the initial contents of PG_DESCRIPTION.

See also PG_SHDESCRIPTION, which provides a similar function for descriptions involving objects that are shared across a database cluster.

**Table 1** PG_DESCRIPTION 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
objsubid	integer	-	Column number for a comment on a table column (objoid and classoid refer to the table itself); 0 for all other object types
description	text	-	Arbitrary text that serves as the description of the object

Parent topic: Other System Catalogs

Previous topic: PG_DEPEND

Next topic: PG_DIRECTORY

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.