org.apache.phoenix.query

Class ConnectionQueryServicesImpl

java.lang.Object

org.apache.phoenix.query.DelegateQueryServices

org.apache.phoenix.query.ConnectionQueryServicesImpl

All Implemented Interfaces:

ConnectionQueryServices, MetaDataMutated, QueryServices, SQLCloseable

public class ConnectionQueryServicesImpl
extends DelegateQueryServices
implements ConnectionQueryServices

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.phoenix.query.ConnectionQueryServices

ConnectionQueryServices.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.hadoop.conf.Configuration	config

Fields inherited from interface org.apache.phoenix.query.ConnectionQueryServices

INITIAL_META_DATA_TABLE_CAPACITY

Fields inherited from interface org.apache.phoenix.query.QueryServices

ALLOW_LOCAL_INDEX_ATTRIB, ALLOW_ONLINE_TABLE_SCHEMA_UPDATE, ALLOW_USER_DEFINED_FUNCTIONS_ATTRIB, ALLOW_VIEWS_ADD_NEW_CF_BASE_TABLE, AUTO_COMMIT_ATTRIB, AUTO_UPGRADE_WHITELIST_ATTRIB, CALL_QUEUE_PRODUCER_ATTRIB_NAME, CALL_QUEUE_ROUND_ROBIN_ATTRIB, CLOCK_SKEW_INTERVAL_ATTRIB, COLLECT_REQUEST_LEVEL_METRICS, COPROCESSOR_PRIORITY_ATTRIB, DATE_FORMAT_ATTRIB, DATE_FORMAT_TIMEZONE_ATTRIB, DEFAULT_KEEP_DELETED_CELLS_ATTRIB, DEFAULT_STORE_NULLS_ATTRIB, DELAY_FOR_SCHEMA_UPDATE_CHECK, DISTINCT_VALUE_COMPRESS_THRESHOLD_ATTRIB, DROP_METADATA_ATTRIB, DYNAMIC_JARS_DIR_KEY, EXPLAIN_CHUNK_COUNT_ATTRIB, FORCE_ROW_KEY_ORDER_ATTRIB, GLOBAL_METRICS_ENABLED, GROUPBY_ESTIMATED_DISTINCT_VALUES_ATTRIB, GROUPBY_MAX_CACHE_SIZE_ATTRIB, GROUPBY_SPILL_FILES_ATTRIB, GROUPBY_SPILLABLE_ATTRIB, HBASE_CLIENT_KEYTAB, HBASE_CLIENT_PRINCIPAL, IMMUTABLE_ROWS_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_INTERVAL_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_OVERLAP_TIME_ATTRIB, INDEX_HANDLER_COUNT_ATTRIB, INDEX_MAX_FILESIZE_PERC_ATTRIB, INDEX_MUTATE_BATCH_SIZE_THRESHOLD_ATTRIB, INDEX_PRIOIRTY_ATTRIB, KEEP_ALIVE_MS_ATTRIB, MASTER_INFO_PORT_ATTRIB, MAX_CLIENT_METADATA_CACHE_SIZE_ATTRIB, MAX_MEMORY_PERC_ATTRIB, MAX_MEMORY_SIZE_ATTRIB, MAX_MEMORY_WAIT_MS_ATTRIB, MAX_MUTATION_SIZE_ATTRIB, MAX_SERVER_CACHE_SIZE_ATTRIB, MAX_SERVER_CACHE_TIME_TO_LIVE_MS_ATTRIB, MAX_SERVER_METADATA_CACHE_SIZE_ATTRIB, MAX_SERVER_METADATA_CACHE_TIME_TO_LIVE_MS_ATTRIB, MAX_SPOOL_TO_DISK_BYTES_ATTRIB, MAX_TENANT_MEMORY_PERC_ATTRIB, METADATA_HANDLER_COUNT_ATTRIB, METADATA_PRIOIRTY_ATTRIB, MIN_STATS_UPDATE_FREQ_MS_ATTRIB, MUTATE_BATCH_SIZE_ATTRIB, NUM_RETRIES_FOR_SCHEMA_UPDATE_CHECK, NUMBER_FORMAT_ATTRIB, QUEUE_SIZE_ATTRIB, REGIONSERVER_INFO_PORT_ATTRIB, REGIONSERVER_LEASE_PERIOD_ATTRIB, ROW_KEY_ORDER_SALTED_TABLE_ATTRIB, RPC_TIMEOUT_ATTRIB, SCAN_CACHE_SIZE_ATTRIB, SCAN_RESULT_CHUNK_SIZE, SEQUENCE_CACHE_SIZE_ATTRIB, SEQUENCE_SALT_BUCKETS_ATTRIB, SPOOL_DIRECTORY, SPOOL_THRESHOLD_BYTES_ATTRIB, STATS_GUIDEPOST_PER_REGION_ATTRIB, STATS_GUIDEPOST_WIDTH_BYTES_ATTRIB, STATS_UPDATE_FREQ_MS_ATTRIB, STATS_USE_CURRENT_TIME_ATTRIB, THREAD_POOL_SIZE_ATTRIB, THREAD_TIMEOUT_MS_ATTRIB, TIME_FORMAT_ATTRIB, TIMESTAMP_FORMAT_ATTRIB, TRACING_CUSTOM_ANNOTATION_ATTRIB_PREFIX, TRACING_FREQ_ATTRIB, TRACING_PAGE_SIZE_ATTRIB, TRACING_PROBABILITY_THRESHOLD_ATTRIB, TRACING_STATS_TABLE_NAME_ATTRIB, USE_BYTE_BASED_REGEX_ATTRIB, USE_INDEXES_ATTRIB, USE_REVERSE_SCAN_ATTRIB, ZOOKEEPER_PORT_ATTRIB, ZOOKEEPER_QUARUM_ATTRIB, ZOOKEEPER_ROOT_NODE_ATTRIB

