com.mapr.db

Class MapRDB

java.lang.Object

com.mapr.db.MapRDB

public class MapRDB
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
static Table	createTable(String tablePath) Creates a JSON table at the specified path with a 'default' column family and default options.
static boolean	deleteTable(String tablePath) Deletes a Table.
static Table	getTable(org.apache.hadoop.fs.Path path) Returns an object for accessing the table having the given path name.
static Table	getTable(String pathName) Returns an object for accessing the table having the given path name.
static Admin	newAdmin() Creates and returns an Admin instance with default configuration.
static Admin	newAdmin(org.apache.hadoop.conf.Configuration c) Creates and returns an Admin instance with specified configuration.
static org.ojai.store.QueryCondition	newCondition() Creates and returns a new QueryCondition object.
static FamilyDescriptor	newDefaultFamilyDescriptor() Creates and returns a FamilyDescriptor instance for the "default" family.
static org.ojai.Document	newDocument() Creates and returns a new, empty instance of Document.
static org.ojai.Document	newDocument(Map<String,Object> map) Returns a new instance of Document constructed from the specified Map
static org.ojai.Document	newDocument(Object bean) Returns a new instance of Document built from the specified Java bean.
static org.ojai.Document	newDocument(String jsonString) Returns a new instance of Document parsed from the specified JSON string.
static org.ojai.DocumentBuilder	newDocumentBuilder() Returns the MapRDB storage implementation of DocumentBuilder interface.
static FamilyDescriptor	newFamilyDescriptor() Creates and returns a FamilyDescriptor instance.
static FamilyDescriptor	newFamilyDescriptor(String familyName, org.ojai.FieldPath jsonPath) Creates and returns a FamilyDescriptor instance initialized with the specified family name and its JSON path.
static FamilyDescriptor	newFamilyDescriptor(String familyName, String jsonPath) Creates and returns a FamilyDescriptor instance initialized with the specified family name and its JSON path.
static org.ojai.store.DocumentMutation	newMutation() Creates and returns a new DocumentMutation object.
static TableDescriptor	newTableDescriptor() Creates and returns a TableDescriptor instance.
static TableDescriptor	newTableDescriptor(boolean insertionOrder) Deprecated.
static TableDescriptor	newTableDescriptor(org.apache.hadoop.fs.Path tablePath) Creates and returns a TableDescriptor instance initialized with the specified path.
static TableDescriptor	newTableDescriptor(String tablePath) Creates and returns a TableDescriptor instance initialized with the specified path.
static boolean	tableExists(String tablePath) Test for the existence of Table at the given path.

Methods inherited from class java.lang.Object

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

Method Detail

tableExists

public static boolean tableExists(String tablePath)
                           throws DBException

Test for the existence of Table at the given path. This is a shortcut method for Admin.tableExists(String).

Parameters:

tablePath - The table path. The table path can be either absolute or relative to the user's home directory. The absolute path can be specified as "/<tablepath>" for tables in a 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

createTable

public static Table createTable(String tablePath)
                         throws DBException

Creates a JSON table at the specified path with a 'default' column family and default options. This is a shortcut method for Admin.createTable(String).

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 a 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 exists

DBException - if some DBException occurs

deleteTable

public static boolean deleteTable(String tablePath)
                           throws DBException

Deletes a Table. This is a shortcut method for Admin.deleteTable(String).

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 a 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

getTable

public static Table getTable(String pathName)
                      throws DBException

Returns an object for accessing the table having the given path name. The table is opened with default table options.

Parameters:

pathName - table path. It can be specified as /tablepath to access a table in a default cluster or as /mapr/clustername/tabletpath to access a table in the given cluster

Returns:

table object for accessing the table

Throws:

TableNotFoundException - when the table doesn't exist

DBException

getTable

public static Table getTable(org.apache.hadoop.fs.Path path)
                      throws DBException

Returns an object for accessing the table having the given path name. The table is opened with default table options.

Parameters:

pathName - table path. It can be specified as /tablepath to access a table in a default cluster or as /mapr/clustername/tabletpath to access a table in the given cluster

Returns:

table object for accessing the table

Throws:

TableNotFoundException - when the table doesn't exist

DBException

newAdmin

public static Admin newAdmin()
                      throws DBException

Creates and returns an Admin instance with default configuration.

Returns:

an instance of Admin interface

Throws:

DBException

newAdmin

public static Admin newAdmin(org.apache.hadoop.conf.Configuration c)
                      throws DBException

Creates and returns an Admin instance with specified configuration.

Returns:

an instance of Admin interface

Throws:

DBException

newTableDescriptor

public static TableDescriptor newTableDescriptor()

Creates and returns a TableDescriptor instance.

Returns:

an instance of TableDescriptor interface

newTableDescriptor

public static TableDescriptor newTableDescriptor(String tablePath)

Creates and returns a TableDescriptor instance initialized with the specified path.

Returns:

an instance of TableDescriptor interface

newTableDescriptor

public static TableDescriptor newTableDescriptor(org.apache.hadoop.fs.Path tablePath)

Creates and returns a TableDescriptor instance initialized with the specified path.

Returns:

an instance of TableDescriptor interface

newTableDescriptor

@Deprecated
public static TableDescriptor newTableDescriptor(boolean insertionOrder)

Deprecated.

newFamilyDescriptor

public static FamilyDescriptor newFamilyDescriptor()

Creates and returns a FamilyDescriptor instance.

Returns:

an instance of FamilyDescriptor interface

newDefaultFamilyDescriptor

public static FamilyDescriptor newDefaultFamilyDescriptor()

Creates and returns a FamilyDescriptor instance for the "default" family.

Returns:

an instance of FamilyDescriptor interface

newFamilyDescriptor

public static FamilyDescriptor newFamilyDescriptor(String familyName,
                                   String jsonPath)

Creates and returns a FamilyDescriptor instance initialized with the specified family name and its JSON path.

Returns:

an instance of FamilyDescriptor interface

newFamilyDescriptor

public static FamilyDescriptor newFamilyDescriptor(String familyName,
                                   org.ojai.FieldPath jsonPath)

Creates and returns a FamilyDescriptor instance initialized with the specified family name and its JSON path.

Returns:

an instance of FamilyDescriptor interface

newDocument

public static org.ojai.Document newDocument()

Creates and returns a new, empty instance of Document.

newDocument

public static org.ojai.Document newDocument(String jsonString)
                                     throws org.ojai.exceptions.DecodingException

Returns a new instance of Document parsed from the specified JSON string.

Throws:

org.ojai.exceptions.DecodingException

newDocument

public static org.ojai.Document newDocument(Map<String,Object> map)
                                     throws org.ojai.exceptions.DecodingException

Returns a new instance of Document constructed from the specified Map

Throws:

org.ojai.exceptions.DecodingException

newDocument

public static org.ojai.Document newDocument(Object bean)
                                     throws org.ojai.exceptions.DecodingException

Returns a new instance of Document built from the specified Java bean.

Throws:

org.ojai.exceptions.DecodingException

newDocumentBuilder

public static org.ojai.DocumentBuilder newDocumentBuilder()

Returns the MapRDB storage implementation of DocumentBuilder interface.

newMutation

public static org.ojai.store.DocumentMutation newMutation()

Creates and returns a new DocumentMutation object.

newCondition

public static org.ojai.store.QueryCondition newCondition()

Creates and returns a new QueryCondition object.