Package org.apache.accumulo.core.client.mapreduce.lib.util

Class InputConfigurator

java.lang.Object
org.apache.accumulo.core.client.mapreduce.lib.util.ConfiguratorBase
org.apache.accumulo.core.client.mapreduce.lib.util.InputConfigurator
@Deprecated public class InputConfigurator extends ConfiguratorBase
Deprecated.
since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
Since:
1.5.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    InputConfigurator.Features
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static enum 
    InputConfigurator.ScanOpts
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.

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

    ConfiguratorBase.ConnectorInfo, ConfiguratorBase.GeneralOpts, ConfiguratorBase.InstanceOpts

  • Constructor Summary

    Constructors
    Constructor
    Description
    InputConfigurator()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addIterator(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, IteratorSetting cfg)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Set<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>>
    deserializeFetchedColumns(Collection<String> serialized)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    fetchColumns(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Collection<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Boolean
    getAutoAdjustRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Set<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>>
    getFetchedColumns(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static String
    getInputTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static List<IteratorSetting>
    getIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static List<Range>
    getRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Authorizations
    getScanAuthorizations(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static org.apache.accumulo.core.client.impl.TabletLocator
    getTabletLocator(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Boolean
    isIsolated(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Boolean
    isOfflineScan(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static String[]
    serializeColumns(Collection<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setAutoAdjustRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setInputTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, String tableName)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setLocalIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setOfflineTableScan(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Collection<Range> ranges)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setScanAuthorizations(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Authorizations auths)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    setScanIsolation(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static Boolean
    usesLocalIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
    static void
    validateOptions(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
    Deprecated.
    since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.

    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 Details

    • InputConfigurator

      public InputConfigurator()
      Deprecated.

  • Method Details

    • setInputTableName

      @Deprecated public static void setInputTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, String tableName)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Sets the name of the input table, over which this job will scan.
      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

    • getInputTableName

      @Deprecated public static String getInputTableName(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Gets the 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 table name
      Since:
      1.5.0
      See Also:

    • setScanAuthorizations

      @Deprecated public static void setScanAuthorizations(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Authorizations auths)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Sets the Authorizations used to scan. Must be a subset of the user's authorization. Defaults to the empty set.
      Parameters:
      implementingClass - the class whose name will be used as a prefix for the property configuration key
      conf - the Hadoop configuration object to configure
      auths - the user's authorizations
      Since:
      1.5.0

    • getScanAuthorizations

      @Deprecated public static Authorizations getScanAuthorizations(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Gets the authorizations to set for the scans 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 Accumulo scan authorizations
      Since:
      1.5.0
      See Also:

    • setRanges

      @Deprecated public static void setRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Collection<Range> ranges)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Sets the input ranges to scan for this job. If not set, the entire table will be scanned.
      Parameters:
      implementingClass - the class whose name will be used as a prefix for the property configuration key
      conf - the Hadoop configuration object to configure
      ranges - the ranges that will be mapped over
      Since:
      1.5.0

    • getRanges

      @Deprecated public static List<Range> getRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) throws IOException
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Gets the ranges to scan over from a job.
      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 ranges
      Throws:
      IOException - if the ranges have been encoded improperly
      Since:
      1.5.0
      See Also:

    • fetchColumns

      @Deprecated public static void fetchColumns(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, Collection<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Restricts the columns that will be mapped over for this job.
      Parameters:
      implementingClass - the class whose name will be used as a prefix for the property configuration key
      conf - the Hadoop configuration object to configure
      columnFamilyColumnQualifierPairs - a pair of Text objects corresponding to column family and column qualifier. If the column qualifier is null, the entire column family is selected. An empty set is the default and is equivalent to scanning the all columns.
      Since:
      1.5.0

    • serializeColumns

      @Deprecated public static String[] serializeColumns(Collection<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> columnFamilyColumnQualifierPairs)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.

    • getFetchedColumns

      @Deprecated public static Set<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> getFetchedColumns(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Gets the columns to be mapped over from this job.
      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:
      a set of columns
      Since:
      1.5.0
      See Also:

    • deserializeFetchedColumns

      @Deprecated public static Set<org.apache.accumulo.core.util.Pair<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>> deserializeFetchedColumns(Collection<String> serialized)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.

    • addIterator

      @Deprecated public static void addIterator(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, IteratorSetting cfg)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Encode an iterator on the input for this job.
      Parameters:
      implementingClass - the class whose name will be used as a prefix for the property configuration key
      conf - the Hadoop configuration object to configure
      cfg - the configuration of the iterator
      Since:
      1.5.0

    • getIterators

      @Deprecated public static List<IteratorSetting> getIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Gets a list of the iterator settings (for iterators to apply to a scanner) from this 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:
      a list of iterators
      Since:
      1.5.0
      See Also:

    • setAutoAdjustRanges

      @Deprecated public static void setAutoAdjustRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Controls the automatic adjustment of ranges for this job. This feature merges overlapping ranges, then splits them to align with tablet boundaries. Disabling this feature will cause exactly one Map task to be created for each specified range. The default setting is enabled. *

      By default, 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
      enableFeature - the feature is enabled if true, disabled otherwise
      Since:
      1.5.0
      See Also:

    • getAutoAdjustRanges

      @Deprecated public static Boolean getAutoAdjustRanges(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Determines whether a configuration has auto-adjust ranges 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:
      false if the feature is disabled, true otherwise
      Since:
      1.5.0
      See Also:

    • setScanIsolation

      @Deprecated public static void setScanIsolation(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Controls the use of the IsolatedScanner in this job.

      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

    • isIsolated

      @Deprecated public static Boolean isIsolated(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Determines whether a configuration has isolation 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:

    • setLocalIterators

      @Deprecated public static void setLocalIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Controls the use of the ClientSideIteratorScanner in this job. Enabling this feature will cause the iterator stack to be constructed within the Map task, rather than within the Accumulo TServer. To use this feature, all classes needed for those iterators must be available on the classpath for the task.

      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

    • usesLocalIterators

      @Deprecated public static Boolean usesLocalIterators(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Determines whether a configuration uses local iterators.
      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:

    • setOfflineTableScan

      @Deprecated public static void setOfflineTableScan(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf, boolean enableFeature)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Enable reading offline tables. By default, this feature is disabled and only online tables are scanned. This will make the map reduce job directly read the table's files. If the table is not offline, then the job will fail. If the table comes online during the map reduce job, it is likely that the job will fail.

      To use this option, the map reduce user will need access to read the Accumulo directory in HDFS.

      Reading the offline table will create the scan time iterator stack in the map process. So any iterators that are configured for the table will need to be on the mapper's classpath. The accumulo-site.xml may need to be on the mapper's classpath if HDFS or the Accumulo directory in HDFS are non-standard.

      One way to use this feature is to clone a table, take the clone offline, and use the clone as the input table for a map reduce job. If you plan to map reduce over the data many times, it may be better to the compact the table, clone it, take it offline, and use the clone for all map reduce jobs. The reason to do this is that compaction will reduce each tablet in the table to one file, and it is faster to read from one file.

      There are two possible advantages to reading a tables file directly out of HDFS. First, you may see better read performance. Second, it will support speculative execution better. When reading an online table speculative execution can put more load on an already slow tablet server.

      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

    • isOfflineScan

      @Deprecated public static Boolean isOfflineScan(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf)
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Determines whether a configuration has the offline table scan feature 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:

    • getTabletLocator

      @Deprecated public static org.apache.accumulo.core.client.impl.TabletLocator getTabletLocator(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) throws TableNotFoundException
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Initializes an Accumulo TabletLocator based on 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:
      an Accumulo tablet locator
      Throws:
      TableNotFoundException - if the table name set on the configuration doesn't exist
      Since:
      1.5.0

    • validateOptions

      @Deprecated public static void validateOptions(Class<?> implementingClass, org.apache.hadoop.conf.Configuration conf) throws IOException
      Deprecated.
      since 1.6.0; Configure your job with the appropriate InputFormat or OutputFormat.
      Check whether a configuration is fully configured to be used with an Accumulo InputFormat.
      Parameters:
      implementingClass - the class whose name will be used as a prefix for the property configuration key
      conf - the Hadoop configuration object to configure
      Throws:
      IOException - if the context is improperly configured
      Since:
      1.5.0