Constructor Summary

Constructors

Constructor and Description
ConnectionQueryServicesImpl(QueryServices services, PhoenixEmbeddedDriver.ConnectionInfo connectionInfo, Properties info) Construct a ConnectionQueryServicesImpl that represents a connection to an HBase cluster.

Method Summary

Methods

Modifier and Type	Method and Description
MetaDataProtocol.MetaDataMutationResult	addColumn(List<Mutation> tableMetaData, PTable table, Map<String,List<Pair<String,Object>>> stmtProperties, Set<String> colFamiliesForPColumnsToBeAdded)
PMetaData	addColumn(PName tenantId, String tableName, List<PColumn> columns, long tableTimeStamp, long tableSeqNum, boolean isImmutableRows, boolean isWalDisabled, boolean isMultitenant, boolean storeNulls)
void	addConnection(PhoenixConnection connection)
PMetaData	addFunction(PFunction function)
PMetaData	addTable(PTable table)
void	clearCache() Clears the Phoenix meta data cache on each region server
void	clearTableFromCache(byte[] tenantId, byte[] schemaName, byte[] tableName, long clientTS)
void	clearTableRegionCache(byte[] tableName)
void	close() Closes the underlying connection to zookeeper.
PhoenixConnection	connect(String url, Properties info)
MetaDataProtocol.MetaDataMutationResult	createFunction(List<Mutation> functionData, PFunction function, boolean temporary)
long	createSequence(String tenantId, String schemaName, String sequenceName, long startWith, long incrementBy, long cacheSize, long minValue, long maxValue, boolean cycle, long timestamp)
MetaDataProtocol.MetaDataMutationResult	createTable(List<Mutation> tableMetaData, byte[] physicalTableName, PTableType tableType, Map<String,Object> tableProps, List<Pair<byte[],Map<String,Object>>> families, byte[][] splits)
long	currentSequenceValue(SequenceKey sequenceKey, long timestamp) Gets the current sequence value
MetaDataProtocol.MetaDataMutationResult	dropColumn(List<Mutation> tableMetaData, PTableType tableType)
MetaDataProtocol.MetaDataMutationResult	dropFunction(List<Mutation> functionData, boolean ifExists)
long	dropSequence(String tenantId, String schemaName, String sequenceName, long timestamp)
MetaDataProtocol.MetaDataMutationResult	dropTable(List<Mutation> tableMetaData, PTableType tableType, boolean cascade)
HBaseAdmin	getAdmin()
List<HRegionLocation>	getAllTableRegions(byte[] tableName)
ConnectionQueryServices	getChildQueryServices(ImmutableBytesWritable tenantId) Get (and create if necessary) a child QueryService for a given tenantId.
MetaDataProtocol.MetaDataMutationResult	getFunctions(PName tenantId, List<Pair<byte[],Long>> functions, long clientTimestamp)
KeyValueBuilder	getKeyValueBuilder()
int	getLowestClusterHBaseVersion()
ReadOnlyProps	getProps() Get the properties from the HBase configuration in a read-only structure that avoids any synchronization
int	getSequenceSaltBuckets()
HTableInterface	getTable(byte[] tableName) Get an HTableInterface by the given name.
MetaDataProtocol.MetaDataMutationResult	getTable(PName tenantId, byte[] schemaBytes, byte[] tableBytes, long tableTimestamp, long clientTimestamp)
HTableDescriptor	getTableDescriptor(byte[] tableName)
PTableStats	getTableStats(byte[] physicalName, long clientTimeStamp)
String	getUserName()
boolean	hasInvalidIndexConfiguration()
void	incrementSequences(List<SequenceAllocation> sequenceAllocations, long timestamp, long[] values, SQLException[] exceptions) Increment any of the set of sequences that need more values.
void	init(String url, Properties props)
protected ConnectionQueryServices	newChildQueryService()
PMetaData	removeColumn(PName tenantId, String tableName, List<PColumn> columnsToRemove, long tableTimeStamp, long tableSeqNum)
void	removeConnection(PhoenixConnection connection)
PMetaData	removeFunction(PName tenantId, String function, long functionTimeStamp)
PMetaData	removeTable(PName tenantId, String tableName, String parentTableName, long tableTimeStamp)
void	returnSequences(List<SequenceKey> keys, long timestamp, SQLException[] exceptions)
boolean	supportsFeature(ConnectionQueryServices.Feature feature)
MutationState	updateData(MutationPlan plan)
MetaDataProtocol.MetaDataMutationResult	updateIndexState(List<Mutation> tableMetaData, String parentTableName)
void	validateSequences(List<SequenceAllocation> sequenceAllocations, long timestamp, long[] values, SQLException[] exceptions, Sequence.ValueOp action) Verifies that sequences exist and reserves values for them if reserveValues is true

