Skip to content

Commit 15e0dfd

Browse files
committed
Change default mtree schema from "spock" to "pgedge_ace"
Update ace.yaml, default_config.yaml, configuration docs, and visualise.sh. Add -S flag to visualise.sh for schema override. CHANGELOG documents the breaking change and migration path.
1 parent d4f4bfe commit 15e0dfd

5 files changed

Lines changed: 17 additions & 7 deletions

File tree

ace.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ mtree:
3636
publication_name: "ace_mtree_pub"
3737
cdc_processing_timeout: 30
3838
cdc_metadata_flush_seconds: 10
39-
schema: "spock"
39+
schema: "pgedge_ace"
4040

4141
diff:
4242
min_block_size: 1000

docs/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ All notable changes to ACE will be captured in this document. This project follo
1818
(unidirectional, bidirectional, fix-nulls, dry-run), Merkle tree operations,
1919
and origin-tracked replication with repair.
2020

21+
### ⚠️ Breaking Change
22+
- **Default `mtree.schema` changed from `"spock"` to `"pgedge_ace"`.** If you have
23+
been using Merkle tree operations (`mtree build`, `mtree diff`, continuous CDC)
24+
in prior versions, your existing metadata tables live in the `spock` schema. To
25+
preserve compatibility, set `schema: "spock"` in the following locations:
26+
- `ace.yaml``mtree.schema`
27+
- `visualise.sh``-S spock` flag (or edit the default in the script)
28+
2129
### Changed
2230
- ACE schema name in SQL templates is now quoted with `pgx.Identifier.Sanitize()`
2331
to prevent SQL breakage with non-simple schema names (e.g., mixed case,

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The [`ace.yaml` file](https://github.com/pgEdge/ace/blob/main/ace.yaml) defines
3737
| mtree → cdc --> publication_name | Publication used for mtree CDC. **Default: "ace_mtree_pub"** |
3838
| mtree → cdc --> cdc_processing_timeout | CDC processing timeout (s). **Default: 30** |
3939
| mtree → cdc --> cdc_metadata_flush_seconds | How often (s) CDC metadata is flushed to disk. **Default: 10** |
40-
| mtree --> schema | Schema used for mtree metadata/objects. **Default: "spock"** |
40+
| mtree --> schema | Schema used for mtree metadata/objects. **Default: "pgedge_ace"** |
4141
| mtree → diff --> min_block_size | Minimum Merkle diff block size. **Default: 1000** |
4242
| mtree → diff --> block_size | Target Merkle diff block size. **Default: 100000** |
4343
| mtree → diff --> max_block_size | Maximum Merkle diff block size. **Default: 1000000** |

internal/cli/default_config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ mtree:
3535
publication_name: "ace_mtree_pub"
3636
cdc_processing_timeout: 30
3737
cdc_metadata_flush_seconds: 10
38-
schema: "spock"
38+
schema: "pgedge_ace"
3939

4040
diff:
4141
min_block_size: 1000

visualise.sh

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
#!/usr/bin/env bash
1313
# visualise.sh
1414
# Flags:
15+
# -S <ace_schema> (default: pgedge_ace) -> schema where ACE mtree objects live
1516
# -s <schema> (default: public)
1617
# -t <table> (required) -> full table: ace_mtree_<schema>_<table>
1718
# -H <host> (optional) -> psql -h
@@ -21,20 +22,21 @@
2122
# -v vertical
2223
#
2324
# Uses PG* env for user and db Example:
24-
# PGUSER=admin PGDATABASE=demo ./visualise.sh -s public -t customers_small -H localhost -v
25+
# PGUSER=admin PGDATABASE=demo ./visualise.sh -s public -t customers_small -H localhost -v [-S pgedge_ace]
2526

2627
set -euo pipefail
2728

28-
ace_schema="spock"
29+
ace_schema="pgedge_ace"
2930
table_schema="public"
3031
table=""
3132
host=""
3233
user="${PGUSER:-admin}"
3334
dbname="${PGDATABASE:-demo}"
3435
orientation="vertical" # default
3536

36-
while getopts ":s:t:H:U:d:hv" opt; do
37+
while getopts ":S:s:t:H:U:d:hv" opt; do
3738
case "$opt" in
39+
S) ace_schema="$OPTARG" ;;
3840
s) table_schema="$OPTARG" ;;
3941
t) table="$OPTARG" ;;
4042
H) host="$OPTARG" ;;
@@ -48,7 +50,7 @@ while getopts ":s:t:H:U:d:hv" opt; do
4850
done
4951

5052
if [[ -z "$table" ]]; then
51-
echo "Usage: $0 -t <table> [-s <schema=public>] [-H <host>] [-U <user>] [-d <dbname>] [-h|-v]" >&2
53+
echo "Usage: $0 -t <table> [-s <schema=public>] [-S <ace_schema=pgedge_ace>] [-H <host>] [-U <user>] [-d <dbname>] [-h|-v]" >&2
5254
exit 2
5355
fi
5456

0 commit comments

Comments
 (0)