Module cartridge.lua-api.deprecated¶
Administration functions (deprecated).
Deprecated functions¶
join_server (args)¶
Join an instance to the cluster (deprecated).
(Deprecated since v1.0.0-17 in favor of cartridge.admin_edit_topology)
Parameters:
args:
uri: (string)
instance_uuid: (optional string)
replicaset_uuid: (optional string)
roles: (optional {string,…})
timeout: (optional number)
labels: (optional {[string]=string,…})
vshard_group: (optional string)
replicaset_alias: (optional string)
replicaset_weight: (optional number)
Returns:
(boolean) true
Or
(nil)
(table) Error description
edit_server (args)¶
Edit an instance (deprecated).
(Deprecated since v1.0.0-17 in favor of cartridge.admin_edit_topology)
Parameters:
args:
uuid: (string)
uri: (optional string)
labels: (optional {[string]=string,…})
Returns:
(boolean) true
Or
(nil)
(table) Error description
expel_server (uuid)¶
Expel an instance (deprecated). Forever.
(Deprecated since v1.0.0-17 in favor of cartridge.admin_edit_topology)
Parameters:
uuid: (string)
Returns:
(boolean) true
Or
(nil)
(table) Error description
edit_replicaset (args)¶
Edit replicaset parameters (deprecated).
(Deprecated since v1.0.0-17 in favor of cartridge.admin_edit_topology)
Parameters:
args:
uuid: (string)
alias: (string)
roles: (optional {string,…})
master: (optional {string,…}) Failover order
weight: (optional number)
vshard_group: (optional string)
all_rw: (optional boolean)
Returns:
(boolean) true
Or
(nil)
(table) Error description