Package org.apache.accumulo.core.client.admin

Class NewTableConfiguration

java.lang.Object

org.apache.accumulo.core.client.admin.NewTableConfiguration

public class NewTableConfiguration
extends Object

This object stores table creation parameters. Currently includes: TimeType, whether to include default iterators, and user-specified initial properties

Since:

1.7.0

Constructor Summary

Constructors

Constructor	Description
NewTableConfiguration()

Method Summary

Modifier and Type	Method	Description
NewTableConfiguration	attachIterator(IteratorSetting setting)	Configure iterator settings for a table prior to its creation.
NewTableConfiguration	attachIterator(IteratorSetting setting, EnumSet<IteratorUtil.IteratorScope> scopes)	Configure iterator settings for a table prior to its creation.
NewTableConfiguration	createOffline()	Create the new table in an offline state.
NewTableConfiguration	enableSampling(SamplerConfiguration samplerConfiguration)	Enable building a sample data set on the new table using the given sampler configuration.
NewTableConfiguration	enableSummarization(SummarizerConfiguration... configs)	Enables creating summary statistics using Summarizer's for the new table.
InitialTableState	getInitialTableState()	Return value indicating whether table is to be created in offline or online mode.
Map<String,String>	getProperties()	Retrieves the complete set of currently configured table properties to be applied to a table when this configuration object is used.
Collection<org.apache.hadoop.io.Text>	getSplits()	Return Collection of split values.
TimeType	getTimeType()	Retrieve the time type currently configured.
NewTableConfiguration	setLocalityGroups(Map<String,Set<org.apache.hadoop.io.Text>> groups)	Configures a table's locality groups prior to initial table creation.
NewTableConfiguration	setProperties(Map<String,String> props)	Sets additional properties to be applied to tables created with this configuration.
NewTableConfiguration	setTimeType(TimeType tt)	Configure logical or millisecond time for tables created with this configuration.
NewTableConfiguration	withoutDefaultIterators()	Currently the only default iterator is the VersioningIterator.
NewTableConfiguration	withSplits(SortedSet<org.apache.hadoop.io.Text> splits)	Create a new table with pre-configured splits from the provided input collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewTableConfiguration

public NewTableConfiguration()

Method Detail

setTimeType

public NewTableConfiguration setTimeType(TimeType tt)

Configure logical or millisecond time for tables created with this configuration.

Parameters:

tt - the time type to use; defaults to milliseconds

Returns:

this

getTimeType

public TimeType getTimeType()

Retrieve the time type currently configured.

Returns:

the time type

withoutDefaultIterators

public NewTableConfiguration withoutDefaultIterators()

Currently the only default iterator is the VersioningIterator. This method will cause the table to be created without that iterator, or any others which may become defaults in the future.

Returns:

this

createOffline

public NewTableConfiguration createOffline()

Create the new table in an offline state.

Returns:

this

Since:

2.0.0

getInitialTableState

public InitialTableState getInitialTableState()

Return value indicating whether table is to be created in offline or online mode.

Since:

2.0.0

setProperties

public NewTableConfiguration setProperties(Map<String,String> props)

Sets additional properties to be applied to tables created with this configuration. Additional calls to this method replace properties set by previous calls.

Parameters:

props - additional properties to add to the table when it is created

Returns:

this

getProperties

public Map<String,String> getProperties()

Retrieves the complete set of currently configured table properties to be applied to a table when this configuration object is used.

Returns:

the current properties configured

getSplits

public Collection<org.apache.hadoop.io.Text> getSplits()

Return Collection of split values.

Returns:

Collection containing splits associated with this NewTableConfiguration object.

Since:

2.0.0

enableSampling

public NewTableConfiguration enableSampling(SamplerConfiguration samplerConfiguration)

Enable building a sample data set on the new table using the given sampler configuration.

Since:

1.8.0

enableSummarization

public NewTableConfiguration enableSummarization(SummarizerConfiguration... configs)

Enables creating summary statistics using Summarizer's for the new table.

Since:

2.0.0

setLocalityGroups

public NewTableConfiguration setLocalityGroups(Map<String,Set<org.apache.hadoop.io.Text>> groups)

Configures a table's locality groups prior to initial table creation. Allows locality groups to be set prior to table creation. Additional calls to this method prior to table creation will overwrite previous locality group mappings.

Parameters:

groups - mapping of locality group names to column families in the locality group

Since:

2.0.0

See Also:

TableOperations.setLocalityGroups(java.lang.String, java.util.Map<java.lang.String, java.util.Set<org.apache.hadoop.io.Text>>)

withSplits

public NewTableConfiguration withSplits(SortedSet<org.apache.hadoop.io.Text> splits)

Create a new table with pre-configured splits from the provided input collection.

Parameters:

splits - A SortedSet of String values to be used as split points in a newly created table.

Returns:

this

Since:

2.0.0

attachIterator

public NewTableConfiguration attachIterator(IteratorSetting setting)

Configure iterator settings for a table prior to its creation. Additional calls to this method before table creation will overwrite previous iterator settings.

Parameters:

setting - object specifying the properties of the iterator

Since:

2.0.0

See Also:

TableOperations.attachIterator(String, IteratorSetting)

attachIterator

public NewTableConfiguration attachIterator(IteratorSetting setting,
                                            EnumSet<IteratorUtil.IteratorScope> scopes)

Configure iterator settings for a table prior to its creation.

Parameters:

setting - object specifying the properties of the iterator

scopes - enumerated set of iterator scopes

Since:

2.0.0

See Also:

TableOperations.attachIterator(String, IteratorSetting, EnumSet)