PhoenixRuntime (Phoenix Core 4.14.3-HBase-1.4 API)

java.lang.Object
- org.apache.phoenix.util.PhoenixRuntime

```
public class PhoenixRuntime
extends Object
```
Collection of non JDBC compliant utility methods

Since:

0.1

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATION_ATTRIB_PREFIX` Use this connection property prefix for annotations that you want to show up in traces and log lines emitted by Phoenix.
`static String`	`AUTO_COMMIT_ATTRIB` Use this connection property to explicitly enable or disable auto-commit on a new connection.
`static String`	`BUILD_INDEX_AT_ATTRIB` Internal connection property to force an index to be built at a given time stamp.
`static String[]`	`CONNECTION_PROPERTIES` All Phoenix specific connection properties TODO: use enum instead
`static String`	`CONNECTIONLESS` Use this as the zookeeper quorum name to have a connection-less connection.
`static String`	`CONSISTENCY_ATTRIB` Use this connection property to explicitly set read consistency level on a new connection.
`static String`	`CURRENT_SCN_ATTRIB` Use this connection property to control HBase timestamps by specifying your own long timestamp value at connection time.
`static String`	`EMBEDDED_JDBC_PROTOCOL` Deprecated.
`static String`	`EXPLAIN_PLAN_ESTIMATE_INFO_TS_COLUMN` Use this column name on the row returned by explain plan result set to get timestamp at which the estimate of number or bytes/rows was collected
`static String`	`EXPLAIN_PLAN_ESTIMATED_BYTES_READ_COLUMN` Use this column name on the row returned by explain plan result set to get estimate of number of bytes read.
`static String`	`EXPLAIN_PLAN_ESTIMATED_ROWS_READ_COLUMN` Use this column name on the row returned by explain plan result set to get estimate of number of rows read.
`static String`	`JDBC_PROTOCOL` Root for the JDBC URL that the Phoenix accepts accepts.
`static char`	`JDBC_PROTOCOL_SEPARATOR`
`static char`	`JDBC_PROTOCOL_TERMINATOR`
`static String`	`JDBC_THIN_PROTOCOL` Root for the JDBC URL used by the thin driver.
`static String`	`NO_UPGRADE_ATTRIB` Use this connection property to prevent an upgrade from occurring when connecting to a new server version.
`static String`	`PHOENIX_TEST_DRIVER_URL_PARAM`
`static String`	`REQUEST_METRIC_ATTRIB` Use this connection property to explicitly enable or disable request level metric collection.
`static String`	`SCHEMA_ATTRIB`
`static String`	`TENANT_ID_ATTRIB` Use this connection property to help with fairness of resource allocation for the client and server.
`static String`	`UPSERT_BATCH_SIZE_ATTRIB` Use this connection property to control the number of rows that are batched together on an UPSERT INTO table1...
`static String`	`UPSERT_BATCH_SIZE_BYTES_ATTRIB` Use this connection property to control the number of bytes that are batched together on an UPSERT INTO table1...

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`areGlobalClientMetricsBeingCollected()`
`static Object[]`	`decodeColumnValues(Connection conn, String fullTableName, byte[] value, List<Pair<String,String>> columns)`
`static Object[]`	`decodeValues(Connection conn, String fullTableName, byte[] value, List<Pair<String,String>> columns)` Deprecated.
`static byte[]`	`encodeColumnValues(Connection conn, String fullTableName, Object[] values, List<Pair<String,String>> columns)`
`static byte[]`	`encodeValues(Connection conn, String fullTableName, Object[] values, List<Pair<String,String>> columns)` Deprecated.
`static int`	`executeStatements(Connection conn, Reader reader, List<Object> binds)` Runs a series of semicolon-terminated SQL statements using the connection provided, returning the number of SQL statements executed.
`static List<ColumnInfo>`	`generateColumnInfo(Connection conn, String tableName, List<String> columns)` Get list of ColumnInfos that contain Column Name and its associated PDataType for an import.
`static String`	`getArraySqlTypeName(Integer maxLength, Integer scale, PDataType arrayType)`
`static ColumnInfo`	`getColumnInfo(PColumn pColumn)` Constructs a column info for the supplied pColumn
`static ColumnInfo`	`getColumnInfo(PTable table, String columnName)` Returns the column info for the given column for the given table.
`static long`	`getCurrentScn(ReadOnlyProps props)`
`static Expression`	`getFirstPKColumnExpression(Connection conn, String fullTableName)` Get expression that may be used to evaluate to the value of the first column of a given row in a Phoenix table.
`static Collection<GlobalMetric>`	`getGlobalPhoenixClientMetrics()` Exposes the various internal phoenix metrics collected at the client JVM level.
`static int`	`getLimit(QueryPlan plan)`
`static QueryPlan`	`getOptimizedQueryPlan(PreparedStatement stmt)` Returns the opitmized query plan used by phoenix for executing the sql.
`static Map<MetricType,Long>`	`getOverAllReadRequestMetricInfo(ResultSet rs)` Method to expose the overall metrics associated with executing a query via phoenix.
`static Map<String,Long>`	`getOverAllReadRequestMetrics(ResultSet rs)` Deprecated.
`static void`	`getPkColsDataTypesForSql(List<Pair<String,String>> columns, List<String> dataTypes, QueryPlan plan, Connection conn, boolean forDataTable)` Deprecated.
`static List<Pair<String,String>>`	`getPkColsForSql(Connection conn, QueryPlan plan)` Get the column family, column name pairs that make up the row key of the table that will be queried.
`static void`	`getPkColsForSql(List<Pair<String,String>> columns, QueryPlan plan, Connection conn, boolean forDataTable)` Deprecated.
`static Map<String,Map<MetricType,Long>>`	`getReadMetricInfoForMutationsSinceLastReset(Connection conn)` Method to expose the read metrics associated with executing a dml statement.
`static Map<String,Map<String,Long>>`	`getReadMetricsForMutationsSinceLastReset(Connection conn)` Deprecated.
`static Map<String,Map<MetricType,Long>>`	`getRequestReadMetricInfo(ResultSet rs)` Method to expose the metrics associated with performing reads using the passed result set.
`static Map<String,Map<String,Long>>`	`getRequestReadMetrics(ResultSet rs)` Deprecated.
`static String`	`getSqlTypeName(PColumn pCol)`
`static String`	`getSqlTypeName(PDataType dataType, Integer maxLength, Integer scale)`
`static PTable`	`getTable(Connection conn, String name)` Returns the table if it is found in the connection metadata cache.
`static PTable`	`getTableNoCache(Connection conn, String name)`
`static Expression`	`getTenantIdExpression(Connection conn, String fullTableName)` Get expression that may be used to evaluate the tenant ID of a given row in a multi-tenant table.
`static List<KeyValue>`	`getUncommittedData(Connection conn)` Deprecated.
`static Iterator<Pair<byte[],List<KeyValue>>>`	`getUncommittedDataIterator(Connection conn)` Get the list of uncommitted KeyValues for the connection.
`static Iterator<Pair<byte[],List<KeyValue>>>`	`getUncommittedDataIterator(Connection conn, boolean includeMutableIndexes)` Get the list of uncommitted KeyValues for the connection.
`static long`	`getWallClockTimeFromCellTimeStamp(long tsOfCell)` Use this utility function to ensure that a timestamp is in milliseconds across transactional and non transactional tables.
`static Map<String,Map<MetricType,Long>>`	`getWriteMetricInfoForMutationsSinceLastReset(Connection conn)` Method to expose the metrics associated with sending over mutations to HBase.
`static Map<String,Map<String,Long>>`	`getWriteMetricsForMutationsSinceLastReset(Connection conn)` Deprecated.
`static boolean`	`hasOrderBy(QueryPlan plan)` Whether or not the query plan has any order by expressions.
`static void`	`main(String[] args)` Provides a mechanism to run SQL scripts against, where the arguments are: 1) connection URL string 2) one or more paths to either SQL scripts or CSV files If a CurrentSCN property is set on the connection URL, then it is incremented between processing, with each file being processed by a new connection at the increment timestamp value.
`static void`	`resetMetrics(Connection conn)` Reset the mutation and reads-for-mutations metrics collected in the connection.
`static void`	`resetMetrics(ResultSet rs)` Reset the read metrics collected in the result set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JDBC_PROTOCOL
```
public static final String JDBC_PROTOCOL
```
    Root for the JDBC URL that the Phoenix accepts accepts.
    
    See Also:
    
    Constant Field Values
  - JDBC_THIN_PROTOCOL
```
public static final String JDBC_THIN_PROTOCOL
```
    Root for the JDBC URL used by the thin driver. Duplicated here to avoid dependencies between modules.
    
    See Also:
    
    Constant Field Values
  - JDBC_PROTOCOL_TERMINATOR
```
public static final char JDBC_PROTOCOL_TERMINATOR
```
    See Also:
    
    Constant Field Values
  - JDBC_PROTOCOL_SEPARATOR
```
public static final char JDBC_PROTOCOL_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - EMBEDDED_JDBC_PROTOCOL
```
@Deprecated
public static final String EMBEDDED_JDBC_PROTOCOL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CURRENT_SCN_ATTRIB
```
public static final String CURRENT_SCN_ATTRIB
```
    Use this connection property to control HBase timestamps by specifying your own long timestamp value at connection time. Specifying this property will force the connection to be read only - no DML or DDL will be allowed.
    
    See Also:
    
    Constant Field Values
  - BUILD_INDEX_AT_ATTRIB
```
public static final String BUILD_INDEX_AT_ATTRIB
```
    Internal connection property to force an index to be built at a given time stamp.
    
    See Also:
    
    Constant Field Values
  - TENANT_ID_ATTRIB
```
public static final String TENANT_ID_ATTRIB
```
    Use this connection property to help with fairness of resource allocation for the client and server. The value of the attribute determines the bucket used to rollup resource usage for a particular tenant/organization. Each tenant may only use a percentage of total resources, governed by the QueryServices configuration properties
    
    See Also:
    
    Constant Field Values
  - NO_UPGRADE_ATTRIB
```
public static final String NO_UPGRADE_ATTRIB
```
    Use this connection property to prevent an upgrade from occurring when connecting to a new server version.
    
    See Also:
    
    Constant Field Values
  - UPSERT_BATCH_SIZE_ATTRIB
```
public static final String UPSERT_BATCH_SIZE_ATTRIB
```
    Use this connection property to control the number of rows that are batched together on an UPSERT INTO table1... SELECT ... FROM table2. It's only used when autoCommit is true and your source table is different than your target table or your SELECT statement has a GROUP BY clause.
    
    See Also:
    
    Constant Field Values
  - UPSERT_BATCH_SIZE_BYTES_ATTRIB
```
public static final String UPSERT_BATCH_SIZE_BYTES_ATTRIB
```
    Use this connection property to control the number of bytes that are batched together on an UPSERT INTO table1... SELECT ... FROM table2. It's only used when autoCommit is true and your source table is different than your target table or your SELECT statement has a GROUP BY clause. Overrides the value of UpsertBatchSize.
    
    See Also:
    
    Constant Field Values
  - AUTO_COMMIT_ATTRIB
```
public static final String AUTO_COMMIT_ATTRIB
```
    Use this connection property to explicitly enable or disable auto-commit on a new connection.
    
    See Also:
    
    Constant Field Values
  - CONSISTENCY_ATTRIB
```
public static final String CONSISTENCY_ATTRIB
```
    Use this connection property to explicitly set read consistency level on a new connection.
    
    See Also:
    
    Constant Field Values
  - REQUEST_METRIC_ATTRIB
```
public static final String REQUEST_METRIC_ATTRIB
```
    Use this connection property to explicitly enable or disable request level metric collection.
    
    See Also:
    
    Constant Field Values
  - EXPLAIN_PLAN_ESTIMATED_BYTES_READ_COLUMN
```
public static final String EXPLAIN_PLAN_ESTIMATED_BYTES_READ_COLUMN
```
    Use this column name on the row returned by explain plan result set to get estimate of number of bytes read.
    
    See Also:
    
    Constant Field Values
  - EXPLAIN_PLAN_ESTIMATED_ROWS_READ_COLUMN
```
public static final String EXPLAIN_PLAN_ESTIMATED_ROWS_READ_COLUMN
```
    Use this column name on the row returned by explain plan result set to get estimate of number of rows read.
    
    See Also:
    
    Constant Field Values
  - EXPLAIN_PLAN_ESTIMATE_INFO_TS_COLUMN
```
public static final String EXPLAIN_PLAN_ESTIMATE_INFO_TS_COLUMN
```
    Use this column name on the row returned by explain plan result set to get timestamp at which the estimate of number or bytes/rows was collected
    
    See Also:
    
    Constant Field Values
  - CONNECTION_PROPERTIES
```
public static final String[] CONNECTION_PROPERTIES
```
    All Phoenix specific connection properties TODO: use enum instead
  - CONNECTIONLESS
```
public static final String CONNECTIONLESS
```
    Use this as the zookeeper quorum name to have a connection-less connection. This enables Phoenix-compatible HFiles to be created in a map/reduce job by creating tables, upserting data into them, and getting the uncommitted state through getUncommittedData(Connection)
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_ATTRIB_PREFIX
```
public static final String ANNOTATION_ATTRIB_PREFIX
```
    Use this connection property prefix for annotations that you want to show up in traces and log lines emitted by Phoenix. This is useful for annotating connections with information available on the client (e.g. user or session identifier) and having these annotation automatically passed into log lines and traces by Phoenix.
    
    See Also:
    
    Constant Field Values
  - PHOENIX_TEST_DRIVER_URL_PARAM
```
public static final String PHOENIX_TEST_DRIVER_URL_PARAM
```
    See Also:
    
    Constant Field Values
  - SCHEMA_ATTRIB
```
public static final String SCHEMA_ATTRIB
```
    See Also:
    
    Constant Field Values
- Method Detail
  - main
```
public static void main(String[] args)
```
    Provides a mechanism to run SQL scripts against, where the arguments are: 1) connection URL string 2) one or more paths to either SQL scripts or CSV files If a CurrentSCN property is set on the connection URL, then it is incremented between processing, with each file being processed by a new connection at the increment timestamp value.
  - executeStatements
```
public static int executeStatements(Connection conn,
                                    Reader reader,
                                    List<Object> binds)
                             throws IOException,
                                    SQLException