Methods inherited from class org.apache.phoenix.query.DelegateQueryServices

getDelegate, getExecutor, getMemoryManager, getOptimizer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.phoenix.query.QueryServices

getExecutor, getMemoryManager, getOptimizer

Field Detail

config

protected final org.apache.hadoop.conf.Configuration config

Constructor Detail

ConnectionQueryServicesImpl

public ConnectionQueryServicesImpl(QueryServices services,
                           PhoenixEmbeddedDriver.ConnectionInfo connectionInfo,
                           Properties info)

Construct a ConnectionQueryServicesImpl that represents a connection to an HBase cluster.

Parameters:

services - base services from where we derive our default configuration

connectionInfo - to provide connection information

info - hbase configuration properties

Throws:

SQLException

Method Detail

getTable

public HTableInterface getTable(byte[] tableName)
                         throws SQLException

Description copied from interface: ConnectionQueryServices

Get an HTableInterface by the given name. It is the callers responsibility to close the returned HTableInterface.

Specified by:

getTable in interface ConnectionQueryServices

Parameters:

tableName - the name of the HTable

Returns:

the HTableInterface

Throws:

SQLException

getTableDescriptor

public HTableDescriptor getTableDescriptor(byte[] tableName)
                                    throws SQLException

Specified by:

getTableDescriptor in interface ConnectionQueryServices

Throws:

SQLException

getProps

public ReadOnlyProps getProps()

Description copied from interface: QueryServices

Get the properties from the HBase configuration in a read-only structure that avoids any synchronization

Specified by:

getProps in interface QueryServices

Overrides:

getProps in class DelegateQueryServices

close

public void close()
           throws SQLException

Closes the underlying connection to zookeeper. The QueryServices may not be used after that point. When a Connection is closed, this is not called, since these instances are pooled by the Driver. Instead, the Driver should call this if the QueryServices is ever removed from the pool

Specified by:

close in interface SQLCloseable

Overrides:

close in class DelegateQueryServices

Throws:

SQLException

newChildQueryService

protected ConnectionQueryServices newChildQueryService()

getChildQueryServices

public ConnectionQueryServices getChildQueryServices(ImmutableBytesWritable tenantId)

Get (and create if necessary) a child QueryService for a given tenantId. The QueryService will be cached for the lifetime of the parent QueryService

Specified by:

getChildQueryServices in interface ConnectionQueryServices

Parameters:

tenantId - the tenant ID

Returns:

the child QueryService

clearTableRegionCache

public void clearTableRegionCache(byte[] tableName)
                           throws SQLException

Specified by:

clearTableRegionCache in interface ConnectionQueryServices

Throws:

SQLException

getAllTableRegions

public List<HRegionLocation> getAllTableRegions(byte[] tableName)
                                         throws SQLException

Specified by:

getAllTableRegions in interface ConnectionQueryServices

Throws:

SQLException

