org.apache.phoenix.query

Interface ConnectionQueryServices

All Superinterfaces:

MetaDataMutated, QueryServices, SQLCloseable

All Known Implementing Classes:

ChildQueryServices, ConnectionlessQueryServicesImpl, ConnectionQueryServicesImpl, DelegateConnectionQueryServices

public interface ConnectionQueryServices
extends QueryServices, MetaDataMutated

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionQueryServices.Feature

Field Summary

Fields

Modifier and Type	Field and Description
static int	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_FLUSH_ATTRIB, AUTO_UPGRADE_ENABLED, AUTO_UPGRADE_WHITELIST_ATTRIB, CALL_QUEUE_PRODUCER_ATTRIB_NAME, CALL_QUEUE_ROUND_ROBIN_ATTRIB, CLIENT_CACHE_ENCODING, CLIENT_CONNECTION_CACHE_MAX_DURATION_MILLISECONDS, CLIENT_CONNECTION_MAX_ALLOWED_CONNECTIONS, CLOCK_SKEW_INTERVAL_ATTRIB, COLLECT_REQUEST_LEVEL_METRICS, COMMIT_STATS_ASYNC, CONSISTENCY_ATTRIB, COPROCESSOR_PRIORITY_ATTRIB, DATE_FORMAT_ATTRIB, DATE_FORMAT_TIMEZONE_ATTRIB, DEFAULT_COLUMN_ENCODED_BYTES_ATRRIB, DEFAULT_IMMUTABLE_STORAGE_SCHEME_ATTRIB, DEFAULT_KEEP_DELETED_CELLS_ATTRIB, DEFAULT_MULTITENANT_IMMUTABLE_STORAGE_SCHEME_ATTRIB, DEFAULT_STORE_NULLS_ATTRIB, DEFAULT_TABLE_ISTRANSACTIONAL_ATTRIB, DEFAULT_UPDATE_CACHE_FREQUENCY_ATRRIB, DELAY_FOR_SCHEMA_UPDATE_CHECK, DISTINCT_VALUE_COMPRESS_THRESHOLD_ATTRIB, DRIVER_SHUTDOWN_TIMEOUT_MS, DROP_METADATA_ATTRIB, DYNAMIC_JARS_DIR_KEY, ENABLE_SERVER_UPSERT_SELECT, EXPLAIN_CHUNK_COUNT_ATTRIB, EXPLAIN_ROW_COUNT_ATTRIB, EXTRA_JDBC_ARGUMENTS_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, HBASE_CLIENT_SCANNER_TIMEOUT_ATTRIB, HCONNECTION_POOL_CORE_SIZE, HCONNECTION_POOL_MAX_SIZE, HTABLE_MAX_THREADS, IMMUTABLE_ROWS_ATTRIB, INDEX_ASYNC_BUILD_ENABLED, INDEX_FAILURE_BLOCK_WRITE, INDEX_FAILURE_DISABLE_INDEX, INDEX_FAILURE_HANDLING_REBUILD_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_INTERVAL_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_NUMBER_OF_BATCHES_PER_TABLE, INDEX_FAILURE_HANDLING_REBUILD_OVERLAP_BACKWARD_TIME_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_OVERLAP_FORWARD_TIME_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_OVERLAP_TIME_ATTRIB, INDEX_FAILURE_HANDLING_REBUILD_PERIOD, INDEX_FAILURE_THROW_EXCEPTION_ATTRIB, INDEX_HANDLER_COUNT_ATTRIB, INDEX_MUTATE_BATCH_SIZE_THRESHOLD_ATTRIB, INDEX_POPULATION_SLEEP_TIME, INDEX_PRIOIRTY_ATTRIB, INDEX_REBUILD_CLIENT_SCANNER_TIMEOUT_ATTRIB, INDEX_REBUILD_DISABLE_TIMESTAMP_THRESHOLD, INDEX_REBUILD_QUERY_TIMEOUT_ATTRIB, INDEX_REBUILD_RPC_RETRIES_COUNTER, INDEX_REBUILD_RPC_RETRY_PAUSE_TIME, INDEX_REBUILD_RPC_TIMEOUT_ATTRIB, INDEX_REBUILD_TASK_INITIAL_DELAY, IS_NAMESPACE_MAPPING_ENABLED, IS_SYSTEM_TABLE_MAPPED_TO_NAMESPACE, KEEP_ALIVE_MS_ATTRIB, LIMITED_QUERY_SERIAL_THRESHOLD, LOCAL_INDEX_CLIENT_UPGRADE_ATTRIB, MASTER_INFO_PORT_ATTRIB, MAX_CLIENT_METADATA_CACHE_SIZE_ATTRIB, MAX_INDEXES_PER_TABLE, MAX_MEMORY_PERC_ATTRIB, MAX_MEMORY_SIZE_ATTRIB, MAX_MUTATION_SIZE_ATTRIB, MAX_MUTATION_SIZE_BYTES_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, MAX_VERSIONS_TRANSACTIONAL_ATTRIB, METADATA_HANDLER_COUNT_ATTRIB, METADATA_PRIOIRTY_ATTRIB, METADATA_WRITE_RETRIES_NUMBER, METADATA_WRITE_RETRY_PAUSE, MIN_STATS_UPDATE_FREQ_MS_ATTRIB, MUTATE_BATCH_SIZE_ATTRIB, MUTATE_BATCH_SIZE_BYTES_ATTRIB, NUM_RETRIES_FOR_SCHEMA_UPDATE_CHECK, NUMBER_FORMAT_ATTRIB, PHOENIX_QUERY_SERVER_CLUSTER_BASE_PATH, PHOENIX_QUERY_SERVER_LOADBALANCER_ENABLED, PHOENIX_QUERY_SERVER_SERVICE_NAME, PHOENIX_QUERY_SERVER_ZK_ACL_PASSWORD, PHOENIX_QUERY_SERVER_ZK_ACL_USERNAME, QUERY_SERVER_DISABLE_KERBEROS_LOGIN, QUERY_SERVER_DNS_INTERFACE_ATTRIB, QUERY_SERVER_DNS_NAMESERVER_ATTRIB, QUERY_SERVER_ENV_LOGGING_ATTRIB, QUERY_SERVER_ENV_LOGGING_SKIPWORDS_ATTRIB, QUERY_SERVER_HBASE_SECURITY_CONF_ATTRIB, QUERY_SERVER_HTTP_PORT_ATTRIB, QUERY_SERVER_KERBEROS_ALLOWED_REALMS, QUERY_SERVER_KERBEROS_PRINCIPAL_ATTRIB, QUERY_SERVER_KEYTAB_FILENAME_ATTRIB, QUERY_SERVER_META_FACTORY_ATTRIB, QUERY_SERVER_REMOTEUSEREXTRACTOR_PARAM, QUERY_SERVER_SERIALIZATION_ATTRIB, QUERY_SERVER_SPNEGO_AUTH_DISABLED_ATTRIB, QUERY_SERVER_UGI_CACHE_CONCURRENCY, QUERY_SERVER_UGI_CACHE_INITIAL_SIZE, QUERY_SERVER_UGI_CACHE_MAX_SIZE, QUERY_SERVER_WITH_REMOTEUSEREXTRACTOR_ATTRIB, QUEUE_SIZE_ATTRIB, REGIONSERVER_INFO_PORT_ATTRIB, RENEW_LEASE_ENABLED, RENEW_LEASE_THREAD_POOL_SIZE, RENEW_LEASE_THRESHOLD_MILLISECONDS, RETURN_SEQUENCE_VALUES_ATTRIB, ROW_KEY_ORDER_SALTED_TABLE_ATTRIB, RPC_TIMEOUT_ATTRIB, RUN_RENEW_LEASE_FREQUENCY_INTERVAL_MILLISECONDS, RUN_UPDATE_STATS_ASYNC, SCAN_CACHE_SIZE_ATTRIB, SCAN_RESULT_CHUNK_SIZE, SCHEMA_ATTRIB, SEQUENCE_CACHE_SIZE_ATTRIB, SEQUENCE_SALT_BUCKETS_ATTRIB, SPOOL_DIRECTORY, SPOOL_THRESHOLD_BYTES_ATTRIB, STATS_COLLECTION_ENABLED, STATS_ENABLED_ATTRIB, STATS_GUIDEPOST_PER_REGION_ATTRIB, STATS_GUIDEPOST_WIDTH_BYTES_ATTRIB, STATS_MAX_CACHE_SIZE, STATS_SERVER_POOL_SIZE, 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_BATCH_SIZE, TRACING_CUSTOM_ANNOTATION_ATTRIB_PREFIX, TRACING_ENABLED, TRACING_FREQ_ATTRIB, TRACING_PAGE_SIZE_ATTRIB, TRACING_PROBABILITY_THRESHOLD_ATTRIB, TRACING_STATS_TABLE_NAME_ATTRIB, TRACING_THREAD_POOL_SIZE, TRACING_TRACE_BUFFER_SIZE, TRANSACTIONS_ENABLED, UPLOAD_BINARY_DATA_TYPE_ENCODING, USE_BYTE_BASED_REGEX_ATTRIB, USE_INDEXES_ATTRIB, USE_REVERSE_SCAN_ATTRIB, USE_STATS_FOR_PARALLELIZATION, ZOOKEEPER_PORT_ATTRIB, ZOOKEEPER_QUORUM_ATTRIB, ZOOKEEPER_ROOT_NODE_ATTRIB

