spock/mkdocs.yml at main · pgEdge/spock · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
site_name: The Spock Extension

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

plugins:
  - search

theme:
  name: material
  custom_dir: docs/overrides

  logo_dark_mode: 'img/logo-dark.png'
  logo_light_mode: 'img/logo-light.png'

  features:
    - navigation.instant
    - navigation.tracking
    - navigation.prune
    - navigation.top
    - toc.follow

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  generator: false

copyright: Copyright &copy; 2023 - 2026 pgEdge, Inc
repo_url: https://github.com/pgEdge/spock

nav:
  - Introduction: index.md
  - Installing and Configuring Spock: install_spock.md
  - Creating a Two-Node Cluster: two_node_cluster.md
  - Using Advanced Configuration Options: configuring.md
  - Upgrading a Spock Installation: upgrading_spock.md
  - Conflict Types and Resolution: conflict_types.md
  - Conflict Avoidance and Delta-Apply Columns: conflicts.md
  - Spock's Management Features:
    - Managing a Spock Installation: managing/index.md
    - Replicating Partitioned Tables: managing/partition_mgmt.md
    - Filtering Data: managing/filtering.md
    - Using Spock in Read-Only Mode: managing/read_only.md
    - Using a Trigger to Manage Replication Set Membership: managing/repset_trigger.md
    - Using Snowflake Sequences: managing/snowflake.md
    - Using Lolor to Manage Large Objects: managing/lolor.md
    - Using Automatic DDL Replication: managing/spock_autoddl.md
  - Adding or Removing Nodes:
    - Modifying a Cluster: modify/index.md
    - Using Z0DAN:
      - Modifying your Cluster with Zodan: modify/zodan/index.md
      - Using Zodan Scripts and Workflows: modify/zodan/zodan_readme.md
      - Adding a Node with Zero Downtime: modify/zodan/zodan_tutorial.md
    - Adding a Node with Minimal Downtime with pgBackRest: modify/add_node_pgbackrest.md
  - Monitoring a Cluster:
    - Monitoring the Configuration and Health of a Cluster: monitoring/index.md
    - Finding Cluster Information: monitoring/spock_info.md
    - Using Lag Tracking to Evaluate your Cluster: monitoring/lag_tracking.md
    - Using a Sync Event to Monitor Node Content: monitoring/spock_sync_event.md
  - Using Spock Functions:
    - Function List: spock_functions/index.md
    - Node Mgmt Functions: spock_functions/node_mgmt.md
    - Replication Set Mgmt Functions: spock_functions/repset_mgmt.md
    - Subscription Mgmt Functions: spock_functions/sub_mgmt.md
    - Cluster Mgmt Functions: spock_functions/gen_mgmt.md
    - Function Reference:
      - spock.gen_slot_name(): spock_functions/functions/spock_gen_slot_name.md
      - spock.get_country(): spock_functions/functions/spock_get_country.md
      - spock.max_proto_version(): spock_functions/functions/spock_max_proto_version.md
      - spock.min_proto_version(): spock_functions/functions/spock_min_proto_version.md
      - spock.node_add_interface(): spock_functions/functions/spock_node_add_interface.md
      - spock.node_create(): spock_functions/functions/spock_node_create.md
      - spock.node_drop(): spock_functions/functions/spock_node_drop.md
      - spock.node_drop_interface(): spock_functions/functions/spock_node_drop_interface.md
      - spock.node_info(): spock_functions/functions/spock_node_info.md
      - spock.replicate_ddl(): spock_functions/functions/spock_replicate_ddl.md
      - spock.repset_add_seq(): spock_functions/functions/spock_repset_add_seq.md
      - spock.repset_add_table(): spock_functions/functions/spock_repset_add_table.md
      - spock.repset_add_all_seqs(): spock_functions/functions/spock_repset_add_all_seqs.md
      - spock.repset_add_all_tables(): spock_functions/functions/spock_repset_add_all_tables.md
      - spock.repset_add_partition(): spock_functions/functions/spock_repset_add_partition.md
      - spock.repset_alter(): spock_functions/functions/spock_repset_alter.md
      - spock.repset_create(): spock_functions/functions/spock_repset_create.md
      - spock.repset_drop(): spock_functions/functions/spock_repset_drop.md
      - spock.repset_remove_partition(): spock_functions/functions/spock_repset_remove_partition.md
      - spock.repset_remove_seq(): spock_functions/functions/spock_repset_remove_seq.md
      - spock.repset_remove_table(): spock_functions/functions/spock_repset_remove_table.md
      - spock.repset_show_table(): spock_functions/functions/spock_repset_show_table.md
      - spock.table_wait_for_sync(): spock_functions/functions/spock_table_wait_for_sync.md
      - spock.seq_sync(): spock_functions/functions/spock_seq_sync.md
      - spock.sub_add_repset(): spock_functions/functions/spock_sub_add_repset.md
      - spock.sub_alter_interface(): spock_functions/functions/spock_sub_alter_interface.md
      - spock.sub_alter_skiplsn(): spock_functions/functions/spock_sub_alter_skiplsn.md
      - spock.sub_create(): spock_functions/functions/spock_sub_create.md
      - spock.sub_disable(): spock_functions/functions/spock_sub_disable.md
      - spock.sub_drop(): spock_functions/functions/spock_sub_drop.md
      - spock.sub_enable(): spock_functions/functions/spock_sub_enable.md
      - spock.sub_remove_repset(): spock_functions/functions/spock_sub_remove_repset.md
      - spock.sub_resync_table(): spock_functions/functions/spock_sub_resync_table.md
      - spock.sub_show_status(): spock_functions/functions/spock_sub_show_status.md
      - spock.sub_show_table(): spock_functions/functions/spock_sub_show_table.md
      - spock.sync_event(): spock_functions/functions/spock_sync_event.md
      - spock.sub_wait_for_sync(): spock_functions/functions/spock_sub_wait_for_sync.md
      - spock.version(): spock_functions/functions/spock_version.md
      - spock.version_num(): spock_functions/functions/spock_version_num.md
      - spock.wait_slot_confirm_lsn(): spock_functions/functions/spock_wait_slot_confirm_lsn.md
  - Limitations: limitations.md
  - FAQ: FAQ.md
  - Release Notes: spock_release_notes.md
  - Internals:
    - Design: internals-doc/DESIGN.md
    - Output Plugin: internals-doc/OUTPUT.md
    - Protocol: internals-doc/protocol.txt