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:

Returns:

({ServerInfo,…})

Or

(nil)

(table) Error description

get_replicasets ([uuid])

Get replicasets list. Optionally filter out the replicaset with given uuid.

Parameters:

Returns:

({ReplicasetInfo,…})

Or

(nil)

(table) Error description

probe_server (uri)

Discover an instance.

Parameters:

enable_servers (uuids)

Enable nodes after they were disabled.

Parameters:

Returns:

({ServerInfo,…})

Or

(nil)

(table) Error description

disable_servers (uuids)

Temporarily disable nodes.

Parameters:

Returns:

({ServerInfo,…})

Or

(nil)

(table) Error description

restart_replication (…)

Restart replication on specified instances.

(added in v2.6.0-43)

Parameters:

Returns:

(boolean) true

Or

(nil)

(table) Error description

set_electable_servers (uuids)

Make nodes electable after they were set unelectable.

Parameters:

Returns:

({ServerInfo,…})

Or

(nil)

(table) Error description

set_unelectable_servers (uuids)

Temporarily make nodes unelectable as leaders.

Parameters:

Returns:

({ServerInfo,…})

Or

(nil)

(table) Error description

Local Functions

get_self ()

Get alias, uri and uuid of current instance.

Returns:

(table)