Method Summary

Methods

Modifier and Type	Method and Description
MetaDataProtocol.MetaDataMutationResult	addColumn(List<Mutation> tableMetaData, PTable table, Map<String,List<Pair<String,Object>>> properties, Set<String> colFamiliesForPColumnsToBeAdded, List<PColumn> columns)
void	addConnection(PhoenixConnection connection)
long	clearCache()
void	clearTableFromCache(byte[] tenantId, byte[] schemaName, byte[] tableName, long clientTS)
void	clearTableRegionCache(byte[] tableName)
PhoenixConnection	connect(String url, Properties info)
MetaDataProtocol.MetaDataMutationResult	createFunction(List<Mutation> functionData, PFunction function, boolean temporary)
MetaDataProtocol.MetaDataMutationResult	createSchema(List<Mutation> schemaMutations, String schemaName)
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[] tableName, PTableType tableType, Map<String,Object> tableProps, List<Pair<byte[],Map<String,Object>>> families, byte[][] splits, boolean isNamespaceMapped, boolean allocateIndexId)
long	currentSequenceValue(SequenceKey sequenceKey, long timestamp)
MetaDataProtocol.MetaDataMutationResult	dropColumn(List<Mutation> tableMetadata, PTableType tableType)
MetaDataProtocol.MetaDataMutationResult	dropFunction(List<Mutation> tableMetadata, boolean ifExists)
MetaDataProtocol.MetaDataMutationResult	dropSchema(List<Mutation> schemaMetaData, String schemaName)
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.
org.apache.hadoop.conf.Configuration	getConfiguration()
MetaDataProtocol.MetaDataMutationResult	getFunctions(PName tenantId, List<Pair<byte[],Long>> functionNameAndTimeStampPairs, long clientTimestamp)
KeyValueBuilder	getKeyValueBuilder()
int	getLowestClusterHBaseVersion()
long	getRenewLeaseThresholdMilliSeconds()
MetaDataProtocol.MetaDataMutationResult	getSchema(String schemaName, long clientTimestamp)
int	getSequenceSaltBuckets()
HTableInterface	getTable(byte[] tableName) Get an HTableInterface by the given name.
MetaDataProtocol.MetaDataMutationResult	getTable(PName tenantId, byte[] schemaName, byte[] tableName, long tableTimestamp, long clientTimetamp)
HTableDescriptor	getTableDescriptor(byte[] tableName)
HRegionLocation	getTableRegionLocation(byte[] tableName, byte[] row)
GuidePostsInfo	getTableStats(GuidePostsKey key)
String	getUserName()
boolean	hasIndexWALCodec()
void	incrementSequences(List<SequenceAllocation> sequenceAllocation, long timestamp, long[] values, SQLException[] exceptions)
void	init(String url, Properties props)
void	invalidateStats(GuidePostsKey key) Removes cache GuidePostsInfo for the table with the given name.
boolean	isRenewingLeasesEnabled()
boolean	isUpgradeRequired()
void	removeConnection(PhoenixConnection connection)
void	returnSequences(List<SequenceKey> sequenceKeys, long timestamp, SQLException[] exceptions)
boolean	supportsFeature(ConnectionQueryServices.Feature feature)
MutationState	updateData(MutationPlan plan)
MetaDataProtocol.MetaDataMutationResult	updateIndexState(List<Mutation> tableMetadata, String parentTableName)
void	upgradeSystemTables(String url, Properties props)
void	validateSequences(List<SequenceAllocation> sequenceAllocations, long timestamp, long[] values, SQLException[] exceptions, Sequence.ValueOp action)

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

