org.apache.phoenix.schema

Class DelegateTable

java.lang.Object

org.apache.phoenix.schema.DelegateTable

All Implemented Interfaces:

PMetaDataEntity, PTable

public class DelegateTable
extends Object
implements PTable

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.phoenix.schema.PTable

PTable.IndexType, PTable.LinkType, PTable.ViewType

Field Summary

Fields inherited from interface org.apache.phoenix.schema.PTable

DEFAULT_DISABLE_WAL, INITIAL_SEQ_NUM, IS_IMMUTABLE_ROWS_PROP_NAME

Constructor Summary

Constructors

Constructor and Description
DelegateTable(PTable delegate)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBaseColumnCount()
Integer	getBucketNum() Return the number of buckets used by this table for salting.
PColumn	getColumn(String name) Get the column with the given string name.
List<PColumnFamily>	getColumnFamilies()
PColumnFamily	getColumnFamily(byte[] family) Get the column family with the given name
PColumnFamily	getColumnFamily(String family)
List<PColumn>	getColumns() Get all columns ordered by position.
PName	getDefaultFamilyName()
int	getEstimatedSize()
List<PTable>	getIndexes() Return the list of indexes defined on this table.
IndexMaintainer	getIndexMaintainer(PTable dataTable, PhoenixConnection connection)
void	getIndexMaintainers(ImmutableBytesWritable ptr, PhoenixConnection connection)
PIndexState	getIndexState() For a table of index type, return the state of the table.
PTable.IndexType	getIndexType()
PTableKey	getKey()
PName	getName()
PName	getParentName() Gets the full name of the data table for an index table.
PName	getParentSchemaName() Gets the schema name of the data table for an index table.
PName	getParentTableName() Gets the table name of the data table for an index table.
PName	getPhysicalName()
List<PName>	getPhysicalNames() For a view, return the name of table in Phoenix that physically stores data.
PColumn	getPKColumn(String name) Get the PK column with the given name.
List<PColumn>	getPKColumns() Get the PK columns ordered by position.
PName	getPKName()
RowKeySchema	getRowKeySchema()
PName	getSchemaName()
long	getSequenceNumber()
boolean	getStoreNulls()
PName	getTableName()
PTableStats	getTableStats()
PName	getTenantId()
long	getTimeStamp()
PTableType	getType()
Short	getViewIndexId()
String	getViewStatement()
PTable.ViewType	getViewType()
boolean	isImmutableRows()
boolean	isMultiTenant()
boolean	isWALDisabled()
int	newKey(ImmutableBytesWritable key, byte[][] values) Formulates a row key using the values provided.
PRow	newRow(KeyValueBuilder builder, ImmutableBytesWritable key, byte[]... values) Creates a new row for the PK values (from PTable.newKey(ImmutableBytesWritable, byte[][]) and the optional key values specified using values.
PRow	newRow(KeyValueBuilder builder, long ts, ImmutableBytesWritable key, byte[]... values) Creates a new row at the specified timestamp using the key for the PK values (from PTable.newKey(ImmutableBytesWritable, byte[][]) and the optional key values specified using values.
boolean	rowKeyOrderOptimizable() Determines whether or not we may optimize out an ORDER BY or do a GROUP BY in-place when the optimizer tells us it's possible.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegateTable

public DelegateTable(PTable delegate)

Method Detail

getTimeStamp

public long getTimeStamp()

Specified by:

getTimeStamp in interface PTable

getSequenceNumber

public long getSequenceNumber()

Specified by:

getSequenceNumber in interface PTable

getName

public PName getName()

Specified by:

getName in interface PTable

Returns:

table name

getSchemaName

public PName getSchemaName()

Specified by:

getSchemaName in interface PTable

getTableName

public PName getTableName()

Specified by:

getTableName in interface PTable

getTenantId

public PName getTenantId()

Specified by:

getTenantId in interface PTable

getType

public PTableType getType()

Specified by:

getType in interface PTable

Returns:

the table type

getPKName

public PName getPKName()

Specified by:

getPKName in interface PTable

getPKColumns

public List<PColumn> getPKColumns()

Description copied from interface: PTable

Get the PK columns ordered by position.

Specified by:

getPKColumns in interface PTable

Returns:

a list of the PK columns

getColumns

public List<PColumn> getColumns()

Description copied from interface: PTable

Get all columns ordered by position.

Specified by:

getColumns in interface PTable

Returns:

a list of all columns

getColumnFamilies

public List<PColumnFamily> getColumnFamilies()

Specified by:

getColumnFamilies in interface PTable

Returns:

A list of the column families of this table ordered by position.

getColumnFamily

public PColumnFamily getColumnFamily(byte[] family)
                              throws ColumnFamilyNotFoundException

Description copied from interface: PTable

Get the column family with the given name

Specified by:

getColumnFamily in interface PTable

Parameters:

family - the column family name

Returns:

the PColumnFamily with the given name

Throws:

ColumnFamilyNotFoundException - if the column family cannot be found

getColumnFamily

public PColumnFamily getColumnFamily(String family)
                              throws ColumnFamilyNotFoundException

Specified by:

getColumnFamily in interface PTable

Throws:

ColumnFamilyNotFoundException

getColumn

public PColumn getColumn(String name)
                  throws ColumnNotFoundException,
                         AmbiguousColumnException

Description copied from interface: PTable

Get the column with the given string name.

Specified by:

getColumn in interface PTable

Parameters:

name - the column name

Returns:

the PColumn with the given name

Throws:

ColumnNotFoundException - if no column with the given name can be found

AmbiguousColumnException - if multiple columns are found with the given name

getPKColumn

public PColumn getPKColumn(String name)
                    throws ColumnNotFoundException

Description copied from interface: PTable

Get the PK column with the given name.

Specified by:

getPKColumn in interface PTable

Parameters:

name - the column name

Returns:

the PColumn with the given name

Throws:

ColumnNotFoundException - if no PK column with the given name can be found

newRow

public PRow newRow(KeyValueBuilder builder,
          long ts,
          ImmutableBytesWritable key,
          byte[]... values)

Description copied from interface: PTable

Creates a new row at the specified timestamp using the key for the PK values (from PTable.newKey(ImmutableBytesWritable, byte[][]) and the optional key values specified using values.

Specified by:

newRow in interface PTable

ts - the timestamp that the key value will have when committed

key - the row key of the key value

values - the optional key values

Returns:

the new row. Use PRow.toRowMutations() to generate the Row to send to the HBase server.

newRow

public PRow newRow(KeyValueBuilder builder,
          ImmutableBytesWritable key,
          byte[]... values)

Description copied from interface: PTable

Creates a new row for the PK values (from PTable.newKey(ImmutableBytesWritable, byte[][]) and the optional key values specified using values. The timestamp of the key value will be set by the HBase server.

Specified by:

newRow in interface PTable

key - the row key of the key value

values - the optional key values

Returns:

the new row. Use PRow.toRowMutations() to generate the row to send to the HBase server.

newKey

public int newKey(ImmutableBytesWritable key,
         byte[][] values)

Description copied from interface: PTable

Formulates a row key using the values provided. The values must be in the same order as PTable.getPKColumns().

Specified by:

newKey in interface PTable

Parameters:

key - bytes pointer that will be filled in with the row key

values - the PK column values

Returns:

the number of values that were used from values to set the row key

getRowKeySchema

public RowKeySchema getRowKeySchema()

Specified by:

getRowKeySchema in interface PTable

getBucketNum

public Integer getBucketNum()

Description copied from interface: PTable

Return the number of buckets used by this table for salting. If the table does not use salting, returns null.

Specified by:

getBucketNum in interface PTable

Returns:

number of buckets used by this table for salting, or null if salting is not used.

getIndexes

public List<PTable> getIndexes()

Description copied from interface: PTable

Return the list of indexes defined on this table.

Specified by:

getIndexes in interface PTable

Returns:

the list of indexes.

getIndexState

public PIndexState getIndexState()

Description copied from interface: PTable

For a table of index type, return the state of the table.

Specified by:

getIndexState in interface PTable

Returns:

the state of the index.

getParentName

public PName getParentName()

Description copied from interface: PTable

Gets the full name of the data table for an index table.

Specified by:

getParentName in interface PTable

Returns:

the name of the data table that this index is on or null if not an index.

getParentTableName

public PName getParentTableName()

Description copied from interface: PTable

Gets the table name of the data table for an index table.

Specified by:

getParentTableName in interface PTable

Returns:

the table name of the data table that this index is on or null if not an index.

getPhysicalNames

public List<PName> getPhysicalNames()

Description copied from interface: PTable

For a view, return the name of table in Phoenix that physically stores data. Currently a single name, but when views are allowed over multiple tables, will become multi-valued.

Specified by:

getPhysicalNames in interface PTable

Returns:

the name of the physical table storing the data.

getPhysicalName

public PName getPhysicalName()

Specified by:

getPhysicalName in interface PTable

isImmutableRows

public boolean isImmutableRows()

Specified by:

isImmutableRows in interface PTable

getIndexMaintainers

public void getIndexMaintainers(ImmutableBytesWritable ptr,
                       PhoenixConnection connection)

Specified by:

getIndexMaintainers in interface PTable

getIndexMaintainer

public IndexMaintainer getIndexMaintainer(PTable dataTable,
                                 PhoenixConnection connection)

Specified by:

getIndexMaintainer in interface PTable

getDefaultFamilyName

public PName getDefaultFamilyName()

Specified by:

getDefaultFamilyName in interface PTable

isWALDisabled

public boolean isWALDisabled()

Specified by:

isWALDisabled in interface PTable

isMultiTenant

public boolean isMultiTenant()

Specified by:

isMultiTenant in interface PTable

getStoreNulls

public boolean getStoreNulls()

Specified by:

getStoreNulls in interface PTable

getViewType

public PTable.ViewType getViewType()

Specified by:

getViewType in interface PTable

getViewStatement

public String getViewStatement()

Specified by:

getViewStatement in interface PTable

getViewIndexId

public Short getViewIndexId()

Specified by:

getViewIndexId in interface PTable

getKey

public PTableKey getKey()

Specified by:

getKey in interface PTable

getEstimatedSize

public int getEstimatedSize()

Specified by:

getEstimatedSize in interface PMetaDataEntity

getIndexType

public PTable.IndexType getIndexType()

Specified by:

getIndexType in interface PTable

getTableStats

public PTableStats getTableStats()

Specified by:

getTableStats in interface PTable

getParentSchemaName

public PName getParentSchemaName()

Description copied from interface: PTable

Gets the schema name of the data table for an index table.

Specified by:

getParentSchemaName in interface PTable

Returns:

the schema name of the data table that this index is on or null if not an index.

getBaseColumnCount

public int getBaseColumnCount()

Specified by:

getBaseColumnCount in interface PTable

rowKeyOrderOptimizable

public boolean rowKeyOrderOptimizable()

Description copied from interface: PTable

Determines whether or not we may optimize out an ORDER BY or do a GROUP BY in-place when the optimizer tells us it's possible. This is due to PHOENIX-2067 and only applicable for tables using DESC primary key column(s) which have not been upgraded.

Specified by:

rowKeyOrderOptimizable in interface PTable

Returns:

true if optimizations row key order optimizations are possible