org.apache.accumulo.core.client.mapreduce.lib.util
Class OutputConfigurator

java.lang.Object
  org.apache.accumulo.core.client.mapreduce.lib.util.ConfiguratorBase
      org.apache.accumulo.core.client.mapreduce.lib.util.OutputConfigurator

public class OutputConfigurator
extends ConfiguratorBase

Since:

1.5.0

Nested Class Summary

static class	OutputConfigurator.Features Configuration keys for various features.
static class	OutputConfigurator.WriteOpts Configuration keys for BatchWriter.

Nested classes/interfaces inherited from class org.apache.accumulo.core.client.mapreduce.lib.util.ConfiguratorBase

ConfiguratorBase.ConnectorInfo, ConfiguratorBase.GeneralOpts, ConfiguratorBase.InstanceOpts

Constructor Summary

OutputConfigurator()

Method Summary

static Boolean	canCreateTables(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) Determines whether tables are permitted to be created as needed.
static BatchWriterConfig	getBatchWriterOptions(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) Gets the BatchWriterConfig settings.
static String	getDefaultTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) Gets the default table name from the configuration.
static Boolean	getSimulationMode(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) Determines whether this feature is enabled.
static void	setBatchWriterOptions(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, BatchWriterConfig bwConfig) Sets the configuration for for the job's BatchWriter instances.
static void	setCreateTables(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature) Sets the directive to create new tables, as necessary.
static void	setDefaultTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, String tableName) Sets the default table name to use if one emits a null in place of a table name for a given mutation.
static void	setSimulationMode(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature) Sets the directive to use simulation mode for this job.

Methods inherited from class org.apache.accumulo.core.client.mapreduce.lib.util.ConfiguratorBase

enumToConfKey, getInstance, getLogLevel, getPrincipal, getToken, getTokenClass, isConnectorInfoSet, setConnectorInfo, setLogLevel, setMockInstance, setZooKeeperInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputConfigurator

public OutputConfigurator()

Method Detail

setDefaultTableName

public static void setDefaultTableName(Class<?> implementingClass,
                                       org.apache.hadoop.conf.Configuration conf,
                                       String tableName)

Sets the default table name to use if one emits a null in place of a table name for a given mutation. Table names can only be alpha-numeric and underscores.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

tableName - the table to use when the tablename is null in the write call

Since:

1.5.0

getDefaultTableName

public static String getDefaultTableName(Class<?> implementingClass,
                                         org.apache.hadoop.conf.Configuration conf)

Gets the default table name from the configuration.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

Returns:

the default table name

Since:

1.5.0

See Also:

setDefaultTableName(Class, Configuration, String)

setBatchWriterOptions

public static void setBatchWriterOptions(Class<?> implementingClass,
                                         org.apache.hadoop.conf.Configuration conf,
                                         BatchWriterConfig bwConfig)

Sets the configuration for for the job's BatchWriter instances. If not set, a new BatchWriterConfig, with sensible built-in defaults is used. Setting the configuration multiple times overwrites any previous configuration.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

bwConfig - the configuration for the BatchWriter

Since:

1.5.0

getBatchWriterOptions

public static BatchWriterConfig getBatchWriterOptions(Class<?> implementingClass,
                                                      org.apache.hadoop.conf.Configuration conf)

Gets the BatchWriterConfig settings.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

Returns:

the configuration object

Since:

1.5.0

See Also:

setBatchWriterOptions(Class, Configuration, BatchWriterConfig)

setCreateTables

public static void setCreateTables(Class<?> implementingClass,
                                   org.apache.hadoop.conf.Configuration conf,
                                   boolean enableFeature)

Sets the directive to create new tables, as necessary. Table names can only be alpha-numeric and underscores.

By default, this feature is disabled.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

enableFeature - the feature is enabled if true, disabled otherwise

Since:

1.5.0

canCreateTables

public static Boolean canCreateTables(Class<?> implementingClass,
                                      org.apache.hadoop.conf.Configuration conf)

Determines whether tables are permitted to be created as needed.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

Returns:

true if the feature is disabled, false otherwise

Since:

1.5.0

See Also:

setCreateTables(Class, Configuration, boolean)

setSimulationMode

public static void setSimulationMode(Class<?> implementingClass,
                                     org.apache.hadoop.conf.Configuration conf,
                                     boolean enableFeature)

Sets the directive to use simulation mode for this job. In simulation mode, no output is produced. This is useful for testing.

By default, this feature is disabled.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

enableFeature - the feature is enabled if true, disabled otherwise

Since:

1.5.0

getSimulationMode

public static Boolean getSimulationMode(Class<?> implementingClass,
                                        org.apache.hadoop.conf.Configuration conf)

Determines whether this feature is enabled.

Parameters:

implementingClass - the class whose name will be used as a prefix for the property configuration key

conf - the Hadoop configuration object to configure

Returns:

true if the feature is enabled, false otherwise

Since:

1.5.0

See Also:

setSimulationMode(Class, Configuration, boolean)