{"Entry":{"collection":"func","key":"gin-clean-pending-list","name":"gin_clean_pending_list","aliases":[],"metadata":{"changed_in":[],"changes":[{"descriptions_changed":false,"doc_overhaul":false,"from":"9.5","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"added","to":"9.6"},{"descriptions_changed":false,"doc_overhaul":true,"from":"12","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"13"},{"descriptions_changed":true,"doc_overhaul":false,"from":"13","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"14"},{"descriptions_changed":true,"doc_overhaul":false,"from":"14","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"15"},{"descriptions_changed":true,"doc_overhaul":false,"from":"16","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"17"},{"descriptions_changed":true,"doc_overhaul":false,"from":"17","group_changed":null,"signatures":{"added":[],"removed":[]},"status":"changed","to":"18"}],"content_hash":"7db89c7dc1e1f4701dad26d58b4f312a5a6ede98d112aeeb1d2fd6116d27134e","first_version":"9.6","group":"admin","group_label":"System Administration Functions","groups":["admin"],"imported_at":"2026-09-27T17:57:29.419898+08:00","last_version":"20","name":"gin_clean_pending_list","name_key":"gin_clean_pending_list","position":29004,"present_in":["9.6","10","11","12","13","14","15","16","17","18","19","20"],"signature":"gin_clean_pending_list ( index regclass ) → bigint","signature_count":1,"slug":"gin-clean-pending-list","source_rev":"b7bd9cda","summary":"Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure.","summary_zh":""}},"Definition":{"Collection":"func","Key":"gin-clean-pending-list","SourceDatabase":"center","Version":"18","SourceTable":"func","SourceKey":"gin-clean-pending-list","SourceRevision":"b7bd9cda","Facts":{"description":"Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the fastupdate option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See Section 65.4.4.1 and Section 65.4.5 for details about the pending list and fastupdate option.","description_html":"Cleans up the \u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003epending\u003c/span\u003e”\u003c/span\u003e list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See \u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" title=\"65.4.4.1. GIN Fast Update Technique\"\u003eSection 65.4.4.1\u003c/a\u003e and \u003ca href=\"/docs/18/gin.html#GIN-TIPS\" title=\"65.4.5. GIN Tips and Tricks\"\u003eSection 65.4.5\u003c/a\u003e for details about the pending list and \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option.","description_zh":"","description_zh_html":"","doc":{"anchor":"FUNCTIONS-ADMIN-INDEX-TABLE","file":"functions-admin.html","slug":"18"},"group":"admin","group_label":"System Administration Functions","lang":"en","layout":"table-new","pages":["functions-admin.html"],"prose_only":false,"signatures":[{"description":"Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the fastupdate option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See Section 65.4.4.1 and Section 65.4.5 for details about the pending list and fastupdate option.","description_html":"Cleans up the \u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003epending\u003c/span\u003e”\u003c/span\u003e list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See \u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" title=\"65.4.4.1. GIN Fast Update Technique\"\u003eSection 65.4.4.1\u003c/a\u003e and \u003ca href=\"/docs/18/gin.html#GIN-TIPS\" title=\"65.4.5. GIN Tips and Tricks\"\u003eSection 65.4.5\u003c/a\u003e for details about the pending list and \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003egin_clean_pending_list\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eindex\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eregclass\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003ebigint\u003c/code\u003e","returns":"bigint","text":"gin_clean_pending_list ( index regclass ) → bigint","zh_from":""}],"zh_from":""},"ManualEvidence":{"doc":{"anchor":"FUNCTIONS-ADMIN-INDEX-TABLE","file":"functions-admin.html","slug":"18"}},"MeasuredEvidence":{}},"Text":{"Collection":"func","Key":"gin-clean-pending-list","SourceDatabase":"pgweb","Version":"18","Locale":"zh-Hans","Title":"gin_clean_pending_list","Summary":"将指定 GIN 索引的“待处理”列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用fastupdate选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和fastupdate选项的详细信息，参见第 65.4.4.1 节和第 65.4.5 节。","BodyHTML":"将指定 GIN 索引的\u003cspan\u003e“\u003cspan\u003e待处理\u003c/span\u003e”\u003c/span\u003e列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用\u003ccode\u003efastupdate\u003c/code\u003e选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和\u003ccode\u003efastupdate\u003c/code\u003e选项的详细信息，参见\u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" rel=\"nofollow\"\u003e第 65.4.4.1 节\u003c/a\u003e和\u003ca href=\"/docs/18/gin.html#GIN-TIPS\" rel=\"nofollow\"\u003e第 65.4.5 节\u003c/a\u003e。\u003cpre\u003egin_clean_pending_list ( index regclass ) → bigint\u003c/pre\u003e将指定 GIN 索引的\u003cspan\u003e“\u003cspan\u003e待处理\u003c/span\u003e”\u003c/span\u003e列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用\u003ccode\u003efastupdate\u003c/code\u003e选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和\u003ccode\u003efastupdate\u003c/code\u003e选项的详细信息，参见\u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" rel=\"nofollow\"\u003e第 65.4.4.1 节\u003c/a\u003e和\u003ca href=\"/docs/18/gin.html#GIN-TIPS\" rel=\"nofollow\"\u003e第 65.4.5 节\u003c/a\u003e。","SourceRevision":"ca936764","ContentHash":"fbedce482eabe8720770273fba1221864d64f49448cbaed4681932a11c0a0f6b","Payload":{"description_zh":"将指定 GIN 索引的“待处理”列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用fastupdate选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和fastupdate选项的详细信息，参见第 65.4.4.1 节和第 65.4.5 节。","description_zh_html":"将指定 GIN 索引的\u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003e待处理\u003c/span\u003e”\u003c/span\u003e列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用\u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和\u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e选项的详细信息，参见\u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" title=\"65.4.4.1. GIN 快速更新技术\"\u003e第 65.4.4.1 节\u003c/a\u003e和\u003ca href=\"/docs/18/gin.html#GIN-TIPS\" title=\"65.4.5. GIN 提示和技巧\"\u003e第 65.4.5 节\u003c/a\u003e。","signatures":[{"description_zh":"将指定 GIN 索引的“待处理”列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用fastupdate选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和fastupdate选项的详细信息，参见第 65.4.4.1 节和第 65.4.5 节。","description_zh_html":"将指定 GIN 索引的\u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003e待处理\u003c/span\u003e”\u003c/span\u003e列表中的条目批量移入主 GIN 数据结构，从而清理该列表。返回从待处理列表中移除的页数。如果参数是禁用\u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e选项构建的 GIN 索引，则不会进行清理，结果为零，因为该索引没有待处理列表。有关待处理列表和\u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e选项的详细信息，参见\u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" title=\"65.4.4.1. GIN 快速更新技术\"\u003e第 65.4.4.1 节\u003c/a\u003e和\u003ca href=\"/docs/18/gin.html#GIN-TIPS\" title=\"65.4.5. GIN 提示和技巧\"\u003e第 65.4.5 节\u003c/a\u003e。","returns":"bigint","text":"gin_clean_pending_list ( index regclass ) → bigint","zh_from":"doc"}],"zh_from":"doc"}},"RequestedLocale":"zh-Hans","Fallback":false,"Versions":["10","11","12","13","14","15","16","17","18","19","20","9.6"],"Locales":["en","zh-Hans"],"Signatures":[{"Version":"18","Ordinal":0,"Hash":"eeae407a907d9992737d570b383c0d7303d926609010368aa5c66d21086403c2","Text":"gin_clean_pending_list ( index regclass ) → bigint","Returns":"bigint","Payload":{"description":"Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the fastupdate option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See Section 65.4.4.1 and Section 65.4.5 for details about the pending list and fastupdate option.","description_html":"Cleans up the \u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003epending\u003c/span\u003e”\u003c/span\u003e list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option disabled, no cleanup happens and the result is zero, because the index doesn't have a pending list. See \u003ca href=\"/docs/18/gin.html#GIN-FAST-UPDATE\" title=\"65.4.4.1. GIN Fast Update Technique\"\u003eSection 65.4.4.1\u003c/a\u003e and \u003ca href=\"/docs/18/gin.html#GIN-TIPS\" title=\"65.4.5. GIN Tips and Tricks\"\u003eSection 65.4.5\u003c/a\u003e for details about the pending list and \u003ccode class=\"literal\"\u003efastupdate\u003c/code\u003e option.","description_zh":"","description_zh_html":"","examples":[],"html":"\u003ccode class=\"function\"\u003egin_clean_pending_list\u003c/code\u003e ( \u003cem class=\"parameter\"\u003e\u003ccode\u003eindex\u003c/code\u003e\u003c/em\u003e \u003ccode class=\"type\"\u003eregclass\u003c/code\u003e ) → \u003ccode class=\"returnvalue\"\u003ebigint\u003c/code\u003e","returns":"bigint","text":"gin_clean_pending_list ( index regclass ) → bigint","zh_from":""}}],"Spellings":null,"SQLState":null,"Evidence":null}