TableInputFormat (Oracle NoSQL Database API)

java.lang.Object
- org.apache.hadoop.mapreduce.InputFormat<K,V>
- - oracle.kv.hadoop.table.TableInputFormatBase<PrimaryKey,Row>
  - - oracle.kv.hadoop.table.TableInputFormat

```
public class TableInputFormat
extends TableInputFormatBase<PrimaryKey,Row>
```
A Hadoop InputFormat class for reading data from an Oracle NoSQL Database. Map/reduce keys and values are returned as PrimaryKey and Row objects respectively.
For information on the parameters that may be passed to this class, refer to the javadoc for the parent class of this class; TableInputFormatBase.
A simple example demonstrating the Oracle NoSQL DB Hadoop oracle.kv.hadoop.table.TableInputFormat class can be found in the KVHOME/example/table/hadoop directory. It demonstrates how, in a MapReduce job, to read records from an Oracle NoSQL Database that were written using Table API. The javadoc for that program describes the simple Map/Reduce processing as well as how to invoke the program in Hadoop.

Since:

3.1

Nested Class Summary
- Nested classes/interfaces inherited from class oracle.kv.hadoop.table.TableInputFormatBase
  TableInputFormatBase.TopologyLocatorWrapper

Field Summary
- Fields inherited from class oracle.kv.hadoop.table.TableInputFormatBase
  topologyLocator, USER_SECURITY_DIR

Constructor Summary

Constructors
Constructor Description

TableInputFormat()
No-arg constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RecordReader<PrimaryKey,Row>`	`createRecordReader(InputSplit split, TaskAttemptContext context)`	Returns the RecordReader for the given InputSplit.
`void`	`setTopologyLocator(TableInputFormatBase.TopologyLocatorWrapper newTopologyLocator)`	Special setter method that used by tests that wish to mock the wrapper for the TopologyLocator employed by the getSplits method of this class to connect to a store to retrieve the splits.

Methods inherited from class oracle.kv.hadoop.table.TableInputFormatBase
clearLocalKVSecurity, setBatchSize, setConsistency, setDirection, setFieldRangeProperty, setKVHadoopHosts, setKVHelperHosts, setKVSecurity, setKVStoreName, setMaxBatches, setMaxRequests, setPrimaryKeyProperty, setQueryInfo, setTableName, setTimeout, setTimeoutUnit

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TableInputFormat
```
public TableInputFormat()
```
    No-arg constructor.
- Method Detail
  - createRecordReader
```
public RecordReader<PrimaryKey,Row> createRecordReader(InputSplit split,
                                                             TaskAttemptContext context)
                                                      throws java.io.IOException,
                                                             java.lang.InterruptedException
```
    Returns the RecordReader for the given InputSplit.
    
    Specified by:
    
    createRecordReader in class InputFormat<PrimaryKey,Row>
    
    Throws:
    
    java.io.IOException
    
    java.lang.InterruptedException
  - setTopologyLocator
```
public void setTopologyLocator(TableInputFormatBase.TopologyLocatorWrapper newTopologyLocator)
```
    Special setter method that used by tests that wish to mock the wrapper for the TopologyLocator employed by the getSplits method of this class to connect to a store to retrieve the splits. This method is used by the tests to tell the TableInputFormat to use the given TopologyLocator mocked by the test rather than the non-mocked TopologyLocator created by the no-arg constructor of this class.