org.apache.phoenix.schema

Interface PTable

All Superinterfaces:

PMetaDataEntity

All Known Implementing Classes:

DelegateTable, PTableImpl

public interface PTable
extends PMetaDataEntity

Definition of a Phoenix table

Since:

0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PTable.ColumnValueEncoderDecoderSupplier
static class	PTable.EncodedCQCounter Class to help track encoded column qualifier counters per column family.
static class	PTable.ImmutableStorageScheme
static class	PTable.IndexType
static class	PTable.LinkType
static interface	PTable.QualifierEncoderDecoder
static class	PTable.QualifierEncodingScheme
static class	PTable.ViewType

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DISABLE_WAL
static long	INITIAL_SEQ_NUM
static String	IS_IMMUTABLE_ROWS_PROP_NAME

Method Summary

Modifier and Type	Method and Description
String	getAutoPartitionSeqName()
int	getBaseColumnCount()
Integer	getBucketNum() Return the number of buckets used by this table for salting.
List<PColumnFamily>	getColumnFamilies()
PColumnFamily	getColumnFamily(byte[] family) Get the column family with the given name
PColumnFamily	getColumnFamily(String family)
PColumn	getColumnForColumnName(String name) Get the column with the given string name.
PColumn	getColumnForColumnQualifier(byte[] cf, byte[] cq) Get the column with the given column qualifier.
List<PColumn>	getColumns() Get all columns ordered by position.
PName	getDefaultFamilyName()
PTable.EncodedCQCounter	getEncodedCQCounter()
PTable.QualifierEncodingScheme	getEncodingScheme()
PTable.ImmutableStorageScheme	getImmutableStorageScheme()
long	getIndexDisableTimestamp()
List<PTable>	getIndexes() Return the list of indexes defined on this table.
IndexMaintainer	getIndexMaintainer(PTable dataTable, PhoenixConnection connection)
boolean	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()
PName	getParentSchemaName()
PName	getParentTableName()
PName	getPhysicalName() For a view, return the name of table in HBase that physically stores data.
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()
int	getRowTimestampColPos()
PName	getSchemaName()
long	getSequenceNumber()
boolean	getStoreNulls()
PName	getTableName()
PName	getTenantId()
long	getTimeStamp()
TransactionFactory.Provider	getTransactionProvider()
PTableType	getType()
long	getUpdateCacheFrequency()
Short	getViewIndexId()
String	getViewStatement()
PTable.ViewType	getViewType()
boolean	isAppendOnlySchema()
boolean	isImmutableRows()
boolean	isMultiTenant()
boolean	isNamespaceMapped()
boolean	isTransactional()
boolean	isWALDisabled()
int	newKey(ImmutableBytesWritable key, byte[][] values) Formulates a row key using the values provided.
PRow	newRow(KeyValueBuilder builder, ImmutableBytesWritable key, boolean hasOnDupKey, byte[]... values) Creates a new row for the PK values (from newKey(ImmutableBytesWritable, byte[][]) and the optional key values specified using values.
PRow	newRow(KeyValueBuilder builder, long ts, ImmutableBytesWritable key, boolean hasOnDupKey, byte[]... values) Creates a new row at the specified timestamp using the key for the PK values (from 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.
Boolean	useStatsForParallelization()

Methods inherited from interface org.apache.phoenix.schema.PMetaDataEntity

getEstimatedSize

Field Detail

INITIAL_SEQ_NUM

static final long INITIAL_SEQ_NUM

See Also:

Constant Field Values

IS_IMMUTABLE_ROWS_PROP_NAME

static final String IS_IMMUTABLE_ROWS_PROP_NAME

See Also:

Constant Field Values

DEFAULT_DISABLE_WAL

static final boolean DEFAULT_DISABLE_WAL

See Also:

Constant Field Values

Method Detail

getTimeStamp

long getTimeStamp()

getSequenceNumber

long getSequenceNumber()

getIndexDisableTimestamp

long getIndexDisableTimestamp()

getName

PName getName()

Returns:

table name

getSchemaName

PName getSchemaName()

getTableName

PName getTableName()

getTenantId

PName getTenantId()

getType

PTableType getType()

Returns:

the table type

getPKName

PName getPKName()

getPKColumns

List<PColumn> getPKColumns()

Get the PK columns ordered by position.

Returns:

a list of the PK columns

getColumns

List<PColumn> getColumns()

Get all columns ordered by position.

Returns:

a list of all columns

getColumnFamilies

List<PColumnFamily> getColumnFamilies()

Returns:

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

getColumnFamily

PColumnFamily getColumnFamily(byte[] family)
                       throws ColumnFamilyNotFoundException

Get the column family with the given name

Parameters:

family - the column family name

Returns:

the PColumnFamily with the given name

Throws:

ColumnFamilyNotFoundException - if the column family cannot be found

getColumnFamily

PColumnFamily getColumnFamily(String family)
                       throws ColumnFamilyNotFoundException

Throws:

ColumnFamilyNotFoundException

getColumnForColumnName

PColumn getColumnForColumnName(String name)
                        throws ColumnNotFoundException,
                               AmbiguousColumnException

Get the column with the given string name.

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

getColumnForColumnQualifier

PColumn getColumnForColumnQualifier(byte[] cf,
                                    byte[] cq)
                             throws ColumnNotFoundException,
                                    AmbiguousColumnException

Get the column with the given column qualifier.

Parameters:

column - qualifier bytes

Returns:

the PColumn with the given column qualifier

Throws:

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

AmbiguousColumnException - if multiple columns are found with the given column qualifier

getPKColumn

PColumn getPKColumn(String name)
             throws ColumnNotFoundException

Get the PK column with the given name.

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

ColumnNotFoundException

newRow

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

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

Parameters:

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

key - the row key of the key value

hasOnDupKey - true if row has an ON DUPLICATE KEY clause and false otherwise.

values - the optional key values

Returns:

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

Throws:

ConstraintViolationException - if row data violates schema constraint

newRow

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

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

Parameters:

key - the row key of the key value

hasOnDupKey - true if row has an ON DUPLICATE KEY clause and false otherwise.

values - the optional key values

Returns:

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

Throws:

ConstraintViolationException - if row data violates schema constraint

newKey

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

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

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

RowKeySchema getRowKeySchema()

getBucketNum

Integer getBucketNum()

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

Returns:

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

getIndexes

List<PTable> getIndexes()

Return the list of indexes defined on this table.

Returns:

the list of indexes.

getIndexState

PIndexState getIndexState()

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

Returns:

the state of the index.

getParentName

PName getParentName()

Returns:

the full name of the parent view for a view or data table for an index table or null if this is not a view or index table. Also returns null for a view of a data table (use @getPhysicalName for this case)

getParentTableName

PName getParentTableName()

Returns:

the table name of the parent view for a view or data table for an index table or null if this is not a view or index table. Also returns null for a view of a data table (use @getPhysicalTableName for this case)

getParentSchemaName

PName getParentSchemaName()

Returns:

the schema name of the parent view for a view or data table for an index table or null if this is not a view or index table. Also returns null for view of a data table (use @getPhysicalSchemaName for this case)

getPhysicalNames

List<PName> getPhysicalNames()

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.

Returns:

the name of the physical table storing the data.

getPhysicalName

PName getPhysicalName()

For a view, return the name of table in HBase that physically stores data.

Returns:

the name of the physical HBase table storing the data.

isImmutableRows

boolean isImmutableRows()

getIndexMaintainers

boolean getIndexMaintainers(ImmutableBytesWritable ptr,
                            PhoenixConnection connection)

getIndexMaintainer

IndexMaintainer getIndexMaintainer(PTable dataTable,
                                   PhoenixConnection connection)

getDefaultFamilyName

PName getDefaultFamilyName()

isWALDisabled

boolean isWALDisabled()

isMultiTenant

boolean isMultiTenant()

getStoreNulls

boolean getStoreNulls()

isTransactional

boolean isTransactional()

getTransactionProvider

TransactionFactory.Provider getTransactionProvider()

getViewType

PTable.ViewType getViewType()

getViewStatement

String getViewStatement()

getViewIndexId

Short getViewIndexId()

getKey

PTableKey getKey()

getIndexType

PTable.IndexType getIndexType()

getBaseColumnCount

int getBaseColumnCount()

rowKeyOrderOptimizable

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. This is due to PHOENIX-2067 and only applicable for tables using DESC primary key column(s) which have not been upgraded.

Returns:

true if optimizations row key order optimizations are possible

getRowTimestampColPos

int getRowTimestampColPos()

Returns:

Position of the column with PColumn.isRowTimestamp() as true. -1 if there is no such column.

getUpdateCacheFrequency

long getUpdateCacheFrequency()

isNamespaceMapped

boolean isNamespaceMapped()

getAutoPartitionSeqName

String getAutoPartitionSeqName()

Returns:

The sequence name used to get the unique identifier for views that are automatically partitioned.

isAppendOnlySchema

boolean isAppendOnlySchema()

Returns:

true if the you can only add (and never delete) columns to the table, you are also not allowed to delete the table

getImmutableStorageScheme

PTable.ImmutableStorageScheme getImmutableStorageScheme()

getEncodingScheme

PTable.QualifierEncodingScheme getEncodingScheme()

getEncodedCQCounter

PTable.EncodedCQCounter getEncodedCQCounter()

useStatsForParallelization

Boolean useStatsForParallelization()