Merge pull request #6018 from EnterpriseDB/docs/pgd/fix/bdrdropnodegr…

…oup-reference Add basic bdr.drop_node_group reference
EnterpriseDB · Sep 4, 2024 · 0db051e · 0db051e · github-actions · Sep 4, 2024
2 parents 1b4e862 + 595f273
commit 0db051e
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/product_docs/docs/pgd/5/reference/index.json b/product_docs/docs/pgd/5/reference/index.json
@@ -186,6 +186,7 @@
   "bdrswitch_node_group": "/pgd/latest/reference/nodes-management-interfaces#bdrswitch_node_group",
   "bdrwait_for_join_completion": "/pgd/latest/reference/nodes-management-interfaces#bdrwait_for_join_completion",
   "bdralter_node_group_config": "/pgd/latest/reference/nodes-management-interfaces#bdralter_node_group_config",
+  "bdrdrop_node_group": "/pgd/latest/reference/nodes-management-interfaces#bdrdrop_node_group",
   "bdrcreate_proxy": "/pgd/latest/reference/routing#bdrcreate_proxy",
   "bdralter_proxy_option": "/pgd/latest/reference/routing#bdralter_proxy_option",
   "bdrdrop_proxy": "/pgd/latest/reference/routing#bdrdrop_proxy",

diff --git a/product_docs/docs/pgd/5/reference/index.mdx b/product_docs/docs/pgd/5/reference/index.mdx
@@ -262,6 +262,7 @@ The reference section is a definitive listing of all functions, views, and comma
  * [`bdr.switch_node_group`](nodes-management-interfaces#bdrswitch_node_group)
  * [`bdr.wait_for_join_completion`](nodes-management-interfaces#bdrwait_for_join_completion)
  * [`bdr.alter_node_group_config`](nodes-management-interfaces#bdralter_node_group_config)
+ * [`bdr.drop_node_group`](nodes-management-interfaces#bdrdrop_node_group)
 
 
 ## [Routing functions](routing)

diff --git a/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx b/product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx
@@ -535,3 +535,23 @@ so you can't roll back the function call. Also, the changes might not be
 immediately visible to the current transaction.
 
 This function doesn't hold any locks.
+
+## `bdr.drop_node_group`
+
+This function drops an empty PGD node group. If there are any joined nodes in the group, the function will fail.
+
+### Synopsis
+
+```sql
+bdr.drop_node_group(node_group_name text)
+```
+
+### Parameters
+
+-   `node_group_name` &mdash; Name of the PGD group to drop.
+
+
+### Notes
+
+- This function passes a request to the group consensus mechanism to drop the group.
+- The function isn't transactional. The dropping process happens in the background, and you can't roll it back.