com.scalar.db.storage.cosmos

Class CosmosAdmin

java.lang.Object

com.scalar.db.storage.cosmos.CosmosAdmin

All Implemented Interfaces:

Admin, DistributedStorageAdmin, java.lang.AutoCloseable

@ThreadSafe
public class CosmosAdmin
extends java.lang.Object
implements DistributedStorageAdmin

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NO_SCALING
static java.lang.String	DEFAULT_REQUEST_UNIT
static java.lang.String	METADATA_CONTAINER
static java.lang.String	NO_SCALING
static java.lang.String	REQUEST_UNIT
static java.lang.String	STORED_PROCEDURE_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
CosmosAdmin(DatabaseConfig databaseConfig)

Method Summary

Modifier and Type	Method and Description
void	addNewColumnToTable(java.lang.String namespace, java.lang.String table, java.lang.String columnName, DataType columnType) Adds a new column to an existing table.
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.
void	createIndex(java.lang.String namespace, java.lang.String table, java.lang.String columnName, java.util.Map<java.lang.String,java.lang.String> options) Creates a secondary index for the specified column of the specified table.
void	createNamespace(java.lang.String namespace, java.util.Map<java.lang.String,java.lang.String> options) Creates a namespace.
void	createTable(java.lang.String namespace, java.lang.String table, TableMetadata metadata, java.util.Map<java.lang.String,java.lang.String> options) Creates a new table.
void	dropIndex(java.lang.String namespace, java.lang.String table, java.lang.String columnName) Drops a secondary index for the specified column of the specified table.
void	dropNamespace(java.lang.String namespace) Drops the specified namespace.
void	dropTable(java.lang.String namespace, java.lang.String table) Drops the specified table.
TableMetadata	getImportTableMetadata(java.lang.String namespace, java.lang.String table, java.util.Map<java.lang.String,DataType> overrideColumnsType) Get import table metadata in the ScalarDB format.
java.util.Set<java.lang.String>	getNamespaceNames() Returns the names of the existing namespaces.
java.util.Set<java.lang.String>	getNamespaceTableNames(java.lang.String namespace) Returns the names of the table belonging to the given namespace.
StorageInfo	getStorageInfo(java.lang.String namespace) Returns the storage information.
TableMetadata	getTableMetadata(java.lang.String namespace, java.lang.String table) Retrieves the table metadata of the specified table.
void	importTable(java.lang.String namespace, java.lang.String table, java.util.Map<java.lang.String,java.lang.String> options, java.util.Map<java.lang.String,DataType> overrideColumnsType) Imports an existing table that is not managed by ScalarDB.
boolean	namespaceExists(java.lang.String namespace) Returns true if the namespace exists.
void	repairTable(java.lang.String namespace, java.lang.String table, TableMetadata metadata, java.util.Map<java.lang.String,java.lang.String> options) Repairs a table which may be in an unknown state.
void	truncateTable(java.lang.String namespace, java.lang.String table) Truncates the specified table.

Methods inherited from class java.lang.Object

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

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

getImportTableMetadata

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

addNewColumnToTable, createIndex, createIndex, createIndex, createNamespace, createNamespace, createNamespace, createTable, createTable, createTable, dropIndex, dropNamespace, dropTable, importTable, indexExists, tableExists

Field Detail

REQUEST_UNIT

public static final java.lang.String REQUEST_UNIT

See Also:

Constant Field Values

DEFAULT_REQUEST_UNIT

public static final java.lang.String DEFAULT_REQUEST_UNIT

See Also:

Constant Field Values

NO_SCALING

public static final java.lang.String NO_SCALING

See Also:

Constant Field Values

DEFAULT_NO_SCALING

public static final java.lang.String DEFAULT_NO_SCALING

See Also:

Constant Field Values

METADATA_CONTAINER

public static final java.lang.String METADATA_CONTAINER

See Also:

Constant Field Values

STORED_PROCEDURE_FILE_NAME

public static final java.lang.String STORED_PROCEDURE_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

CosmosAdmin

@Inject
public CosmosAdmin(DatabaseConfig databaseConfig)

Method Detail

createTable