```
    Runs a series of semicolon-terminated SQL statements using the connection provided, returning the number of SQL statements executed. Note that if the connection has specified an SCN through the CURRENT_SCN_ATTRIB connection property, then the timestamp is bumped up by one after each statement execution.
    
    Parameters:
    
    conn - an open JDBC connection
    
    reader - a reader for semicolumn separated SQL statements
    
    binds - the binds for all statements
    
    Returns:
    
    the number of SQL statements that were executed
    
    Throws:
    
    IOException
    
    SQLException
  - getUncommittedData
```
@Deprecated
public static List<KeyValue> getUncommittedData(Connection conn)
                                                     throws SQLException
```
    Deprecated.
    
    Get the list of uncommitted KeyValues for the connection. Currently used to write an Phoenix-compliant HFile from a map/reduce job.
    
    Parameters:
    
    conn - an open JDBC connection
    
    Returns:
    
    the list of HBase mutations for uncommitted data
    
    Throws:
    
    SQLException
  - getUncommittedDataIterator
```
public static Iterator<Pair<byte[],List<KeyValue>>> getUncommittedDataIterator(Connection conn)
                                                                        throws SQLException
```
    Get the list of uncommitted KeyValues for the connection. Currently used to write an Phoenix-compliant HFile from a map/reduce job.
    
    Parameters:
    
    conn - an open JDBC connection
    
    Returns:
    
    the list of HBase mutations for uncommitted data
    
    Throws:
    
    SQLException
  - getUncommittedDataIterator
```
public static Iterator<Pair<byte[],List<KeyValue>>> getUncommittedDataIterator(Connection conn,
                                                                               boolean includeMutableIndexes)
                                                                        throws SQLException
