Skip to content

Commit 0db051e

Browse files
authored
Merge pull request #6018 from EnterpriseDB/docs/pgd/fix/bdrdropnodegroup-reference
Add basic bdr.drop_node_group reference
2 parents 1b4e862 + 595f273 commit 0db051e

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

product_docs/docs/pgd/5/reference/index.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@
186186
"bdrswitch_node_group": "/pgd/latest/reference/nodes-management-interfaces#bdrswitch_node_group",
187187
"bdrwait_for_join_completion": "/pgd/latest/reference/nodes-management-interfaces#bdrwait_for_join_completion",
188188
"bdralter_node_group_config": "/pgd/latest/reference/nodes-management-interfaces#bdralter_node_group_config",
189+
"bdrdrop_node_group": "/pgd/latest/reference/nodes-management-interfaces#bdrdrop_node_group",
189190
"bdrcreate_proxy": "/pgd/latest/reference/routing#bdrcreate_proxy",
190191
"bdralter_proxy_option": "/pgd/latest/reference/routing#bdralter_proxy_option",
191192
"bdrdrop_proxy": "/pgd/latest/reference/routing#bdrdrop_proxy",

product_docs/docs/pgd/5/reference/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ The reference section is a definitive listing of all functions, views, and comma
262262
* [`bdr.switch_node_group`](nodes-management-interfaces#bdrswitch_node_group)
263263
* [`bdr.wait_for_join_completion`](nodes-management-interfaces#bdrwait_for_join_completion)
264264
* [`bdr.alter_node_group_config`](nodes-management-interfaces#bdralter_node_group_config)
265+
* [`bdr.drop_node_group`](nodes-management-interfaces#bdrdrop_node_group)
265266

266267

267268
## [Routing functions](routing)

product_docs/docs/pgd/5/reference/nodes-management-interfaces.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,3 +535,23 @@ so you can't roll back the function call. Also, the changes might not be
535535
immediately visible to the current transaction.
536536

537537
This function doesn't hold any locks.
538+
539+
## `bdr.drop_node_group`
540+
541+
This function drops an empty PGD node group. If there are any joined nodes in the group, the function will fail.
542+
543+
### Synopsis
544+
545+
```sql
546+
bdr.drop_node_group(node_group_name text)
547+
```
548+
549+
### Parameters
550+
551+
- `node_group_name` — Name of the PGD group to drop.
552+
553+
554+
### Notes
555+
556+
- This function passes a request to the group consensus mechanism to drop the group.
557+
- The function isn't transactional. The dropping process happens in the background, and you can't roll it back.

0 commit comments

Comments
 (0)