Module cartridge.lua-api.topology

Administration functions (topology related).

Functions

get_servers ([uuid]) Get servers list.
get_replicasets ([uuid]) Get replicasets list.
probe_server (uri) Discover an instance.
enable_servers (uuids) Enable nodes after they were disabled.
disable_servers (uuids) Temporarily diable nodes.

Local Functions

get_self () Get alias, uri and uuid of current instance.


Functions

get_servers ([uuid])
Get servers list. Optionally filter out the server with the given uuid.

Parameters:

Returns:

    {ServerInfo,...}

Or

  1. nil
  2. table Error description
get_replicasets ([uuid])
Get replicasets list. Optionally filter out the replicaset with given uuid.

Parameters:

Returns:

    {ReplicasetInfo,...}

Or

  1. nil
  2. table Error description
probe_server (uri)
Discover an instance.

Parameters:

enable_servers (uuids)
Enable nodes after they were disabled.

Parameters:

Returns:

    {ServerInfo,...}

Or

  1. nil
  2. table Error description
disable_servers (uuids)
Temporarily diable nodes.

Parameters:

Returns:

    {ServerInfo,...}

Or

  1. nil
  2. table Error description

Local Functions

get_self ()
Get alias, uri and uuid of current instance.

Returns:

    table
generated by LDoc 1.4.6 Last updated 2020-04-24 16:23:15