```
    Get the list of uncommitted KeyValues for the connection. Currently used to write an Phoenix-compliant HFile from a map/reduce job.
    
    Parameters:
    
    conn - an open JDBC connection
    
    Returns:
    
    the list of HBase mutations for uncommitted data
    
    Throws:
    
    SQLException
  - getTableNoCache
```
public static PTable getTableNoCache(Connection conn,
                                     String name)
                              throws SQLException
```
    Throws:
    
    SQLException
  - getTable
```
public static PTable getTable(Connection conn,
                              String name)
                       throws SQLException
```
    Returns the table if it is found in the connection metadata cache. If the metadata of this table has changed since it was put in the cache these changes will not necessarily be reflected in the returned table. If the table is not found, makes a call to the server to fetch the latest metadata of the table. This is different than how a table is resolved when it is referenced from a query (a call is made to the server to fetch the latest metadata of the table depending on the UPDATE_CACHE_FREQUENCY property) See https://issues.apache.org/jira/browse/PHOENIX-4475
    
    Parameters:
    
    conn -
    
    name - requires a pre-normalized table name or a pre-normalized schema and table name
    
    Returns:
    
    Throws:
    
    SQLException
  - generateColumnInfo
```
public static List<ColumnInfo> generateColumnInfo(Connection conn,
                                                  String tableName,
                                                  List<String> columns)
                                           throws SQLException
