com.mapr.db

Interface TableDescriptor

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

TableDescriptorImpl

public interface TableDescriptor
extends java.lang.Cloneable

A TableDescriptor contains the details about a table such as the descriptors of all the families, the size at which a tablet split should occur, whether or not bulk load mode is turn on, and so on.

Method Summary

Methods

Modifier and Type	Method and Description
TableDescriptor	addFamily(FamilyDescriptor family) Appends a FamilyDescriptor to this TableDescriptor.
TableDescriptor	clone() Creates and returns a copy of this TableDescriptor.
java.util.List<FamilyDescriptor>	getFamilies() Returns the list of family descriptors for this table.
FamilyDescriptor	getFamily(java.lang.String familyName) Returns the FamilyDescriptor of the family with the specified name from this TableDescriptor or null if a family by this name does not exist in the TableDescriptor.
int	getNumFamilies() Returns the number of family descriptors for this table descriptor.
org.apache.hadoop.fs.Path	getPath()
long	getSplitSize()
boolean	isAutoSplit()
boolean	isBulkLoad()
boolean	isInsertionOrder()
TableDescriptor	setAutoSplit(boolean autoSplit) Sets the tablets to split automatically, or not, if they grow beyond a certain size.
TableDescriptor	setBulkLoad(boolean bulkLoad) Sets if the table is created with bulk load mode turned on.
TableDescriptor	setFamilies(java.util.List<FamilyDescriptor> families) Sets the list of families for this TableDescriptor.
TableDescriptor	setInsertionOrder(boolean insertionOrder) Sets the map entries to be stored in the order they are added or not to be stored in order.
TableDescriptor	setPath(org.apache.hadoop.fs.Path tablePath) Sets the path of this table in MapR FileSystem.
TableDescriptor	setPath(java.lang.String tablePath) Sets the path of this table in MapR FileSystem.
TableDescriptor	setSplitSize(long splitSizeMB) Sets the size in mebibytes at which a tablet in this table will split.

Method Detail

getPath

org.apache.hadoop.fs.Path getPath()

Returns:

the Path of this table

setPath

TableDescriptor setPath(java.lang.String tablePath)

Sets the path of this table in MapR FileSystem.

Parameters:

tablePath - the table path

Returns:

this for chain invocation

setPath

TableDescriptor setPath(org.apache.hadoop.fs.Path tablePath)

Sets the path of this table in MapR FileSystem.

Parameters:

tablePath - the table path

Returns:

this for chain invocation

isInsertionOrder

boolean isInsertionOrder()

Returns:

true if the map entries are stored in the order they are added, false if they are stored in the lexicographical order of their key name

setInsertionOrder

TableDescriptor setInsertionOrder(boolean insertionOrder)

Sets the map entries to be stored in the order they are added or not to be stored in order.

Parameters:

insertionOrder - true if the map entries are stored in the order they are added

Returns:

this for chain invocation

isBulkLoad

boolean isBulkLoad()

Returns:

true if the bulk load mode is set on this table

setBulkLoad

TableDescriptor setBulkLoad(boolean bulkLoad)

Sets if the table is created with bulk load mode turned on. This can be set to true only when creating the table and can only be set to false later.

Parameters:

bulkLoad - true if the bulk load mode is to be turned on

Returns:

this for chain invocation

isAutoSplit

boolean isAutoSplit()

Returns:

true if a tablet should split automatically if it grows beyond a certain size.

setAutoSplit

TableDescriptor setAutoSplit(boolean autoSplit)

Sets the tablets to split automatically, or not, if they grow beyond a certain size.

Parameters:

autoSplit - true if the split should happen automatically

Returns:

this for chain invocation

getSplitSize

long getSplitSize()

Returns:

The size in mebibytes at which a tablet in this table will split.

setSplitSize

TableDescriptor setSplitSize(long splitSizeMB)

Sets the size in mebibytes at which a tablet in this table will split. Default value is 4096 (4 gibibytes).

Parameters:

splitSizeMB - split size in mebibytes

Returns:

this for chain invocation

getFamily

FamilyDescriptor getFamily(java.lang.String familyName)

Returns the FamilyDescriptor of the family with the specified name from this TableDescriptor or null if a family by this name does not exist in the TableDescriptor. Modifying the returned object does not modify this TableDescriptor.

Parameters:

familyName - the family name

Returns:

the FamilyDescriptor

getFamilies

java.util.List<FamilyDescriptor> getFamilies()

Returns the list of family descriptors for this table. If the table does not have any column family defined, an empty list is returned. Modifying the returned list or the FamilyDescriptor in the list does not modify this TableDescriptor.

Returns:

the FamilyDescriptor list for this table

getNumFamilies

int getNumFamilies()

Returns the number of family descriptors for this table descriptor.

setFamilies

TableDescriptor setFamilies(java.util.List<FamilyDescriptor> families)

Sets the list of families for this TableDescriptor. The first family must be named 'default' and should have an empty JSON field path. This is only applicable when creating a table.

Parameters:

families - the list of families to add

Returns:

this for chain invocation

addFamily

TableDescriptor addFamily(FamilyDescriptor family)

Appends a FamilyDescriptor to this TableDescriptor. This is only applicable when creating a table.

Parameters:

family -

Returns:

this for chain invocation

clone

TableDescriptor clone()

Creates and returns a copy of this TableDescriptor.

Returns:

a clone of this TableDescriptor