addTable

public PMetaData addTable(PTable table)
                   throws SQLException

Specified by:

addTable in interface MetaDataMutated

Throws:

SQLException

addColumn

public PMetaData addColumn(PName tenantId,
                  String tableName,
                  List<PColumn> columns,
                  long tableTimeStamp,
                  long tableSeqNum,
                  boolean isImmutableRows,
                  boolean isWalDisabled,
                  boolean isMultitenant,
                  boolean storeNulls)
                    throws SQLException

Specified by:

addColumn in interface MetaDataMutated

Throws:

SQLException

removeTable

public PMetaData removeTable(PName tenantId,
                    String tableName,
                    String parentTableName,
                    long tableTimeStamp)
                      throws SQLException

Specified by:

removeTable in interface MetaDataMutated

Throws:

SQLException

removeColumn

public PMetaData removeColumn(PName tenantId,
                     String tableName,
                     List<PColumn> columnsToRemove,
                     long tableTimeStamp,
                     long tableSeqNum)
                       throws SQLException

Specified by:

removeColumn in interface MetaDataMutated

Throws:

SQLException

connect

public PhoenixConnection connect(String url,
                        Properties info)
                          throws SQLException

Specified by:

connect in interface ConnectionQueryServices

Throws:

SQLException

createTable

public MetaDataProtocol.MetaDataMutationResult createTable(List<Mutation> tableMetaData,
                                                  byte[] physicalTableName,
                                                  PTableType tableType,
                                                  Map<String,Object> tableProps,
                                                  List<Pair<byte[],Map<String,Object>>> families,
                                                  byte[][] splits)
                                                    throws SQLException

Specified by:

createTable in interface ConnectionQueryServices

Throws:

SQLException

getTable

public MetaDataProtocol.MetaDataMutationResult getTable(PName tenantId,
                                               byte[] schemaBytes,
                                               byte[] tableBytes,
                                               long tableTimestamp,
                                               long clientTimestamp)
                                                 throws SQLException

Specified by:

getTable in interface ConnectionQueryServices

Throws:

SQLException

dropTable

public MetaDataProtocol.MetaDataMutationResult dropTable(List<Mutation> tableMetaData,
                                                PTableType tableType,
                                                boolean cascade)
                                                  throws SQLException

Specified by:

dropTable in interface ConnectionQueryServices

Throws:

SQLException

dropFunction

public MetaDataProtocol.MetaDataMutationResult dropFunction(List<Mutation> functionData,
                                                   boolean ifExists)
                                                     throws SQLException

Specified by:

dropFunction in interface ConnectionQueryServices

Throws:

SQLException

addColumn

public MetaDataProtocol.MetaDataMutationResult addColumn(List<Mutation> tableMetaData,
                                                PTable table,
                                                Map<String,List<Pair<String,Object>>> stmtProperties,
                                                Set<String> colFamiliesForPColumnsToBeAdded)
                                                  throws SQLException

Specified by:

addColumn in interface ConnectionQueryServices

Throws:

SQLException

dropColumn

public MetaDataProtocol.MetaDataMutationResult dropColumn(List<Mutation> tableMetaData,
                                                 PTableType tableType)
                                                   throws SQLException

Specified by:

dropColumn in interface ConnectionQueryServices

Throws:

SQLException

init

public void init(String url,
        Properties props)
          throws SQLException

Specified by:

init in interface ConnectionQueryServices

Throws:

SQLException

updateData

public MutationState updateData(MutationPlan plan)
                         throws SQLException

Specified by:

updateData in interface ConnectionQueryServices

Throws:

SQLException

getLowestClusterHBaseVersion

public int getLowestClusterHBaseVersion()

Specified by:

getLowestClusterHBaseVersion in interface ConnectionQueryServices

hasInvalidIndexConfiguration

public boolean hasInvalidIndexConfiguration()

Specified by:

hasInvalidIndexConfiguration in interface ConnectionQueryServices

clearCache

public void clearCache()
                throws SQLException

Clears the Phoenix meta data cache on each region server

Specified by:

clearCache in interface ConnectionQueryServices

Throws:

SQLException

getAdmin

public HBaseAdmin getAdmin()
                    throws SQLException

Specified by:

getAdmin in interface ConnectionQueryServices

Throws:

SQLException

updateIndexState

public MetaDataProtocol.MetaDataMutationResult updateIndexState(List<Mutation> tableMetaData,
                                                       String parentTableName)
                                                         throws SQLException

Specified by:

updateIndexState in interface ConnectionQueryServices