```
    Get list of ColumnInfos that contain Column Name and its associated PDataType for an import. The supplied list of columns can be null -- if it is non-null, it represents a user-supplied list of columns to be imported.
    
    Parameters:
    
    conn - Phoenix connection from which metadata will be read
    
    tableName - Phoenix table name whose columns are to be checked. Can include a schema name
    
    columns - user-supplied list of import columns, can be null
    
    Throws:
    
    SQLException
  - getColumnInfo
```
public static ColumnInfo getColumnInfo(PTable table,
                                       String columnName)
                                throws SQLException
```
    Returns the column info for the given column for the given table.
    
    Parameters:
    
    table -
    
    columnName - User-specified column name. May be family-qualified or bare.
    
    Returns:
    
    columnInfo associated with the column in the table
    
    Throws:
    
    SQLException - if parameters are null or if column is not found or if column is ambiguous.
  - getColumnInfo
```
public static ColumnInfo getColumnInfo(PColumn pColumn)
                                throws SQLException
```
    Constructs a column info for the supplied pColumn
    
    Parameters:
    
    pColumn -
    
    Returns:
    
    columnInfo
    
    Throws:
    
    SQLException - if the parameter is null.
  - getOptimizedQueryPlan
```
public static QueryPlan getOptimizedQueryPlan(PreparedStatement stmt)
                                       throws SQLException