getExecutor, getMemoryManager, getOptimizer, getProps

Methods inherited from interface org.apache.phoenix.util.SQLCloseable

close

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

addFunction, addSchema, addTable, removeColumn, removeFunction, removeSchema, removeTable, updateResolvedTimestamp

Field Detail

INITIAL_META_DATA_TABLE_CAPACITY

static final int INITIAL_META_DATA_TABLE_CAPACITY

See Also:

Constant Field Values

Method Detail

getChildQueryServices

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

Parameters:

tenantId - the organization ID

Returns:

the child QueryService

getTable

HTableInterface getTable(byte[] tableName)
                         throws SQLException

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

Parameters:

tableName - the name of the HTable

Returns:

the HTableInterface

Throws:

SQLException

getTableDescriptor

HTableDescriptor getTableDescriptor(byte[] tableName)
                                    throws SQLException

Throws:

SQLException

getTableRegionLocation

HRegionLocation getTableRegionLocation(byte[] tableName,
                                     byte[] row)
                                       throws SQLException

Throws:

SQLException

getAllTableRegions

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

Throws:

SQLException

connect

PhoenixConnection connect(String url,
                        Properties info)
                          throws SQLException

Throws:

SQLException

getTable

MetaDataProtocol.MetaDataMutationResult getTable(PName tenantId,
                                               byte[] schemaName,
                                               byte[] tableName,
                                               long tableTimestamp,
                                               long clientTimetamp)
                                                 throws SQLException