Throws:

SQLException

createSequence

public long createSequence(String tenantId,
                  String schemaName,
                  String sequenceName,
                  long startWith,
                  long incrementBy,
                  long cacheSize,
                  long minValue,
                  long maxValue,
                  boolean cycle,
                  long timestamp)
                    throws SQLException

Specified by:

createSequence in interface ConnectionQueryServices

Throws:

SQLException

dropSequence

public long dropSequence(String tenantId,
                String schemaName,
                String sequenceName,
                long timestamp)
                  throws SQLException

Specified by:

dropSequence in interface ConnectionQueryServices

Throws:

SQLException

currentSequenceValue

public long currentSequenceValue(SequenceKey sequenceKey,
                        long timestamp)
                          throws SQLException

Gets the current sequence value

Specified by:

currentSequenceValue in interface ConnectionQueryServices

Throws:

SQLException - if cached sequence cannot be found

validateSequences

public void validateSequences(List<SequenceAllocation> sequenceAllocations,
                     long timestamp,
                     long[] values,
                     SQLException[] exceptions,
                     Sequence.ValueOp action)
                       throws SQLException

Verifies that sequences exist and reserves values for them if reserveValues is true

Specified by:

validateSequences in interface ConnectionQueryServices

Throws:

SQLException

incrementSequences

public void incrementSequences(List<SequenceAllocation> sequenceAllocations,
                      long timestamp,
                      long[] values,
                      SQLException[] exceptions)
                        throws SQLException

Increment any of the set of sequences that need more values. These are the sequences that are asking for the next value within a given statement. The returned sequences are the ones that were not found because they were deleted by another client.

Specified by:

incrementSequences in interface ConnectionQueryServices

Parameters:

sequenceKeys - sorted list of sequence kyes

timestamp -

Throws:

SQLException - if any of the sequences cannot be found

clearTableFromCache

public void clearTableFromCache(byte[] tenantId,
                       byte[] schemaName,
                       byte[] tableName,
                       long clientTS)
                         throws SQLException

Specified by:

clearTableFromCache in interface ConnectionQueryServices

Throws:

SQLException

returnSequences

public void returnSequences(List<SequenceKey> keys,
                   long timestamp,
                   SQLException[] exceptions)
                     throws SQLException

Specified by:

returnSequences in interface ConnectionQueryServices

Throws:

SQLException

addConnection

public void addConnection(PhoenixConnection connection)
                   throws SQLException

Specified by:

addConnection in interface ConnectionQueryServices

Throws:

SQLException

removeConnection

public void removeConnection(PhoenixConnection connection)
                      throws SQLException

Specified by:

removeConnection in interface ConnectionQueryServices

Throws:

SQLException

getKeyValueBuilder

public KeyValueBuilder getKeyValueBuilder()

Specified by:

getKeyValueBuilder in interface ConnectionQueryServices

Returns:

the KeyValueBuilder that is valid for the locally installed version of HBase.

supportsFeature

public boolean supportsFeature(ConnectionQueryServices.Feature feature)

Specified by:

supportsFeature in interface ConnectionQueryServices

getUserName

public String getUserName()

Specified by:

getUserName in interface ConnectionQueryServices

getTableStats

public PTableStats getTableStats(byte[] physicalName,
                        long clientTimeStamp)
                          throws SQLException

Specified by:

getTableStats in interface ConnectionQueryServices

Throws:

SQLException

getSequenceSaltBuckets

public int getSequenceSaltBuckets()

Specified by:

getSequenceSaltBuckets in interface ConnectionQueryServices

addFunction

public PMetaData addFunction(PFunction function)
                      throws SQLException

Specified by:

addFunction in interface MetaDataMutated

Throws:

SQLException

removeFunction

public PMetaData removeFunction(PName tenantId,
                       String function,
                       long functionTimeStamp)
                         throws SQLException

Specified by:

removeFunction in interface MetaDataMutated

Throws:

SQLException

getFunctions

public MetaDataProtocol.MetaDataMutationResult getFunctions(PName tenantId,
                                                   List<Pair<byte[],Long>> functions,
                                                   long clientTimestamp)
                                                     throws SQLException

Specified by:

getFunctions in interface ConnectionQueryServices

Throws:

SQLException

createFunction

public MetaDataProtocol.MetaDataMutationResult createFunction(List<Mutation> functionData,
                                                     PFunction function,
                                                     boolean temporary)
                                                       throws SQLException

Specified by:

createFunction in interface ConnectionQueryServices

Throws:

SQLException