```
    Returns the opitmized query plan used by phoenix for executing the sql.
    
    Parameters:
    
    stmt - to return the plan for
    
    Throws:
    
    SQLException
  - hasOrderBy
```
public static boolean hasOrderBy(QueryPlan plan)
```
    Whether or not the query plan has any order by expressions.
    
    Parameters:
    
    plan -
    
    Returns:
  - getLimit
```
public static int getLimit(QueryPlan plan)
```
  - getPkColsForSql
```
public static List<Pair<String,String>> getPkColsForSql(Connection conn,
                                                        QueryPlan plan)
                                                 throws SQLException
```
    Get the column family, column name pairs that make up the row key of the table that will be queried.
    
    Parameters:
    
    conn - - connection used to generate the query plan. Caller should take care of closing the connection appropriately.
    
    plan - - query plan to get info for.
    
    Returns:
    
    the pairs of column family name and column name columns in the data table that make up the row key for the table used in the query plan. Column family names are optional and hence the first part of the pair is nullable. Column names and family names are enclosed in double quotes to allow for case sensitivity and for presence of special characters. Salting column and view index id column are not included. If the connection is tenant specific and the table used by the query plan is multi-tenant, then the tenant id column is not included as well.
    
    Throws:
    
    SQLException
  - getPkColsForSql
```
@Deprecated
public static void getPkColsForSql(List<Pair<String,String>> columns,
                                               QueryPlan plan,
                                               Connection conn,
                                               boolean forDataTable)
                                        throws SQLException
```
    Deprecated.
    
    Parameters:
    
    columns - - Initialized empty list to be filled with the pairs of column family name and column name for columns that are used as row key for the query plan. Column family names are optional and hence the first part of the pair is nullable. Column names and family names are enclosed in double quotes to allow for case sensitivity and for presence of special characters. Salting column and view index id column are not included. If the connection is tenant specific and the table used by the query plan is multi-tenant, then the tenant id column is not included as well.
    
    plan - - query plan to get info for.
    
    conn - - connection used to generate the query plan. Caller should take care of closing the connection appropriately.
    
    forDataTable - - if true, then family names and column names correspond to the data table even if the query plan uses the secondary index table. If false, and if the query plan uses the secondary index table, then the family names and column names correspond to the index table.
    
    Throws:
    
    SQLException
  - getPkColsDataTypesForSql
```
@Deprecated
public static void getPkColsDataTypesForSql(List<Pair<String,String>> columns,
                                                        List<String> dataTypes,
                                                        QueryPlan plan,
                                                        Connection conn,
                                                        boolean forDataTable)
                                                 throws SQLException
```
    Deprecated.
    
    Parameters:
    
    columns - - Initialized empty list to be filled with the pairs of column family name and column name for columns that are used as row key for the query plan. Column family names are optional and hence the first part of the pair is nullable. Column names and family names are enclosed in double quotes to allow for case sensitivity and for presence of special characters. Salting column and view index id column are not included. If the connection is tenant specific and the table used by the query plan is multi-tenant, then the tenant id column is not included as well.
    
    dataTypes - - Initialized empty list to be filled with the corresponding data type for the columns in @param columns.
    
    plan - - query plan to get info for
    
    conn - - phoenix connection used to generate the query plan. Caller should take care of closing the connection appropriately.
    
    forDataTable - - if true, then column names and data types correspond to the data table even if the query plan uses the secondary index table. If false, and if the query plan uses the secondary index table, then the column names and data types correspond to the index table.
    
    Throws:
    
    SQLException
  - getSqlTypeName
```
public static String getSqlTypeName(PColumn pCol)
```
    Parameters:
    
    pCol -
    
    Returns:
    
    sql type name that could be used in DDL statements, dynamic column types etc.
  - getSqlTypeName
```
public static String getSqlTypeName(PDataType dataType,
                                    Integer maxLength,
                                    Integer scale)
```
  - getArraySqlTypeName
```
public static String getArraySqlTypeName(@Nullable
                                         Integer maxLength,
                                         @Nullable
                                         Integer scale,
                                         PDataType arrayType)
