{"Entry":{"collection":"func","key":"obj-description","name":"obj_description","aliases":[],"metadata":{"changed_in":["7.4"],"changes":[{"descriptions_changed":false,"doc_overhaul":false,"from":"7.1","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"added","to":"7.2"},{"descriptions_changed":true,"doc_overhaul":false,"from":"7.3","group_changed":null,"signatures":{"added":["obj_description ( object_oid, catalog_name ) → text","obj_description ( object_oid ) → text"],"removed":["obj_description ( objectOID, tablename ) → text","obj_description ( objectOID ) → text"]},"status":"changed","to":"7.4"},{"descriptions_changed":false,"doc_overhaul":false,"from":"7.4","group_changed":{"from":"misc","to":"info"},"signatures":{"added":[],"removed":[]},"status":"changed","to":"8.0"},{"descriptions_changed":false,"doc_overhaul":true,"from":"12","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"13"}],"content_hash":"5b897cf0b221d71dcb98b4f7c5e5926978de3d1045d08929963f12ef6978cfaf","first_version":"7.2","group":"info","group_label":"System Information Functions And Operators","groups":["misc","info"],"imported_at":"2026-09-27T17:57:29.112682+08:00","last_version":"20","name":"obj_description","name_key":"obj_description","position":28032,"present_in":["7.2","7.3","7.4","8.0","8.1","8.2","8.3","8.4","9.0","9.1","9.2","9.3","9.4","9.5","9.6","10","11","12","13","14","15","16","17","18","19","20"],"signature":"obj_description ( object oid, catalog name ) → text","signature_count":2,"slug":"obj-description","source_rev":"b7bd9cda","summary":"Returns the comment for a database object specified by its OID and the name of the containing system catalog.","summary_zh":""}},"Definition":{"Collection":"func","Key":"obj-description","SourceDatabase":"center","Version":"18","SourceTable":"func","SourceKey":"obj-description","SourceRevision":"b7bd9cda","Facts":{"description":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, obj_description(123456, 'pg_class') would retrieve the comment for the table with OID 123456.","description_html":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, \u003ccode class=\"literal\"\u003eobj_description(123456, 'pg_class')\u003c/code\u003e would retrieve the comment for the table with OID 123456.","description_zh":"","description_zh_html":"","doc":{"anchor":"FUNCTIONS-INFO-COMMENT-TABLE","file":"functions-info.html","slug":"18"},"group":"info","group_label":"System Information Functions And Operators","lang":"en","layout":"table-new","pages":["functions-info.html"],"prose_only":false,"signatures":[{"description":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, obj_description(123456, 'pg_class') would retrieve the comment for the table with OID 123456.","description_html":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, \u003ccode class=\"literal\"\u003eobj_description(123456, 'pg_class')\u003c/code\u003e would retrieve the comment for the table with OID 123456.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003eobj_description\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eobject\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eoid\u003c/code\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003ecatalog\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003ename\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003etext\u003c/code\u003e","returns":"text","text":"obj_description ( object oid, catalog name ) → text","zh_from":""},{"description":"Returns the comment for a database object specified by its OID alone. This is deprecated since there is no guarantee that OIDs are unique across different system catalogs; therefore, the wrong comment might be returned.","description_html":"Returns the comment for a database object specified by its OID alone. This is \u003cspan class=\"emphasis\"\u003e\u003cem\u003edeprecated\u003c/em\u003e\u003c/span\u003e since there is no guarantee that OIDs are unique across different system catalogs; therefore, the wrong comment might be returned.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003eobj_description\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eobject\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eoid\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003etext\u003c/code\u003e","returns":"text","text":"obj_description ( object oid ) → text","zh_from":""}],"zh_from":""},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-INFO-COMMENT-TABLE","file":"functions-info.html","slug":"18"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"obj-description","SourceDatabase":"pgweb","Version":"18","Locale":"zh-Hans","Title":"obj_description","Summary":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，obj_description(123456, 'pg_class')会获取 OID 为 123456 的表的注释。","BodyHTML":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，\u003ccode\u003eobj_description(123456, \u0026#39;pg_class\u0026#39;)\u003c/code\u003e会获取 OID 为 123456 的表的注释。\u003cpre\u003eobj_description ( object oid, catalog name ) → text\u003c/pre\u003e返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，\u003ccode\u003eobj_description(123456, \u0026#39;pg_class\u0026#39;)\u003c/code\u003e会获取 OID 为 123456 的表的注释。\u003cpre\u003eobj_description ( object oid ) → text\u003c/pre\u003e返回仅由其 OID 指定的数据库对象的注释。此形式\u003cspan\u003e\u003cem\u003e已弃用\u003c/em\u003e\u003c/span\u003e，因为无法保证 OID 在不同系统目录之间唯一，因而可能返回错误的注释。","SourceRevision":"ca936764","ContentHash":"703da365bdb625abb84261ad664e4956e4ad778fd87f1cfd698b92e43d01e98c","Payload":{"description_zh":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，obj_description(123456, 'pg_class')会获取 OID 为 123456 的表的注释。","description_zh_html":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，\u003ccode class=\"literal\"\u003eobj_description(123456, 'pg_class')\u003c/code\u003e会获取 OID 为 123456 的表的注释。","signatures":[{"description_zh":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，obj_description(123456, 'pg_class')会获取 OID 为 123456 的表的注释。","description_zh_html":"返回数据库对象的注释，对象由其 OID 和所在系统目录的名称指定。例如，\u003ccode class=\"literal\"\u003eobj_description(123456, 'pg_class')\u003c/code\u003e会获取 OID 为 123456 的表的注释。","returns":"text","text":"obj_description ( object oid, catalog name ) → text","zh_from":"doc"},{"description_zh":"返回仅由其 OID 指定的数据库对象的注释。此形式已弃用，因为无法保证 OID 在不同系统目录之间唯一，因而可能返回错误的注释。","description_zh_html":"返回仅由其 OID 指定的数据库对象的注释。此形式\u003cspan class=\"emphasis\"\u003e\u003cem\u003e已弃用\u003c/em\u003e\u003c/span\u003e，因为无法保证 OID 在不同系统目录之间唯一，因而可能返回错误的注释。","returns":"text","text":"obj_description ( object oid ) → text","zh_from":"doc"}],"zh_from":"doc"}},"RequestedLocale":"zh-Hans","Fallback":false,"Versions":["10","11","12","13","14","15","16","17","18","19","20","7.2","7.3","7.4","8.0","8.1","8.2","8.3","8.4","9.0","9.1","9.2","9.3","9.4","9.5","9.6"],"Locales":["en","zh-Hans"],"Signatures":[{"Version":"18","Ordinal":0,"Hash":"2cf94b53775a906920b4d8bd26529bf69197c2589e485ae4465bd49d3ead16c9","Text":"obj_description ( object oid, catalog name ) → text","Returns":"text","Payload":{"description":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, obj_description(123456, 'pg_class') would retrieve the comment for the table with OID 123456.","description_html":"Returns the comment for a database object specified by its OID and the name of the containing system catalog. For example, \u003ccode class=\"literal\"\u003eobj_description(123456, 'pg_class')\u003c/code\u003e would retrieve the comment for the table with OID 123456.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003eobj_description\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eobject\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eoid\u003c/code\u003e, \u003cem class=\"parameter\"\u003e\u003ccode\u003ecatalog\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003ename\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003etext\u003c/code\u003e","returns":"text","text":"obj_description ( object oid, catalog name ) → text","zh_from":""}},{"Version":"18","Ordinal":1,"Hash":"923df53e251a34026e802b47984573b609d5bf057cb67a9d64f497f1bbe07a0d","Text":"obj_description ( object oid ) → text","Returns":"text","Payload":{"description":"Returns the comment for a database object specified by its OID alone. This is deprecated since there is no guarantee that OIDs are unique across different system catalogs; therefore, the wrong comment might be returned.","description_html":"Returns the comment for a database object specified by its OID alone. This is \u003cspan class=\"emphasis\"\u003e\u003cem\u003edeprecated\u003c/em\u003e\u003c/span\u003e since there is no guarantee that OIDs are unique across different system catalogs; therefore, the wrong comment might be returned.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003eobj_description\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eobject\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eoid\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003etext\u003c/code\u003e","returns":"text","text":"obj_description ( object oid ) → text","zh_from":""}}],"Spellings":null,"SQLState":null,"Evidence":null}