Skip to content

Commit

Permalink
Merge pull request #6056 from EnterpriseDB/DOCS-338-rework-clarify-us…
Browse files Browse the repository at this point in the history
…age-of-bdr-drop_node-

Rework bdr.drop_node
  • Loading branch information
djw-m authored Sep 23, 2024
2 parents 3777cc6 + 6d6a424 commit 214c55d
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions product_docs/docs/pgd/5/reference/functions-internal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,19 +156,27 @@ bdr.difference_fix_xact_set_avoid_conflict()

### `bdr.drop_node`

Drops a node.

!!! Warning
This function isn't intended for regular use. Execute it only
if instructed by Technical Support.
Drops a node's metadata.

This function removes the metadata for a given node from the local
database. The node can be either:

- The local node, in which case all the node metadata is removed,
including information about remote nodes.
- A remote node, in which case only metadata for that specific
node is removed.
- The local node, in which case it removes all the node metadata, including information about remote nodes.
- A remote node, in which case it only removes metadata for that specific node.



!!! Important When to use `bdr.drop_node()`
Do not use `bdr.drop_node()` to drop node metadata and reuse node names. PGD can reuse existing node names providing the node name belongs to a node in a `PARTED` state. Use `bdr.part_node()` to remove the original node and place it in a `PARTED` state.

Use of this internal function is limited to:

* when you are instructed to by EDB Technical Support, or
* where you are specifically instructed in the documentation to use `bdr.drop_node`.

You should use [`bdr.part_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpart_node) to remove a node from a PGD group. That function sets the node to `PARTED` state and enable reuse of the node name.

!!!

#### Synopsis

Expand Down

1 comment on commit 214c55d

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.