com.scalar.db.cluster.client

Class ClusterClientTransactionAdmin

java.lang.Object

com.scalar.db.cluster.client.ClusterClientTransactionAdmin

All Implemented Interfaces:

com.scalar.db.api.Admin, com.scalar.db.api.AuthAdmin, com.scalar.db.api.DistributedTransactionAdmin

@ThreadSafe
public class ClusterClientTransactionAdmin
extends java.lang.Object
implements com.scalar.db.api.DistributedTransactionAdmin

An implementation of DistributedTransactionAdmin for ScalarDB Cluster.

It uses ClusterRequestRouter with round-robin routing because any cluster node can execute the administrative operations.

Nested Class Summary

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

com.scalar.db.api.AuthAdmin.Privilege, com.scalar.db.api.AuthAdmin.User, com.scalar.db.api.AuthAdmin.UserOption

Constructor Summary

Constructors

Constructor and Description
ClusterClientTransactionAdmin(com.scalar.db.config.DatabaseConfig databaseConfig)

Method Summary

Modifier and Type	Method and Description
void	addNewColumnToTable(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName, com.scalar.db.io.DataType columnType)
void	alterUser(java.lang.String username, java.lang.String password, com.scalar.db.api.AuthAdmin.UserOption... userOptions)
void	close()
boolean	coordinatorTablesExist()
void	createCoordinatorTables()
void	createCoordinatorTables(boolean ifNotExist)
void	createCoordinatorTables(boolean ifNotExist, java.util.Map<java.lang.String,java.lang.String> options)
void	createCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
void	createIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName)
void	createIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName, boolean ifNotExists)
void	createIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName, boolean ifNotExists, java.util.Map<java.lang.String,java.lang.String> options)
void	createIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName, java.util.Map<java.lang.String,java.lang.String> options)
void	createNamespace(java.lang.String namespaceName)
void	createNamespace(java.lang.String namespaceName, boolean ifNotExists)
void	createNamespace(java.lang.String namespaceName, boolean ifNotExists, java.util.Map<java.lang.String,java.lang.String> options)
void	createNamespace(java.lang.String namespaceName, java.util.Map<java.lang.String,java.lang.String> options)
void	createTable(java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.TableMetadata tableMetadata)
void	createTable(java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.TableMetadata tableMetadata, boolean ifNotExists)
void	createTable(java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.TableMetadata tableMetadata, boolean ifNotExists, java.util.Map<java.lang.String,java.lang.String> options)
void	createTable(java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.TableMetadata tableMetadata, java.util.Map<java.lang.String,java.lang.String> options)
void	createUser(java.lang.String username, java.lang.String password, com.scalar.db.api.AuthAdmin.UserOption... userOptions)
void	dropCoordinatorTables()
void	dropCoordinatorTables(boolean ifExist)
void	dropIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName)
void	dropIndex(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName, boolean ifExists)
void	dropNamespace(java.lang.String namespaceName)
void	dropNamespace(java.lang.String namespaceName, boolean ifExists)
void	dropTable(java.lang.String namespaceName, java.lang.String tableName)
void	dropTable(java.lang.String namespaceName, java.lang.String tableName, boolean ifExists)
void	dropUser(java.lang.String username)
java.util.Set<java.lang.String>	getNamespaceTableNames(java.lang.String namespaceName)
java.util.Set<com.scalar.db.api.AuthAdmin.Privilege>	getPrivileges(java.lang.String username, java.lang.String namespaceName)
java.util.Set<com.scalar.db.api.AuthAdmin.Privilege>	getPrivileges(java.lang.String username, java.lang.String namespaceName, java.lang.String tableName)
com.scalar.db.api.TableMetadata	getTableMetadata(java.lang.String namespaceName, java.lang.String tableName)
java.util.Optional<com.scalar.db.api.AuthAdmin.User>	getUser(java.lang.String username)
java.util.List<com.scalar.db.api.AuthAdmin.User>	getUsers()
void	grant(java.lang.String username, java.lang.String namespaceName, com.scalar.db.api.AuthAdmin.Privilege... privileges)
void	grant(java.lang.String username, java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.AuthAdmin.Privilege... privileges)
void	importTable(java.lang.String namespace, java.lang.String table, java.util.Map<java.lang.String,java.lang.String> options)
boolean	indexExists(java.lang.String namespaceName, java.lang.String tableName, java.lang.String columnName)
boolean	namespaceExists(java.lang.String namespaceName)
void	repairCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
void	repairTable(java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.TableMetadata tableMetadata, java.util.Map<java.lang.String,java.lang.String> options)
void	revoke(java.lang.String username, java.lang.String namespaceName, com.scalar.db.api.AuthAdmin.Privilege... privileges)
void	revoke(java.lang.String username, java.lang.String namespaceName, java.lang.String tableName, com.scalar.db.api.AuthAdmin.Privilege... privileges)
boolean	tableExists(java.lang.String namespaceName, java.lang.String tableName)
void	truncateCoordinatorTables()
void	truncateTable(java.lang.String namespaceName, java.lang.String tableName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClusterClientTransactionAdmin

public ClusterClientTransactionAdmin(com.scalar.db.config.DatabaseConfig databaseConfig)

Method Detail

createNamespace

public void createNamespace(java.lang.String namespaceName)
                     throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createNamespace

public void createNamespace(java.lang.String namespaceName,
                            boolean ifNotExists)
                     throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createNamespace

public void createNamespace(java.lang.String namespaceName,
                            java.util.Map<java.lang.String,java.lang.String> options)
                     throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createNamespace

public void createNamespace(java.lang.String namespaceName,
                            boolean ifNotExists,
                            java.util.Map<java.lang.String,java.lang.String> options)
                     throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createTable

public void createTable(java.lang.String namespaceName,
                        java.lang.String tableName,
                        com.scalar.db.api.TableMetadata tableMetadata)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createTable

public void createTable(java.lang.String namespaceName,
                        java.lang.String tableName,
                        com.scalar.db.api.TableMetadata tableMetadata,
                        boolean ifNotExists)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createTable

public void createTable(java.lang.String namespaceName,
                        java.lang.String tableName,
                        com.scalar.db.api.TableMetadata tableMetadata,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createTable

public void createTable(java.lang.String namespaceName,
                        java.lang.String tableName,
                        com.scalar.db.api.TableMetadata tableMetadata,
                        boolean ifNotExists,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropTable

public void dropTable(java.lang.String namespaceName,
                      java.lang.String tableName)
               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropTable

public void dropTable(java.lang.String namespaceName,
                      java.lang.String tableName,
                      boolean ifExists)
               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropNamespace

public void dropNamespace(java.lang.String namespaceName)
                   throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropNamespace

public void dropNamespace(java.lang.String namespaceName,
                          boolean ifExists)
                   throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropNamespace in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

truncateTable

public void truncateTable(java.lang.String namespaceName,
                          java.lang.String tableName)
                   throws com.scalar.db.exception.storage.ExecutionException

Specified by:

truncateTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createIndex

public void createIndex(java.lang.String namespaceName,
                        java.lang.String tableName,
                        java.lang.String columnName)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createIndex

public void createIndex(java.lang.String namespaceName,
                        java.lang.String tableName,
                        java.lang.String columnName,
                        boolean ifNotExists)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createIndex

public void createIndex(java.lang.String namespaceName,
                        java.lang.String tableName,
                        java.lang.String columnName,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createIndex

public void createIndex(java.lang.String namespaceName,
                        java.lang.String tableName,
                        java.lang.String columnName,
                        boolean ifNotExists,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropIndex

public void dropIndex(java.lang.String namespaceName,
                      java.lang.String tableName,
                      java.lang.String columnName)
               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropIndex

public void dropIndex(java.lang.String namespaceName,
                      java.lang.String tableName,
                      java.lang.String columnName,
                      boolean ifExists)
               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropIndex in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

getTableMetadata

@Nullable
public com.scalar.db.api.TableMetadata getTableMetadata(java.lang.String namespaceName,
                                                                  java.lang.String tableName)
                                                           throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getTableMetadata in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

getNamespaceTableNames

public java.util.Set<java.lang.String> getNamespaceTableNames(java.lang.String namespaceName)
                                                       throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getNamespaceTableNames in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

namespaceExists

public boolean namespaceExists(java.lang.String namespaceName)
                        throws com.scalar.db.exception.storage.ExecutionException

Specified by:

namespaceExists in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

tableExists

public boolean tableExists(java.lang.String namespaceName,
                           java.lang.String tableName)
                    throws com.scalar.db.exception.storage.ExecutionException

Specified by:

tableExists in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

indexExists

public boolean indexExists(java.lang.String namespaceName,
                           java.lang.String tableName,
                           java.lang.String columnName)
                    throws com.scalar.db.exception.storage.ExecutionException

Specified by:

indexExists in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

repairTable

public void repairTable(java.lang.String namespaceName,
                        java.lang.String tableName,
                        com.scalar.db.api.TableMetadata tableMetadata,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

repairTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

addNewColumnToTable

public void addNewColumnToTable(java.lang.String namespaceName,
                                java.lang.String tableName,
                                java.lang.String columnName,
                                com.scalar.db.io.DataType columnType)
                         throws com.scalar.db.exception.storage.ExecutionException

Specified by:

addNewColumnToTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createCoordinatorTables

public void createCoordinatorTables()
                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

createCoordinatorTables

public void createCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

createCoordinatorTables

public void createCoordinatorTables(boolean ifNotExist)
                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

createCoordinatorTables

public void createCoordinatorTables(boolean ifNotExist,
                                    java.util.Map<java.lang.String,java.lang.String> options)
                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropCoordinatorTables

public void dropCoordinatorTables()
                           throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropCoordinatorTables

public void dropCoordinatorTables(boolean ifExist)
                           throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

truncateCoordinatorTables

public void truncateCoordinatorTables()
                               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

truncateCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

coordinatorTablesExist

public boolean coordinatorTablesExist()
                               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

coordinatorTablesExist in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

repairCoordinatorTables

public void repairCoordinatorTables(java.util.Map<java.lang.String,java.lang.String> options)
                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

repairCoordinatorTables in interface com.scalar.db.api.DistributedTransactionAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

importTable

public void importTable(java.lang.String namespace,
                        java.lang.String table,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws com.scalar.db.exception.storage.ExecutionException

Specified by:

importTable in interface com.scalar.db.api.Admin

Throws:

com.scalar.db.exception.storage.ExecutionException

createUser

public void createUser(java.lang.String username,
                       @Nullable
                       java.lang.String password,
                       com.scalar.db.api.AuthAdmin.UserOption... userOptions)
                throws com.scalar.db.exception.storage.ExecutionException

Specified by:

createUser in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

alterUser

public void alterUser(java.lang.String username,
                      @Nullable
                      java.lang.String password,
                      com.scalar.db.api.AuthAdmin.UserOption... userOptions)
               throws com.scalar.db.exception.storage.ExecutionException

Specified by:

alterUser in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

dropUser

public void dropUser(java.lang.String username)
              throws com.scalar.db.exception.storage.ExecutionException

Specified by:

dropUser in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

grant

public void grant(java.lang.String username,
                  java.lang.String namespaceName,
                  com.scalar.db.api.AuthAdmin.Privilege... privileges)
           throws com.scalar.db.exception.storage.ExecutionException

Specified by:

grant in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

grant

public void grant(java.lang.String username,
                  java.lang.String namespaceName,
                  java.lang.String tableName,
                  com.scalar.db.api.AuthAdmin.Privilege... privileges)
           throws com.scalar.db.exception.storage.ExecutionException

Specified by:

grant in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

revoke

public void revoke(java.lang.String username,
                   java.lang.String namespaceName,
                   com.scalar.db.api.AuthAdmin.Privilege... privileges)
            throws com.scalar.db.exception.storage.ExecutionException

Specified by:

revoke in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

revoke

public void revoke(java.lang.String username,
                   java.lang.String namespaceName,
                   java.lang.String tableName,
                   com.scalar.db.api.AuthAdmin.Privilege... privileges)
            throws com.scalar.db.exception.storage.ExecutionException

Specified by:

revoke in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

getUser

public java.util.Optional<com.scalar.db.api.AuthAdmin.User> getUser(java.lang.String username)
                                                             throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getUser in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

getUsers

public java.util.List<com.scalar.db.api.AuthAdmin.User> getUsers()
                                                          throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getUsers in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

getPrivileges

public java.util.Set<com.scalar.db.api.AuthAdmin.Privilege> getPrivileges(java.lang.String username,
                                                                          java.lang.String namespaceName)
                                                                   throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getPrivileges in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

getPrivileges

public java.util.Set<com.scalar.db.api.AuthAdmin.Privilege> getPrivileges(java.lang.String username,
                                                                          java.lang.String namespaceName,
                                                                          java.lang.String tableName)
                                                                   throws com.scalar.db.exception.storage.ExecutionException

Specified by:

getPrivileges in interface com.scalar.db.api.AuthAdmin

Throws:

com.scalar.db.exception.storage.ExecutionException

close

public void close()

Specified by:

close in interface com.scalar.db.api.DistributedTransactionAdmin