From 5293e5cd5ab377dee0ed4eb3048a6efd069ceb28 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Thu, 12 Sep 2024 17:14:57 +0100 Subject: [PATCH 1/4] Rework bdr.drop_node Signed-off-by: Dj Walker-Morgan --- .../pgd/5/reference/functions-internal.mdx | 24 ++++++++++++------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/product_docs/docs/pgd/5/reference/functions-internal.mdx b/product_docs/docs/pgd/5/reference/functions-internal.mdx index 78d6388ef4c..dfad8066c9f 100644 --- a/product_docs/docs/pgd/5/reference/functions-internal.mdx +++ b/product_docs/docs/pgd/5/reference/functions-internal.mdx @@ -156,19 +156,25 @@ 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()` +You don't have to use `bdr.drop_node` to remove a node from a PGD group if you are reusing the node name. This is because PGD can reuse existing node names providing the node being named is in a `PARTED` state. + +Generally, you should use [`bdr.part_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpart_node) to remove a node from a PGD group (which sets the node to `PARTED` state). You should only use `bdr.drop_node` function when: + +* if you need to remove metadata of a `PARTED` node under the instruction of EDB Technical Support +* where specifically instructed in the documentation to use it. + +!!! #### Synopsis From c927cb9fc302b111accfdfc68fbee2323ac982b2 Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Fri, 20 Sep 2024 16:46:18 +0100 Subject: [PATCH 2/4] Update product_docs/docs/pgd/5/reference/functions-internal.mdx --- product_docs/docs/pgd/5/reference/functions-internal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/reference/functions-internal.mdx b/product_docs/docs/pgd/5/reference/functions-internal.mdx index dfad8066c9f..d7f349d3f44 100644 --- a/product_docs/docs/pgd/5/reference/functions-internal.mdx +++ b/product_docs/docs/pgd/5/reference/functions-internal.mdx @@ -171,7 +171,7 @@ You don't have to use `bdr.drop_node` to remove a node from a PGD group if you a Generally, you should use [`bdr.part_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpart_node) to remove a node from a PGD group (which sets the node to `PARTED` state). You should only use `bdr.drop_node` function when: -* if you need to remove metadata of a `PARTED` node under the instruction of EDB Technical Support +* you need to remove metadata of a `PARTED` node under the instruction of EDB Technical Support * where specifically instructed in the documentation to use it. !!! From 21e4e52514db96841d3de1c574c9c78bffcf352f Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan Date: Mon, 23 Sep 2024 11:03:57 +0100 Subject: [PATCH 3/4] Simplifiication pass Signed-off-by: Dj Walker-Morgan --- .../docs/pgd/5/reference/functions-internal.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/product_docs/docs/pgd/5/reference/functions-internal.mdx b/product_docs/docs/pgd/5/reference/functions-internal.mdx index d7f349d3f44..fc391a29503 100644 --- a/product_docs/docs/pgd/5/reference/functions-internal.mdx +++ b/product_docs/docs/pgd/5/reference/functions-internal.mdx @@ -167,12 +167,14 @@ database. The node can be either: !!! Important When to use `bdr.drop_node()` -You don't have to use `bdr.drop_node` to remove a node from a PGD group if you are reusing the node name. This is because PGD can reuse existing node names providing the node being named is in a `PARTED` state. +Because PGD can reuse existing node names providing the node name belongs to a node in a `PARTED` state, you should not use `bdr.drop_node` to remove the original node metadata. -Generally, you should use [`bdr.part_node`](/pgd/latest/reference/nodes-management-interfaces#bdrpart_node) to remove a node from a PGD group (which sets the node to `PARTED` state). You should only use `bdr.drop_node` function when: +Use of this internal function is limited to: -* you need to remove metadata of a `PARTED` node under the instruction of EDB Technical Support -* where specifically instructed in the documentation to use it. +* 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. !!! From 6d6a424847c68d0dc3a739ba74947f7624f0ec9d Mon Sep 17 00:00:00 2001 From: Dj Walker-Morgan <126472455+djw-m@users.noreply.github.com> Date: Mon, 23 Sep 2024 11:41:18 +0100 Subject: [PATCH 4/4] Update product_docs/docs/pgd/5/reference/functions-internal.mdx --- product_docs/docs/pgd/5/reference/functions-internal.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/pgd/5/reference/functions-internal.mdx b/product_docs/docs/pgd/5/reference/functions-internal.mdx index fc391a29503..0c74b97e916 100644 --- a/product_docs/docs/pgd/5/reference/functions-internal.mdx +++ b/product_docs/docs/pgd/5/reference/functions-internal.mdx @@ -167,7 +167,7 @@ database. The node can be either: !!! Important When to use `bdr.drop_node()` -Because PGD can reuse existing node names providing the node name belongs to a node in a `PARTED` state, you should not use `bdr.drop_node` to remove the original node metadata. +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: