com.mapr.db

Interface Admin

All Superinterfaces:

java.lang.AutoCloseable

public interface Admin
extends java.lang.AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	alterFamily(org.apache.hadoop.fs.Path tablePath, java.lang.String familyName, FamilyDescriptor familyDesc)
void	alterFamily(java.lang.String tablePath, java.lang.String familyName, FamilyDescriptor familyDesc)
void	alterTable(TableDescriptor tableDesc) Modify the attributes of an existing table.
void	close() Override AutoCloseable.close() to avoid declaring a checked exception.
Table	createTable(org.apache.hadoop.fs.Path tablePath) Creates a Json table at the specified path with 'default' column family and default options.
Table	createTable(java.lang.String tablePath) Creates a Json table at the specified path with 'default' column family and default options.
Table	createTable(TableDescriptor tableDesc) Creates a Json table using the specified TableDescriptor.
Table	createTable(TableDescriptor tableDesc, java.nio.ByteBuffer[] splitPoints) Creates a pre-split JSON table using the specified TableDescriptor and the split points as the tablet boundaries.
Table	createTable(TableDescriptor tableDesc, java.lang.String[] splitPoints) Creates a pre-split Json table using the specified TableDescriptor and the split points as the tablet boundaries.
boolean	deleteFamily(org.apache.hadoop.fs.Path tablePath, java.lang.String familyName) Deletes a family from a Json table.
boolean	deleteFamily(java.lang.String tablePath, java.lang.String familyName) Deletes a family from a Json table.
boolean	deleteTable(org.apache.hadoop.fs.Path tablePath) Deletes a Table.
boolean	deleteTable(java.lang.String tablePath) Deletes a Table.
TableDescriptor	getTableDescriptor(org.apache.hadoop.fs.Path tablePath)
TableDescriptor	getTableDescriptor(java.lang.String tablePath)
java.util.Collection<IndexDesc>	getTableIndexes(org.apache.hadoop.fs.Path tablePath) Returns a collection of descriptors for secondary indexes for the specified table that are ready to server queries.
java.util.Collection<IndexDesc>	getTableIndexes(java.lang.String tablePath) Returns a collection of descriptors for secondary indexes for the specified table that are ready to server queries.
java.util.List<org.apache.hadoop.fs.Path>	listTables() List all tables in user's home directory.
java.util.List<org.apache.hadoop.fs.Path>	listTables(org.apache.hadoop.fs.Path folderOrPattern) List all tables in the specified folder and/or with the matching pattern.
java.util.List<org.apache.hadoop.fs.Path>	listTables(java.lang.String folderOrPattern) List all tables in the specified folder and/or with the matching pattern.
boolean	tableExists(org.apache.hadoop.fs.Path tablePath)
boolean	tableExists(java.lang.String tablePath)

Method Detail

listTables

java.util.List<org.apache.hadoop.fs.Path> listTables()
                                              throws DBException

List all tables in user's home directory.

Returns:

a list of table paths

Throws:

DBException

listTables

java.util.List<org.apache.hadoop.fs.Path> listTables(java.lang.String folderOrPattern)
                                              throws DBException

List all tables in the specified folder and/or with the matching pattern.

Parameters:

folderOrPattern - the parent folder or pattern

Returns:

a list of table paths

Throws:

DBException

listTables

java.util.List<org.apache.hadoop.fs.Path> listTables(org.apache.hadoop.fs.Path folderOrPattern)
                                              throws DBException

List all tables in the specified folder and/or with the matching pattern.

Parameters:

folderOrPattern - the parent folder or pattern

Returns:

a list of table paths

Throws:

DBException

createTable

Table createTable(java.lang.String tablePath)
           throws TableExistsException,
                  DBException

Creates a Json table at the specified path with 'default' column family and default options.

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

Table object for accessing the table

Throws:

TableExistsException - if a table with the specified path already exits

DBException - if some DBException occurs

createTable

Table createTable(org.apache.hadoop.fs.Path tablePath)
           throws TableExistsException,
                  DBException

Creates a Json table at the specified path with 'default' column family and default options.

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

Table object for accessing the table

Throws:

TableExistsException - if a table with the specified path already exits

DBException - if some DBException occurs

createTable

Table createTable(TableDescriptor tableDesc)
           throws TableExistsException,
                  DBException

Creates a Json table using the specified TableDescriptor.

Parameters:

tableDesc - the TableDescriptor containing various attributes of this table

Returns:

a Table object connected to the newly created table

Throws:

TableExistsException - if the table already exist at the specified path

DBException - if an DBException occurs

createTable

Table createTable(TableDescriptor tableDesc,
                  java.lang.String[] splitPoints)
           throws TableExistsException,
                  DBException

Creates a pre-split Json table using the specified TableDescriptor and the split points as the tablet boundaries. The number of tablets is 1 + the number of split points. The split points must be in sorted order.

Parameters:

tableDesc - the TableDescriptor containing various attributes of this table

splitPoints - the split points for this table

