Skip to content

Commit 6dda93b

Browse files
Liudmila Mantrovakelvich
authored andcommitted
Added parameters descriptions for node management functions
1 parent 574beb1 commit 6dda93b

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

doc/functions.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
## Cluster information functions
44

5-
* `mtm.get_nodes_state()`show status of nodes in cluster. Returns tuple of following values:
6-
* id, integer
5+
* `mtm.get_nodes_state()`Shows the status of all nodes in the cluster.
6+
* id, integer
77
* disabled, bool
88
* disconnected, bool
99
* catchUp, bool
@@ -18,7 +18,7 @@
1818
* connStr text
1919
* connectivityMask bigint
2020

21-
* `mtm.get_cluster_state()` -- show whole cluster status
21+
* `mtm.get_cluster_state()` -- Shows the status of the whole cluster.
2222
* status, text
2323
* disabledNodeMask, bigint
2424
* disconnectedNodeMask, bigint
@@ -39,14 +39,26 @@
3939

4040
## Node management functions
4141

42-
* `mtm.add_node(conn_str text)` -- add node to the cluster.
43-
* `mtm.drop_node(node integer, drop_slot bool default false)` -- exclude node from the cluster.
44-
* `mtm.poll_node(nodeId integer, noWait boolean default FALSE)` -- wait for node to become online.
45-
* `mtm.recover_node(node integer)` -- create replication slot for the node which was previously dropped together with it's slot.
42+
* `mtm.add_node(conn_str text)` -- Adds a new node to the cluster.
43+
* `conn_str` - Connection string for the new node. For example, for the database `mydb`, user `myuser`, and the new node `node4`, the connection string is `"dbname=mydb user=myuser host=node4"`. Type: `text`
44+
45+
46+
* `mtm.drop_node(node integer, drop_slot bool default false)` -- Excludes a node from the cluster.
47+
* `node` - ID of the node to be dropped that you specified in the `multimaster.node_id` variable. Type: `integer`
48+
* `drop_slot` - Optional. Defines whether the replication slot should be dropped together with the node. Set this option to true if you do not plan to restore the node in the future. Type: `boolean` Default: `false`
49+
50+
51+
* `mtm.recover_node(node integer)` -- Creates a replication slot for the node that was previously dropped together with its slot.
52+
* `node` - ID of the node to be restored.
53+
54+
55+
* `mtm.poll_node(nodeId integer, noWait boolean default FALSE)` -- Waits for the node to become online.
56+
4657

4758
## Data management functions
4859

49-
* `mtm.make_table_local(relation regclass)` -- stop replication for a given table
60+
* `mtm.make_table_local(relation regclass)` -- Stops replication for the specified table.
61+
* `relation` - The table you would like to exclude from the replication scheme. Type: `regclass`
5062

5163
## Debug functions
5264

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy