org.apache.hadoop.hbase.client.tableindexed
Class IndexedTable

java.lang.Object
  extended by org.apache.hadoop.hbase.client.HTable
      extended by org.apache.hadoop.hbase.client.transactional.TransactionalTable
          extended by org.apache.hadoop.hbase.client.tableindexed.IndexedTable

public class IndexedTable
extends TransactionalTable

HTable extended with indexed support.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.client.transactional.TransactionalTable
TransactionalTable.TransactionalClientScanner
 
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.client.HTable
HTable.ClientScanner, HTable.OldClientScanner
 
Field Summary
static byte[] INDEX_BASE_ROW
           
static byte[] INDEX_BASE_ROW_COLUMN
           
static byte[] INDEX_COL_FAMILY
           
static byte[] INDEX_COL_FAMILY_NAME
           
 
Fields inherited from class org.apache.hadoop.hbase.client.HTable
scannerCaching, scannerTimeout
 
Constructor Summary
IndexedTable(HBaseConfiguration conf, byte[] tableName)
           
 
Method Summary
 ResultScanner getIndexedScanner(String indexId, byte[] indexStartRow, byte[] indexStopRow, byte[][] indexColumns, Filter indexFilter, byte[][] baseColumns)
          Open up an indexed scanner.
 IndexedTableDescriptor getIndexedTableDescriptor()
           
 
Methods inherited from class org.apache.hadoop.hbase.client.transactional.TransactionalTable
delete, get, getScanner, put
 
Methods inherited from class org.apache.hadoop.hbase.client.HTable
checkAndPut, checkAndSave, close, commit, commit, commit, delete, delete, deleteAll, deleteAll, deleteAll, deleteAll, deleteAll, deleteAll, deleteAll, deleteAll, deleteAll, deleteAllByRegex, deleteAllByRegex, deleteAllByRegex, deleteAllByRegex, deleteFamily, deleteFamily, deleteFamily, deleteFamily, deleteFamily, deleteFamilyByRegex, deleteFamilyByRegex, deleteFamilyByRegex, deleteFamilyByRegex, deleteFamilyByRegex, exists, exists, exists, exists, exists, flushCommits, get, get, get, get, get, get, get, getClosestRowBefore, getConnection, getEndKeys, getRegionLocation, getRegionLocation, getRegionsInfo, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRow, getRowOrBefore, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScanner, getScannerCaching, getStartEndKeys, getStartKeys, getTableDescriptor, getTableName, getWriteBufferSize, incrementColumnValue, incrementColumnValue, isAutoFlush, isTableEnabled, isTableEnabled, isTableEnabled, isTableEnabled, lockRow, put, put, setAutoFlush, setScannerCaching, setWriteBufferSize, unlockRow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INDEX_COL_FAMILY_NAME

public static final byte[] INDEX_COL_FAMILY_NAME

INDEX_COL_FAMILY

public static final byte[] INDEX_COL_FAMILY

INDEX_BASE_ROW

public static final byte[] INDEX_BASE_ROW

INDEX_BASE_ROW_COLUMN

public static final byte[] INDEX_BASE_ROW_COLUMN
Constructor Detail

IndexedTable

public IndexedTable(HBaseConfiguration conf,
                    byte[] tableName)
             throws IOException
Throws:
IOException
Method Detail

getIndexedTableDescriptor

public IndexedTableDescriptor getIndexedTableDescriptor()

getIndexedScanner

public ResultScanner getIndexedScanner(String indexId,
                                       byte[] indexStartRow,
                                       byte[] indexStopRow,
                                       byte[][] indexColumns,
                                       Filter indexFilter,
                                       byte[][] baseColumns)
                                throws IOException,
                                       IndexNotFoundException
Open up an indexed scanner. Results will come back in the indexed order, but will contain RowResults from the original table.

Parameters:
indexId - the id of the index to use
indexStartRow - (created from the IndexKeyGenerator)
indexStopRow - (created from the IndexKeyGenerator)
indexColumns - in the index table
indexFilter - filter to run on the index'ed table. This can only use columns that have been added to the index.
baseColumns - from the original table
Returns:
scanner
Throws:
IOException
IndexNotFoundException


Copyright © 2009 The Apache Software Foundation