org.onosproject.store.service

Interface DatabaseAdminService

public interface DatabaseAdminService

Service interface for running administrative tasks on a Database.

Method Summary

Modifier and Type	Method and Description
void	addMember(ControllerNode node) Add member to default Tablet.
boolean	createTable(String name) Creates a new table.
boolean	createTable(String name, int ttlMillis) Creates a new table where last update time will be used to track and expire old entries.
void	dropAllTables() Deletes all tables from the database.
void	dropTable(String name) Deletes a table from the database.
Optional<ControllerNode>	leader() Returns the current Leader of the default Tablet.
Collection<ControllerNode>	listMembers() List members forming default Tablet.
Set<String>	listTables() Lists all the tables in the database.
void	removeMember(ControllerNode node) Remove member from default Tablet.

Method Detail

createTable

boolean createTable(String name)

Creates a new table. Table creation is idempotent. Attempting to create a table that already exists will be a noop.

Parameters:

name - table name.

Returns:

true if the table was created by this call, false otherwise.

createTable

boolean createTable(String name,
                    int ttlMillis)

Creates a new table where last update time will be used to track and expire old entries. Table creation is idempotent. Attempting to create a table that already exists will be a noop.

Parameters:

name - table name.

ttlMillis - total duration in millis since last update time when entries will be expired.

Returns:

true if the table was created by this call, false otherwise.

listTables

Set<String> listTables()

Lists all the tables in the database.

Returns:

set of table names.

dropTable

void dropTable(String name)

Deletes a table from the database.

Parameters:

name - name of the table to delete.

dropAllTables

void dropAllTables()

Deletes all tables from the database.

addMember

void addMember(ControllerNode node)

Add member to default Tablet.

Parameters:

node - to add

removeMember

void removeMember(ControllerNode node)

Remove member from default Tablet.

Parameters:

node - node to remove

listMembers

Collection<ControllerNode> listMembers()

List members forming default Tablet.

Returns:

Copied collection of members forming default Tablet.

leader

Optional<ControllerNode> leader()

Returns the current Leader of the default Tablet.

Returns:

leader node