Returns:

Throws:

TableExistsException

DBException

createTable

Table createTable(TableDescriptor tableDesc,
                  java.nio.ByteBuffer[] splitPoints)
           throws TableExistsException,
                  DBException

Creates a pre-split JSON table using the specified TableDescriptor and the split points as the tablet boundaries. The number of tablets is 1 + the number of split points. The split points must be in sorted order.

Parameters:

tableDesc - the TableDescriptor containing various attributes of this table

splitPoints - the split points for this table

Returns:

Throws:

TableExistsException

DBException

alterTable

void alterTable(TableDescriptor tableDesc)
         throws TableNotFoundException,
                OpNotPermittedException,
                DBException

Modify the attributes of an existing table. This API cannot be used to modify (add/remove/alter) families of the table. Please use #addFamily(Path, FamilyDescriptor), deleteFamily(Path, String), and alterFamily(Path, String, FamilyDescriptor) for this purpose.

Parameters:

tableDesc - the TableDescriptor containing various attributes of this table

Throws:

TableNotFoundException

OpNotPermittedException - if an attribute is requested to be modified but is not allowed

DBException

deleteFamily

boolean deleteFamily(java.lang.String tablePath,
                     java.lang.String familyName)
              throws TableNotFoundException,
                     FamilyNotFoundException,
                     DBException

Deletes a family from a Json table.

Parameters:

tablePath -

familyName -

Returns:

true if and only if the family is successfully deleted; false otherwise

Throws:

DBException

TableNotFoundException

FamilyNotFoundException

deleteFamily

boolean deleteFamily(org.apache.hadoop.fs.Path tablePath,
                     java.lang.String familyName)
              throws TableNotFoundException,
                     FamilyNotFoundException,
                     DBException

Deletes a family from a Json table.

Parameters:

tablePath -

familyName -

Returns:

true if and only if the family is successfully deleted; false otherwise

Throws:

DBException

TableNotFoundException

FamilyNotFoundException

alterFamily

void alterFamily(java.lang.String tablePath,
                 java.lang.String familyName,
                 FamilyDescriptor familyDesc)
          throws TableNotFoundException,
                 FamilyNotFoundException,
                 OpNotPermittedException,
                 DBException

Parameters:

tablePath -

familyName -

familyDesc -

Throws:

TableNotFoundException

FamilyNotFoundException

OpNotPermittedException - if an attribute is requested to be modified but is not allowed

DBException

alterFamily

void alterFamily(org.apache.hadoop.fs.Path tablePath,
                 java.lang.String familyName,
                 FamilyDescriptor familyDesc)
          throws TableNotFoundException,
                 FamilyNotFoundException,
                 OpNotPermittedException,
                 DBException

Parameters:

tablePath -

familyName -

familyDesc -

Throws:

TableNotFoundException

FamilyNotFoundException

OpNotPermittedException - if an attribute is requested to be modified but is not allowed

DBException

tableExists

boolean tableExists(java.lang.String tablePath)
             throws DBException

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

true if the specified path exists and is a table

Throws:

DBException

tableExists

boolean tableExists(org.apache.hadoop.fs.Path tablePath)
             throws DBException

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

true if the specified path exists and is a table

Throws:

DBException

getTableDescriptor

TableDescriptor getTableDescriptor(java.lang.String tablePath)
                            throws DBException

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

TableDescriptor for the specified table

Throws:

DBException

getTableDescriptor

TableDescriptor getTableDescriptor(org.apache.hadoop.fs.Path tablePath)
                            throws DBException

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

TableDescriptor for the specified table

Throws:

DBException

getTableIndexes

java.util.Collection<IndexDesc> getTableIndexes(java.lang.String tablePath)
                                         throws DBException

Returns a collection of descriptors for secondary indexes for the specified table that are ready to server queries.

Throws:

DBException

getTableIndexes

java.util.Collection<IndexDesc> getTableIndexes(org.apache.hadoop.fs.Path tablePath)
                                         throws DBException

Returns a collection of descriptors for secondary indexes for the specified table that are ready to server queries.

Throws:

DBException

deleteTable

boolean deleteTable(java.lang.String tablePath)
             throws DBException

Deletes a Table.

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

true if and only if the table is successfully deleted; otherwise, false

Throws:

AccessDeniedException - if the user does not have permission to delete the table.

DBException

deleteTable

boolean deleteTable(org.apache.hadoop.fs.Path tablePath)
             throws DBException

Deletes a Table.

Parameters:

tablePath - The table path. The table path can be either absolute or relative to user's home directory. The absolute path can be specified as "/<tablepath>" for tables in default cluster or as "/mapr/<clustername>/<tablepath>" for tables in the specified cluster

Returns:

true if and only if the table is successfully deleted; otherwise, false

Throws:

AccessDeniedException - If the user does not have permission to delete the table.

DBException

close

void close()
    throws DBException

Override AutoCloseable.close() to avoid declaring a checked exception.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

DBException