com.scalar.db.api

Interface DistributedStorageAdmin

All Superinterfaces:

Admin, java.lang.AutoCloseable

All Known Implementing Classes:

AdminService, CassandraAdmin, CheckedDistributedStorageAdmin, CosmosAdmin, DynamoAdmin, JdbcAdmin, MultiStorageAdmin

public interface DistributedStorageAdmin
extends Admin, java.lang.AutoCloseable

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

Usage Examples

Here is a simple example to demonstrate how to use it. (Exception handling is omitted for readability.)

 StorageFactory factory = StorageFactory.create(configFilePath);
 DistributedStorageAdmin admin = factory.getAdmin();

 // Create a namespace
 // Assumes that the namespace name is NAMESPACE
 admin.createNamespace(NAMESPACE);

 // Create a table
 // Assumes that the namespace name and the table name are NAMESPACE and TABLE respectively
 TableMetadata tableMetadata = TableMetadata.newBuilder()
     ...
     .build();
 admin.createTable(NAMESPACE, TABLE, tableMetadata);

 // Get a table metadata
 tableMetadata = admin.getTableMetadata(NAMESPACE, TABLE);

 // Truncate a table
 admin.truncateTable(NAMESPACE, TABLE);

 // Drop a table
 admin.dropTable(NAMESPACE, TABLE);

 // Drop a namespace
 admin.dropNamespace(NAMESPACE);
 

Method Summary

Modifier and Type	Method and Description
void	addRawColumnToTable(java.lang.String namespace, java.lang.String table, java.lang.String columnName, DataType columnType) Add a column in the table without updating the metadata table in ScalarDB.
void	close() Closes connections to the storage.
TableMetadata	getImportTableMetadata(java.lang.String namespace, java.lang.String table) Get import table metadata in the ScalarDB format.

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

Method Detail

getImportTableMetadata

TableMetadata getImportTableMetadata(java.lang.String namespace,
                                     java.lang.String table)
                              throws ExecutionException

Get import table metadata in the ScalarDB format.

Parameters:

namespace - namespace name of import table

table - import table name

Returns:

import table metadata in the ScalarDB format

Throws:

java.lang.IllegalArgumentException - if the table does not exist

java.lang.IllegalStateException - if the table does not meet the requirement of ScalarDB table

ExecutionException - if the operation fails

addRawColumnToTable

void addRawColumnToTable(java.lang.String namespace,
                         java.lang.String table,
                         java.lang.String columnName,
                         DataType columnType)
                  throws ExecutionException

Add a column in the table without updating the metadata table in ScalarDB.

Parameters:

namespace - namespace name of import table

table - import table name

columnName - name of the column to be added

columnType - type of the column to be added

Throws:

java.lang.IllegalArgumentException - if the table does not exist

ExecutionException - if the operation fails

close

void close()

Closes connections to the storage.

Specified by:

close in interface java.lang.AutoCloseable