```
  - encodeValues
```
@Deprecated
public static byte[] encodeValues(Connection conn,
                                              String fullTableName,
                                              Object[] values,
                                              List<Pair<String,String>> columns)
                                       throws SQLException
```
    Deprecated.
    
    Parameters:
    
    conn - connection that was used for reading/generating value.
    
    fullTableName - fully qualified table name
    
    values - values of the columns
    
    columns - list of pair of column that includes column family as first part and column name as the second part. Column family is optional and hence nullable. Columns in the list have to be in the same order as the order of occurence of their values in the object array.
    
    Returns:
    
    values encoded in a byte array
    
    Throws:
    
    SQLException
    
    See Also:
    
    #decodeValues(Connection, String, byte[], List)}
  - decodeValues
```
@Deprecated
public static Object[] decodeValues(Connection conn,
                                                String fullTableName,
                                                byte[] value,
                                                List<Pair<String,String>> columns)
                                         throws SQLException
```
    Deprecated.
    
    Parameters:
    
    conn - connection that was used for reading/generating value.
    
    fullTableName - fully qualified table name
    
    value - byte value of the columns concatenated as a single byte array. @see encodeColumnValues(Connection, String, Object[], List)
    
    columns - list of column names for the columns that have their respective values present in the byte array. The column names should be in the same order as their values are in the byte array. The column name includes both family name, if present, and column name.
    
    Returns:
    
    decoded values for each column
    
    Throws:
    
    SQLException
  - encodeColumnValues
```
public static byte[] encodeColumnValues(Connection conn,
                                        String fullTableName,
                                        Object[] values,
                                        List<Pair<String,String>> columns)
                                 throws SQLException
```
    Parameters:
    
    conn - connection that was used for reading/generating value.
    
    fullTableName - fully qualified table name
    
    values - values of the columns
    
    columns - list of pair of column that includes column family as first part and column name as the second part. Column family is optional and hence nullable. Columns in the list have to be in the same order as the order of occurence of their values in the object array.
    
    Returns:
    
    values encoded in a byte array
    
    Throws:
    
    SQLException
    
    See Also:
    
    #decodeValues(Connection, String, byte[], List)}
  - decodeColumnValues
```
public static Object[] decodeColumnValues(Connection conn,
                                          String fullTableName,
                                          byte[] value,
                                          List<Pair<String,String>> columns)
                                   throws SQLException
```
    Parameters:
    
    conn - connection that was used for reading/generating value.
    
    fullTableName - fully qualified table name
    
    value - byte value of the columns concatenated as a single byte array. @see encodeColumnValues(Connection, String, Object[], List)
    
    columns - list of column names for the columns that have their respective values present in the byte array. The column names should be in the same order as their values are in the byte array. The column name includes both family name, if present, and column name.
    
    Returns:
    
    decoded values for each column
    
    Throws:
    
    SQLException
  - getTenantIdExpression
```
public static Expression getTenantIdExpression(Connection conn,
                                               String fullTableName)
                                        throws SQLException
```
    Get expression that may be used to evaluate the tenant ID of a given row in a multi-tenant table. Both the SYSTEM.CATALOG table and the SYSTEM.SEQUENCE table are considered multi-tenant.
    
    Parameters:
    
    conn - open Phoenix connection
    
    fullTableName - full table name
    
    Returns:
    
    An expression that may be evaluated for a row in the provided table or null if the table is not a multi-tenant table.
    
    Throws:
    
    SQLException - if the table name is not found, a TableNotFoundException is thrown. If a multi-tenant local index is supplied a SQLFeatureNotSupportedException is thrown.
  - getFirstPKColumnExpression
```
public static Expression getFirstPKColumnExpression(Connection conn,
                                                    String fullTableName)
                                             throws SQLException
```
    Get expression that may be used to evaluate to the value of the first column of a given row in a Phoenix table.
    
    Parameters:
    
    conn - open Phoenix connection
    
    fullTableName - full table name
    
    Returns:
    
    An expression that may be evaluated for a row in the provided table.
    
    Throws:
    
    SQLException - if the table name is not found, a TableNotFoundException is thrown. If a local index is supplied a SQLFeatureNotSupportedException is thrown.
  - getGlobalPhoenixClientMetrics
```
public static Collection<GlobalMetric> getGlobalPhoenixClientMetrics()
```
    Exposes the various internal phoenix metrics collected at the client JVM level.
  - areGlobalClientMetricsBeingCollected
```
public static boolean areGlobalClientMetricsBeingCollected()
```
    Returns:
    
    whether or not the global client metrics are being collected
  - getRequestReadMetricInfo
```
public static Map<String,Map<MetricType,Long>> getRequestReadMetricInfo(ResultSet rs)
                                                                 throws SQLException
