Module cartridge.lua-api.topology¶
Administration functions (topology related).
Functions¶
get_servers ([uuid])¶
Get servers list. Optionally filter out the server with the given uuid.
Parameters:
uuid: (string) (optional)
Returns:
({ServerInfo,…})
Or
(nil)
(table) Error description
get_replicasets ([uuid])¶
Get replicasets list. Optionally filter out the replicaset with given uuid.
Parameters:
uuid: (string) (optional)
Returns:
({ReplicasetInfo,…})
Or
(nil)
(table) Error description
enable_servers (uuids)¶
Enable nodes after they were disabled.
Parameters:
uuids: ({string,…})
Returns:
({ServerInfo,…})
Or
(nil)
(table) Error description
disable_servers (uuids)¶
Temporarily disable nodes.
Parameters:
uuids: ({string,…})
Returns:
({ServerInfo,…})
Or
(nil)
(table) Error description
restart_replication (…)¶
Restart replication on specified instances.
(added in v2.6.0-43)
Parameters:
…: ({string,) } uuids
Returns:
(boolean) true
Or
(nil)
(table) Error description
set_electable_servers (uuids)¶
Make nodes electable after they were set unelectable.
Parameters:
uuids: ({string,…})
Returns:
({ServerInfo,…})
Or
(nil)
(table) Error description
set_unelectable_servers (uuids)¶
Temporarily make nodes unelectable as leaders.
Parameters:
uuids: ({string,…})
Returns:
({ServerInfo,…})
Or
(nil)
(table) Error description