org.apache.accumulo.hadoop.mapreduce

Interface InputFormatBuilder.InputFormatOptions<T>

All Superinterfaces:

InputFormatBuilder.TableParams<T>

All Known Implementing Classes:

InputFormatBuilderImpl

Enclosing interface:

InputFormatBuilder

public static interface InputFormatBuilder.InputFormatOptions<T>
extends InputFormatBuilder.TableParams<T>

Optional values to set using fluent API

Since:

2.0

Method Summary

Modifier and Type	Method and Description
InputFormatBuilder.InputFormatOptions<T>	addIterator(IteratorSetting cfg) Encode an iterator on the single input table for this job.
InputFormatBuilder.InputFormatOptions<T>	auths(Authorizations auths) Sets the Authorizations used to scan.
InputFormatBuilder.InputFormatOptions<T>	autoAdjustRanges(boolean value) Disables the automatic adjustment of ranges for this job.
InputFormatBuilder.InputFormatOptions<T>	batchScan(boolean value) Enables the use of the BatchScanner in this job.
InputFormatBuilder.InputFormatOptions<T>	classLoaderContext(String context) Sets the name of the classloader context on this scanner
InputFormatBuilder.InputFormatOptions<T>	executionHints(Map<String,String> hints) Set these execution hints on scanners created for input splits.
InputFormatBuilder.InputFormatOptions<T>	fetchColumns(Collection<IteratorSetting.Column> fetchColumns) Restricts the columns that will be mapped over for this job for the default input table.
InputFormatBuilder.InputFormatOptions<T>	localIterators(boolean value) Enables the use of the ClientSideIteratorScanner in this job.
InputFormatBuilder.InputFormatOptions<T>	offlineScan(boolean value) Enable reading offline tables.
InputFormatBuilder.InputFormatOptions<T>	ranges(Collection<Range> ranges) Sets the input ranges to scan for the single input table associated with this job.
InputFormatBuilder.InputFormatOptions<T>	samplerConfiguration(SamplerConfiguration samplerConfig) Causes input format to read sample data.
InputFormatBuilder.InputFormatOptions<T>	scanIsolation(boolean value) Enables the use of the IsolatedScanner in this job.

Methods inherited from interface org.apache.accumulo.hadoop.mapreduce.InputFormatBuilder.TableParams

store, table

Method Detail

auths

InputFormatBuilder.InputFormatOptions<T> auths(Authorizations auths)

Sets the Authorizations used to scan. Must be a subset of the user's authorizations. By Default, all of the users auths are set.

Parameters:

auths - the user's authorizations

classLoaderContext

InputFormatBuilder.InputFormatOptions<T> classLoaderContext(String context)

Sets the name of the classloader context on this scanner

Parameters:

context - name of the classloader context

ranges

InputFormatBuilder.InputFormatOptions<T> ranges(Collection<Range> ranges)

Sets the input ranges to scan for the single input table associated with this job.

Parameters:

ranges - the ranges that will be mapped over

See Also:

TableOperations.splitRangeByTablets(String, Range, int)

fetchColumns

InputFormatBuilder.InputFormatOptions<T> fetchColumns(Collection<IteratorSetting.Column> fetchColumns)

Restricts the columns that will be mapped over for this job for the default input table.

Parameters:

fetchColumns - a collection of IteratorSetting.Column 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 all columns.

addIterator

InputFormatBuilder.InputFormatOptions<T> addIterator(IteratorSetting cfg)

Encode an iterator on the single input table for this job. It is safe to call this method multiple times. If an iterator is added with the same name, it will be overridden.

Parameters:

cfg - the configuration of the iterator

executionHints

InputFormatBuilder.InputFormatOptions<T> executionHints(Map<String,String> hints)

Set these execution hints on scanners created for input splits. See ScannerBase.setExecutionHints(java.util.Map)

samplerConfiguration

InputFormatBuilder.InputFormatOptions<T> samplerConfiguration(SamplerConfiguration samplerConfig)

Causes input format to read sample data. If sample data was created using a different configuration or a tables sampler configuration changes while reading data, then the input format will throw an error.

Parameters:

samplerConfig - The sampler configuration that sample must have been created with inorder for reading sample data to succeed.

See Also:

ScannerBase.setSamplerConfiguration(SamplerConfiguration)

autoAdjustRanges

InputFormatBuilder.InputFormatOptions<T> autoAdjustRanges(boolean value)

Disables 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. Disabling has no effect for batch scans at it will always automatically adjust ranges.

By default, this feature is enabled.

See Also:

ranges(Collection)

scanIsolation

InputFormatBuilder.InputFormatOptions<T> scanIsolation(boolean value)

Enables the use of the IsolatedScanner in this job.

By default, this feature is disabled.

localIterators

InputFormatBuilder.InputFormatOptions<T> localIterators(boolean value)

Enables the use of the ClientSideIteratorScanner in this job. 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.

offlineScan

InputFormatBuilder.InputFormatOptions<T> offlineScan(boolean value)

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.

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.

batchScan

InputFormatBuilder.InputFormatOptions<T> batchScan(boolean value)

Enables the use of the BatchScanner in this job. Using this feature will group Ranges by their source tablet, producing an InputSplit per tablet rather than per Range. This batching helps to reduce overhead when querying a large number of small ranges. (ex: when doing quad-tree decomposition for spatial queries)

In order to achieve good locality of InputSplits this option always clips the input Ranges to tablet boundaries. This may result in one input Range contributing to several InputSplits.

Note: calls to autoAdjustRanges(boolean) is ignored when BatchScan is enabled.

This configuration is incompatible with:

• offlineScan(boolean)
• localIterators(boolean)
• scanIsolation(boolean)

By default, this feature is disabled.