Skip to content

Commit c3b93ea

Browse files
author
Ibrar Ahmed
committed
Docs: clarify auto_ddl behaviour during ZODAN node addition.
1 parent b8b1443 commit c3b93ea

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

docs/modify/zodan/zodan_readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,18 @@ After adding the new node, you can use health checks on your cluster to ensure t
3636
- Python 3
3737
- Passwordless access or a properly configured `.pgpass` file for remote connections
3838

39+
!!! Warning "DDL and auto_ddl during node addition"
40+
41+
**Recommended:** Disable `auto_ddl` (`spock.enable_ddl_replication = off`) on
42+
all cluster nodes before running ZODAN and re-enable it after the new node is
43+
fully subscribed.
44+
45+
ZODAN can run with `auto_ddl` enabled, but you must avoid any DDL activity
46+
during the operation. Do not run burst DDL (many statements in rapid
47+
succession), heavy schema migrations, or DDL inside transactions while ZODAN
48+
is active. Concurrent DDL can cause replication conflicts or leave the new
49+
node with an inconsistent schema.
50+
3951
**Running a Health Check**
4052

4153
Invoke the script on the node you are validating:

docs/modify/zodan/zodan_tutorial.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ In this detailed walk through, we'll add a fourth node to a three-node cluster w
77
**Important Prerequisites and Warnings**
88

99
- The new node should not be accessible to users while adding the node.
10-
- Disable `auto_ddl` on all cluster nodes.
10+
- **Recommended:** Disable `auto_ddl` (`spock.enable_ddl_replication = off`)
11+
on all cluster nodes before adding a new node and re-enable it after the
12+
process completes. This is the safest approach.
13+
- If you must leave `auto_ddl` enabled, exercise caution: avoid any DDL
14+
changes during the node addition window. In particular, do not run burst
15+
DDL (many statements in rapid succession), heavy schema migrations, or
16+
DDL inside transactions while ZODAN is running. Concurrent DDL with an
17+
active ZODAN operation can cause replication conflicts or an inconsistent
18+
schema on the new node.
1119
- Do not modify your DDL during node addition.
1220
- The users must be identical on the source and target node. You must create any users on the target node before proceeding; the permissions must be *identical* for all users on both the source and target nodes.
1321

0 commit comments

Comments
 (0)