com.scalar.db.api

Interface DistributedTransactionAdmin

All Superinterfaces:

Admin, AuthAdmin, java.lang.AutoCloseable

All Known Implementing Classes:

ConsensusCommitAdmin, DecoratedDistributedTransactionAdmin, JdbcTransactionAdmin, SingleCrudOperationTransactionAdmin

public interface DistributedTransactionAdmin
extends Admin, AuthAdmin, java.lang.AutoCloseable

An administrative interface for distributed transaction implementations. The user can execute administrative operations with it like createNamespace/createTable/getTableMetadata.

Nested Class Summary

Nested classes/interfaces inherited from interface com.scalar.db.api.AuthAdmin

AuthAdmin.Privilege, AuthAdmin.User, AuthAdmin.UserOption

Method Summary

Modifier and Type	Method and Description
void	close() Closes connections to the storage.
boolean	coordinatorTablesExist() Returns true if all the coordinator tables exist.
default void	createCoordinatorTables() Creates coordinator namespace and tables.
default void	createCoordinatorTables(boolean ifNotExist) Creates coordinator namespace and tables.
default void	createCoordinatorTables(boolean ifNotExist, java.util.Map<java.lang.String,java.lang.String> options) Creates coordinator namespace and tables.
void	createCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options) Creates coordinator namespace and tables.
void	dropCoordinatorTables() Drops coordinator namespace and tables.
default void	dropCoordinatorTables(boolean ifExist) Drops coordinator namespace and tables.
void	repairCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options) Repairs coordinator tables which may be in an unknown state.
void	truncateCoordinatorTables() Truncates coordinator tables.

Methods inherited from interface com.scalar.db.api.Admin

addNewColumnToTable, addNewColumnToTable, createIndex, createIndex, createIndex, createIndex, createNamespace, createNamespace, createNamespace, createNamespace, createTable, createTable, createTable, createTable, dropIndex, dropIndex, dropNamespace, dropNamespace, dropTable, dropTable, getNamespaceNames, getNamespaceTableNames, getTableMetadata, importTable, indexExists, namespaceExists, repairTable, tableExists, truncateTable

Methods inherited from interface com.scalar.db.api.AuthAdmin

alterUser, createUser, dropUser, getCurrentUser, getPrivileges, getPrivileges, getUser, getUsers, grant, grant, revoke, revoke

Method Detail

createCoordinatorTables

void createCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
                      throws ExecutionException

Creates coordinator namespace and tables.

Parameters:

options - options to create namespace and tables

Throws:

java.lang.IllegalArgumentException - if the coordinator namespace already exists or the coordinator tables already exist

ExecutionException - if the operation fails

createCoordinatorTables

default void createCoordinatorTables(boolean ifNotExist,
                                     java.util.Map<java.lang.String,java.lang.String> options)
                              throws ExecutionException

Creates coordinator namespace and tables.

Parameters:

ifNotExist - if set to true, the coordinator namespace and tables will be created only if they do not exist. If set to false, it will throw an exception if they already exist

options - options to create namespace and tables

Throws:

java.lang.IllegalArgumentException - if the coordinator namespace already exists or the coordinator tables already exist if ifNotExist is set to false

ExecutionException - if the operation fails

createCoordinatorTables

default void createCoordinatorTables(boolean ifNotExist)
                              throws ExecutionException

Creates coordinator namespace and tables.

Parameters:

ifNotExist - if set to true, the coordinator namespace and tables will be created only if they do not exist. If set to false, it will throw an exception if they already exist

Throws:

java.lang.IllegalArgumentException - if the coordinator namespace already exists or the coordinator tables already exist if ifNotExist is set to false

ExecutionException - if the operation fails

createCoordinatorTables

default void createCoordinatorTables()
                              throws ExecutionException

Creates coordinator namespace and tables.

Throws:

java.lang.IllegalArgumentException - if the coordinator namespace already exists or the coordinator tables already exist if ifNotExist is set to false

ExecutionException - if the operation fails

dropCoordinatorTables

void dropCoordinatorTables()
                    throws ExecutionException

Drops coordinator namespace and tables.

Throws:

java.lang.IllegalArgumentException - if the coordinator tables do not exist

ExecutionException - if the operation fails

dropCoordinatorTables

default void dropCoordinatorTables(boolean ifExist)
                            throws ExecutionException

Drops coordinator namespace and tables.

Parameters:

ifExist - if set to true, the coordinator namespace and tables will be dropped only if they exist. If set to false, it will throw an exception if they do not exist

Throws:

java.lang.IllegalArgumentException - if the coordinator tables do not exist if ifExist is set to false

ExecutionException - if the operation fails

truncateCoordinatorTables

void truncateCoordinatorTables()
                        throws ExecutionException

Truncates coordinator tables.

Throws:

java.lang.IllegalArgumentException - if the coordinator tables do not exist

ExecutionException - if the operation fails

coordinatorTablesExist

boolean coordinatorTablesExist()
                        throws ExecutionException

Returns true if all the coordinator tables exist.

Returns:

true if all the coordinator tables exist, false otherwise

Throws:

ExecutionException - if the operation fails

repairCoordinatorTables

void repairCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
                      throws ExecutionException

Repairs coordinator tables which may be in an unknown state.

Parameters:

options - options to repair

Throws:

java.lang.IllegalArgumentException - if the coordinator tables do not exist

ExecutionException - if the operation fails

close

void close()

Closes connections to the storage.

Specified by:

close in interface java.lang.AutoCloseable