Throws:

SQLException

getFunctions

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

Throws:

SQLException

createTable

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

Throws:

SQLException

dropTable

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

Throws:

SQLException

dropFunction

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

Throws:

SQLException

addColumn

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

Throws:

SQLException

dropColumn

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

Throws:

SQLException

updateIndexState

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

Throws:

SQLException

updateData

MutationState updateData(MutationPlan plan)
                         throws SQLException

Throws:

SQLException

init

void init(String url,
        Properties props)
          throws SQLException

Throws:

SQLException

getLowestClusterHBaseVersion

int getLowestClusterHBaseVersion()

getAdmin

HBaseAdmin getAdmin()
                    throws SQLException

Throws:

SQLException

clearTableRegionCache

void clearTableRegionCache(byte[] tableName)
                           throws SQLException

Throws:

SQLException

hasIndexWALCodec

boolean hasIndexWALCodec()

createSequence

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

Throws:

SQLException

dropSequence

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

Throws:

SQLException

validateSequences

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

Throws:

SQLException

incrementSequences

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

Throws:

SQLException

currentSequenceValue

long currentSequenceValue(SequenceKey sequenceKey,
                        long timestamp)
                          throws SQLException

Throws:

SQLException

returnSequences

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

Throws:

SQLException

createFunction

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

Throws:

SQLException

addConnection

void addConnection(PhoenixConnection connection)
                   throws SQLException

Throws:

SQLException

removeConnection

void removeConnection(PhoenixConnection connection)
                      throws SQLException

Throws:

SQLException

getKeyValueBuilder

KeyValueBuilder getKeyValueBuilder()

Returns:

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

supportsFeature

boolean supportsFeature(ConnectionQueryServices.Feature feature)

getUserName

String getUserName()

clearTableFromCache

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

Throws:

SQLException

getTableStats

GuidePostsInfo getTableStats(GuidePostsKey key)
                             throws SQLException

Throws:

SQLException

invalidateStats

void invalidateStats(GuidePostsKey key)

Removes cache GuidePostsInfo for the table with the given name. If no cached guideposts are present, this does nothing.

Parameters:

tableName - The table to remove stats for

clearCache

long clearCache()
                throws SQLException

Throws:

SQLException

getSequenceSaltBuckets

int getSequenceSaltBuckets()

getRenewLeaseThresholdMilliSeconds

long getRenewLeaseThresholdMilliSeconds()

isRenewingLeasesEnabled

boolean isRenewingLeasesEnabled()

createSchema

MetaDataProtocol.MetaDataMutationResult createSchema(List<Mutation> schemaMutations,
                                                   String schemaName)
                                                     throws SQLException

Throws:

SQLException

getSchema

MetaDataProtocol.MetaDataMutationResult getSchema(String schemaName,
                                                long clientTimestamp)
                                                  throws SQLException

Throws:

SQLException

dropSchema

MetaDataProtocol.MetaDataMutationResult dropSchema(List<Mutation> schemaMetaData,
                                                 String schemaName)
                                                   throws SQLException

Throws:

SQLException

isUpgradeRequired

boolean isUpgradeRequired()

upgradeSystemTables

void upgradeSystemTables(String url,
                       Properties props)
                         throws SQLException

Throws:

SQLException

getConfiguration

org.apache.hadoop.conf.Configuration getConfiguration()