public void createTable(java.lang.String namespace,
                        java.lang.String table,
                        TableMetadata metadata,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws ExecutionException

Description copied from interface: Admin

Creates a new table.

Specified by:

createTable in interface Admin

Parameters:

namespace - a namespace already created

table - a table to create

metadata - a metadata to create

options - options to create

Throws:

ExecutionException - if the operation fails

createNamespace

public void createNamespace(java.lang.String namespace,
                            java.util.Map<java.lang.String,java.lang.String> options)
                     throws ExecutionException

Description copied from interface: Admin

Creates a namespace.

Specified by:

createNamespace in interface Admin

Parameters:

namespace - the namespace to create

options - namespace creation options

Throws:

ExecutionException - if the operation fails

dropTable

public void dropTable(java.lang.String namespace,
                      java.lang.String table)
               throws ExecutionException

Description copied from interface: Admin

Drops the specified table.

Specified by:

dropTable in interface Admin

Parameters:

namespace - a namespace to drop

table - a table to drop

Throws:

ExecutionException - if the operation fails

dropNamespace

public void dropNamespace(java.lang.String namespace)
                   throws ExecutionException

Description copied from interface: Admin

Drops the specified namespace.

Specified by:

dropNamespace in interface Admin

Parameters:

namespace - a namespace to drop

Throws:

ExecutionException - if the operation fails

truncateTable

public void truncateTable(java.lang.String namespace,
                          java.lang.String table)
                   throws ExecutionException

Description copied from interface: Admin

Truncates the specified table.

Specified by:

truncateTable in interface Admin

Parameters:

namespace - a namespace to truncate

table - a table to truncate

Throws:

ExecutionException - if the operation fails

createIndex

public void createIndex(java.lang.String namespace,
                        java.lang.String table,
                        java.lang.String columnName,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws ExecutionException

Description copied from interface: Admin

Creates a secondary index for the specified column of the specified table.

Specified by:

createIndex in interface Admin

Parameters:

namespace - a namespace to create a secondary index

table - a table to create a secondary index

columnName - a name of the target column

options - options to create a secondary index

Throws:

ExecutionException - if the operation fails

dropIndex

public void dropIndex(java.lang.String namespace,
                      java.lang.String table,
                      java.lang.String columnName)
               throws ExecutionException

Description copied from interface: Admin

Drops a secondary index for the specified column of the specified table.

Specified by:

dropIndex in interface Admin

Parameters:

namespace - a namespace to drop a secondary index

table - a table to drop a secondary index

columnName - a name of the target column

Throws:

ExecutionException - if the operation fails

getTableMetadata

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

Description copied from interface: Admin

Retrieves the table metadata of the specified table.

Specified by:

getTableMetadata in interface Admin

Parameters:

namespace - a namespace to retrieve

table - a table to retrieve

Returns:

the table metadata of the specified table. null if the table is not found.

Throws:

ExecutionException - if the operation fails

close

public void close()

Description copied from interface: DistributedStorageAdmin

Closes connections to the storage.

Specified by:

close in interface DistributedStorageAdmin

Specified by:

close in interface java.lang.AutoCloseable

namespaceExists

public boolean namespaceExists(java.lang.String namespace)
                        throws ExecutionException

Description copied from interface: Admin

Returns true if the namespace exists.

Specified by:

namespaceExists in interface Admin

Parameters:

namespace - a namespace

Returns:

true if the namespace exists, false otherwise

Throws:

ExecutionException - if the operation fails

repairTable

public void repairTable(java.lang.String namespace,
                        java.lang.String table,
                        TableMetadata metadata,
                        java.util.Map<java.lang.String,java.lang.String> options)
                 throws ExecutionException

Description copied from interface: Admin

Repairs a table which may be in an unknown state.

Specified by:

repairTable in interface Admin

Parameters:

namespace - an existing namespace

table - an existing table

metadata - the metadata associated to the table to repair

options - options to repair

Throws:

ExecutionException - if the operation fails

getNamespaceTableNames

public java.util.Set<java.lang.String> getNamespaceTableNames(java.lang.String namespace)
                                                       throws ExecutionException

Description copied from interface: Admin

Returns the names of the table belonging to the given namespace.

Specified by:

getNamespaceTableNames in interface Admin

Parameters:

namespace - a namespace

Returns:

a set of table names, an empty list if the namespace doesn't exist

Throws:

ExecutionException - if the operation fails

addNewColumnToTable

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

Description copied from interface: Admin

Adds a new column to an existing table. The new column cannot be a partition or clustering key.

Warning : this should be executed with significant consideration as the execution time may vary greatly depending on the underlying storage. Please plan accordingly especially if the database runs in production:

• for Cosmos and Dynamo DB: this operation is almost instantaneous as the table schema is not modified. Only the table metadata stored in a separated table are updated.
• for Cassandra: adding a column will only update the schema metadata and do not modify existing schema records. The cluster topology is the main factor for the execution time. Since the schema metadata change propagates to each cluster node via a gossip protocol, the larger the cluster, the longer it will take for all nodes to be updated.
• for relational databases (MySQL, Oracle, etc.): it may take a very long time to execute and a table-lock may be performed.

Specified by:

addNewColumnToTable in interface Admin

Parameters:

namespace - the table namespace

table - the table name

columnName - the name of the new column

columnType - the type of the new column

Throws:

ExecutionException - if the operation fails

getImportTableMetadata

public TableMetadata getImportTableMetadata(java.lang.String namespace,
                                            java.lang.String table,
                                            java.util.Map<java.lang.String,DataType> overrideColumnsType)

Description copied from interface: DistributedStorageAdmin

Get import table metadata in the ScalarDB format.

Specified by:

getImportTableMetadata in interface DistributedStorageAdmin

Parameters:

namespace - namespace name of import table

table - import table name

overrideColumnsType - a map of column data type by column name. Only set the column for which you want to override the default data type mapping.

Returns:

import table metadata in the ScalarDB format

addRawColumnToTable

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

Description copied from interface: DistributedStorageAdmin

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

Specified by:

addRawColumnToTable in interface DistributedStorageAdmin

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

importTable

public void importTable(java.lang.String namespace,
                        java.lang.String table,
                        java.util.Map<java.lang.String,java.lang.String> options,
                        java.util.Map<java.lang.String,DataType> overrideColumnsType)

Description copied from interface: Admin

Imports an existing table that is not managed by ScalarDB.

Specified by:

importTable in interface Admin

Parameters:

namespace - an existing namespace

table - an existing table

options - options to import

overrideColumnsType - a map of column data type by column name. Only set the column for which you want to override the default data type mapping.

getNamespaceNames

public java.util.Set<java.lang.String> getNamespaceNames()
                                                  throws ExecutionException

Description copied from interface: Admin

Returns the names of the existing namespaces. However, only namespaces that contain tables are returned. From ScalarDB 4.0, we plan to improve the design to suppress this limitation.

Specified by:

getNamespaceNames in interface Admin

Returns:

a set of namespaces names, an empty set if no namespaces exist

Throws:

ExecutionException - if the operation fails

getStorageInfo

public StorageInfo getStorageInfo(java.lang.String namespace)

Description copied from interface: DistributedStorageAdmin

Returns the storage information.

Specified by:

getStorageInfo in interface DistributedStorageAdmin

Parameters:

namespace - the namespace to get the storage information for

Returns:

the storage information