```
    Method to expose the metrics associated with performing reads using the passed result set. A typical pattern is:
```
 
 Map> overAllQueryMetrics = null;
 Map> requestReadMetrics = null;
 try (ResultSet rs = stmt.executeQuery()) {
    while(rs.next()) {
      .....
    }
    overAllQueryMetrics = PhoenixRuntime.getOverAllReadRequestMetrics(rs);
    requestReadMetrics = PhoenixRuntime.getRequestReadMetrics(rs);
    PhoenixRuntime.resetMetrics(rs);
 }
 
```
    Parameters:
    
    rs - result set to get the metrics for
    
    Returns:
    
    a map of (table name) -> (map of (metric name) -> (metric value))
    
    Throws:
    
    SQLException
  - getRequestReadMetrics
```
@Deprecated
public static Map<String,Map<String,Long>> getRequestReadMetrics(ResultSet rs)
                                                                      throws SQLException
```
    Deprecated.
    
    Throws:
    
    SQLException
  - getOverAllReadRequestMetricInfo
```
public static Map<MetricType,Long> getOverAllReadRequestMetricInfo(ResultSet rs)
                                                            throws SQLException
```
    Method to expose the overall metrics associated with executing a query via phoenix. A typical pattern of accessing request level read metrics and overall read query metrics is:
```
 
 Map> overAllQueryMetrics = null;
 Map> requestReadMetrics = null;
 try (ResultSet rs = stmt.executeQuery()) {
    while(rs.next()) {
      .....
    }
    overAllQueryMetrics = PhoenixRuntime.getOverAllReadRequestMetrics(rs);
    requestReadMetrics = PhoenixRuntime.getRequestReadMetrics(rs);
    PhoenixRuntime.resetMetrics(rs);
 }
 
```
    Parameters:
    
    rs - result set to get the metrics for
    
    Returns:
    
    a map of metric name -> metric value
    
    Throws:
    
    SQLException
  - getOverAllReadRequestMetrics
```
@Deprecated
public static Map<String,Long> getOverAllReadRequestMetrics(ResultSet rs)
                                                                 throws SQLException
```
    Deprecated.
    
    Throws:
    
    SQLException
  - getWriteMetricInfoForMutationsSinceLastReset
```
public static Map<String,Map<MetricType,Long>> getWriteMetricInfoForMutationsSinceLastReset(Connection conn)
                                                                                     throws SQLException
```
    Method to expose the metrics associated with sending over mutations to HBase. These metrics are updated when commit is called on the passed connection. Mutation metrics are accumulated for the connection till resetMetrics(Connection) is called or the connection is closed. Example usage:
```
 
 Map> mutationWriteMetrics = null;
 Map> mutationReadMetrics = null;
 try (Connection conn = DriverManager.getConnection(url)) {
    conn.createStatement.executeUpdate(dml1);
    ....
    conn.createStatement.executeUpdate(dml2);
    ...
    conn.createStatement.executeUpdate(dml3);
    ...
    conn.commit();
    mutationWriteMetrics = PhoenixRuntime.getWriteMetricsForMutationsSinceLastReset(conn);
    mutationReadMetrics = PhoenixRuntime.getReadMetricsForMutationsSinceLastReset(conn);
    PhoenixRuntime.resetMetrics(rs);
 }
 
```
    Parameters:
    
    conn - connection to get the metrics for
    
    Returns:
    
    a map of (table name) -> (map of (metric name) -> (metric value))
    
    Throws:
    
    SQLException
  - getWriteMetricsForMutationsSinceLastReset
```
@Deprecated
public static Map<String,Map<String,Long>> getWriteMetricsForMutationsSinceLastReset(Connection conn)
                                                                                          throws SQLException
```
    Deprecated.
    
    Throws:
    
    SQLException
  - getReadMetricInfoForMutationsSinceLastReset
```
public static Map<String,Map<MetricType,Long>> getReadMetricInfoForMutationsSinceLastReset(Connection conn)
                                                                                    throws SQLException
```
    Method to expose the read metrics associated with executing a dml statement. These metrics are updated when commit is called on the passed connection. Read metrics are accumulated till resetMetrics(Connection) is called or the connection is closed. Example usage:
```
 
 Map> mutationWriteMetrics = null;
 Map> mutationReadMetrics = null;
 try (Connection conn = DriverManager.getConnection(url)) {
    conn.createStatement.executeUpdate(dml1);
    ....
    conn.createStatement.executeUpdate(dml2);
    ...
    conn.createStatement.executeUpdate(dml3);
    ...
    conn.commit();
    mutationWriteMetrics = PhoenixRuntime.getWriteMetricsForMutationsSinceLastReset(conn);
    mutationReadMetrics = PhoenixRuntime.getReadMetricsForMutationsSinceLastReset(conn);
    PhoenixRuntime.resetMetrics(rs);
 }
 
```
    Parameters:
    
    conn - connection to get the metrics for
    
    Returns:
    
    a map of (table name) -> (map of (metric name) -> (metric value))
    
    Throws:
    
    SQLException
  - getReadMetricsForMutationsSinceLastReset
```
@Deprecated
public static Map<String,Map<String,Long>> getReadMetricsForMutationsSinceLastReset(Connection conn)
                                                                                         throws SQLException
```
    Deprecated.
    
    Throws:
    
    SQLException
  - resetMetrics
```
public static void resetMetrics(ResultSet rs)
                         throws SQLException
```
    Reset the read metrics collected in the result set.
    
    Parameters:
    
    rs -
    
    Throws:
    
    SQLException
    
    See Also:
    
    #getRequestReadMetrics(ResultSet)} {@link #getOverAllReadRequestMetrics(ResultSet)}
  - resetMetrics
```
public static void resetMetrics(Connection conn)
                         throws SQLException
```
    Reset the mutation and reads-for-mutations metrics collected in the connection.
    
    Parameters:
    
    conn -
    
    Throws:
    
    SQLException
    
    See Also:
    
    #getReadMetricsForMutationsSinceLastReset(Connection)} {@link #getWriteMetricsForMutationsSinceLastReset(Connection)}
  - getWallClockTimeFromCellTimeStamp
```
public static long getWallClockTimeFromCellTimeStamp(long tsOfCell)
```
    Use this utility function to ensure that a timestamp is in milliseconds across transactional and non transactional tables. This expects that the Cell timestamp is based either on wall clock time or transaction manager nanos wall clock time.
    
    Parameters:
    
    tsOfCell - Cell time stamp to be converted.
    
    Returns:
    
    wall clock time in milliseconds (i.e. Epoch time) of a given Cell time stamp.
  - getCurrentScn
```
public static long getCurrentScn(ReadOnlyProps props)
```

Class PhoenixRuntime

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JDBC_PROTOCOL

JDBC_THIN_PROTOCOL

JDBC_PROTOCOL_TERMINATOR

JDBC_PROTOCOL_SEPARATOR

EMBEDDED_JDBC_PROTOCOL

CURRENT_SCN_ATTRIB

BUILD_INDEX_AT_ATTRIB

TENANT_ID_ATTRIB

NO_UPGRADE_ATTRIB

UPSERT_BATCH_SIZE_ATTRIB

UPSERT_BATCH_SIZE_BYTES_ATTRIB

AUTO_COMMIT_ATTRIB

CONSISTENCY_ATTRIB

REQUEST_METRIC_ATTRIB

EXPLAIN_PLAN_ESTIMATED_BYTES_READ_COLUMN

EXPLAIN_PLAN_ESTIMATED_ROWS_READ_COLUMN

EXPLAIN_PLAN_ESTIMATE_INFO_TS_COLUMN

CONNECTION_PROPERTIES

CONNECTIONLESS

ANNOTATION_ATTRIB_PREFIX

PHOENIX_TEST_DRIVER_URL_PARAM

SCHEMA_ATTRIB

Method Detail

main

executeStatements

getUncommittedData

getUncommittedDataIterator

getUncommittedDataIterator

getTableNoCache

getTable

generateColumnInfo

getColumnInfo

getColumnInfo

getOptimizedQueryPlan

hasOrderBy

getLimit

getPkColsForSql

getPkColsForSql

getPkColsDataTypesForSql

getSqlTypeName

getSqlTypeName

getArraySqlTypeName

encodeValues

decodeValues

encodeColumnValues

decodeColumnValues

getTenantIdExpression

getFirstPKColumnExpression

getGlobalPhoenixClientMetrics

areGlobalClientMetricsBeingCollected

getRequestReadMetricInfo

getRequestReadMetrics

getOverAllReadRequestMetricInfo

getOverAllReadRequestMetrics

getWriteMetricInfoForMutationsSinceLastReset

getWriteMetricsForMutationsSinceLastReset

getReadMetricInfoForMutationsSinceLastReset

getReadMetricsForMutationsSinceLastReset

resetMetrics

resetMetrics

getWallClockTimeFromCellTimeStamp

getCurrentScn