com.splicemachine.dbTesting.junit

Class IndexStatsUtil

java.lang.Object

com.splicemachine.dbTesting.junit.IndexStatsUtil

public class IndexStatsUtil
extends java.lang.Object

Helper class for obtaining index statistics and doing asserts on them.

This implementation assumes all tables/indexes belong to the current schema.

The timeout value is used to make the utility more resilient to differences in timing due to varying scheduling decisions, processor speeds, etc. If the system table contains the wrong number of statistics objects for the query, it will be queried repeatedly until the right number of statistics objects is obtained or the query times out.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexStatsUtil.IdxStats Immutable class representing index statistics.

Constructor Summary

Constructors

Constructor and Description
IndexStatsUtil(java.sql.Connection con) Creates an instance querying the given database with no timeout set.
IndexStatsUtil(java.sql.Connection con, long timeout) Creates an instance querying the given database with the specified timeout value.

Method Summary

Modifier and Type	Method and Description
void	assertIndexStats(java.lang.String index, int expectedCount) Asserts that the expected number of statistics exists for the specified index.
void	assertNoStats() Asserts that there are no existing statistics in the database.
void	assertNoStatsTable(java.lang.String table) Asserts that there are no existing statistics for the specified table.
void	assertStats(int expectedCount) Asserts that the expected number of statistics exists.
void	assertTableStats(java.lang.String table, int expectedCount) Asserts that the expected number of statistics exists for the specified table.
static java.lang.String	buildStatString(IndexStatsUtil.IdxStats[] stats, java.lang.String name) Builds a human readable representation of a list of statistics objects.
IndexStatsUtil.IdxStats[]	getNewStatsTable(java.lang.String table, IndexStatsUtil.IdxStats[] currentStats) Waits for the current statistics to disappear and expects to fetch the same number of new statistics for the table.
IndexStatsUtil.IdxStats[]	getStats() Obtains all existing statistics entries.
IndexStatsUtil.IdxStats[]	getStatsIndex(java.lang.String index) Obtains statistics for the specified index.
IndexStatsUtil.IdxStats[]	getStatsIndex(java.lang.String index, int expectedCount) Obtains statistics for the specified index, fails if the number of statistics objects isn't as expected within the timeout.
IndexStatsUtil.IdxStats[]	getStatsTable(java.lang.String table) Obtains statistics for the specified table.
IndexStatsUtil.IdxStats[]	getStatsTable(java.lang.String table, int expectedCount) Obtains statistics for the specified table, fails if the number of statistics objects isn't as expected within the timeout.
void	printStats() Prints all entries in the SYS.SYSSTATISTICS system table.
void	release() Releases resources and closes the associated connection.
void	release(boolean closeConnection) Releases resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexStatsUtil

public IndexStatsUtil(java.sql.Connection con)

Creates an instance querying the given database with no timeout set.

Querying with no timeout means that if there are too few or too many statistics objects matching the query, a failure will be raised immediately.

Parameters:

con - connection to the database to query

IndexStatsUtil

public IndexStatsUtil(java.sql.Connection con,
                      long timeout)

Creates an instance querying the given database with the specified timeout value.

Parameters:

con - connection to the database to query

timeout - the longest time to wait to see if the expectations for a query are met (milliseconds)

Method Detail

assertNoStats

public void assertNoStats()
                   throws java.sql.SQLException

Asserts that there are no existing statistics in the database.

Throws:

java.sql.SQLException - if obtaining the statistics fails

assertNoStatsTable

public void assertNoStatsTable(java.lang.String table)
                        throws java.sql.SQLException

Asserts that there are no existing statistics for the specified table.

Throws:

java.sql.SQLException - if obtaining the statistics fails

assertStats

public void assertStats(int expectedCount)
                 throws java.sql.SQLException

Asserts that the expected number of statistics exists.

Parameters:

expectedCount - expected number of statistics

Throws:

java.sql.SQLException - if obtaining the statistics fails

assertTableStats

public void assertTableStats(java.lang.String table,
                             int expectedCount)
                      throws java.sql.SQLException

Asserts that the expected number of statistics exists for the specified table.

Parameters:

table - the target table

expectedCount - expected number of statistics

Throws:

java.sql.SQLException - if obtaining the statistics fails

assertIndexStats

public void assertIndexStats(java.lang.String index,
                             int expectedCount)
                      throws java.sql.SQLException

Asserts that the expected number of statistics exists for the specified index.

Parameters:

index - the target index

expectedCount - expected number of statistics

Throws:

java.sql.SQLException - if obtaining the statistics fails

buildStatString

public static java.lang.String buildStatString(IndexStatsUtil.IdxStats[] stats,
                                               java.lang.String name)

Builds a human readable representation of a list of statistics objects.

Parameters:

stats - a list of statistics (possibly empty)

name - the name of the table(s)/index(es) associated with the stats

Returns:

A string representation of the statistics.

getStats

public IndexStatsUtil.IdxStats[] getStats()
                                   throws java.sql.SQLException

Obtains all existing statistics entries.

Returns:

A list of statistics entries (possibly empty).

Throws:

java.sql.SQLException - if obtaining the statistics fail

getStatsTable

public IndexStatsUtil.IdxStats[] getStatsTable(java.lang.String table)
                                        throws java.sql.SQLException

Obtains statistics for the specified table.

Parameters:

table - table name

Returns:

A list of statistics entries (possibly empty).

Throws:

java.sql.SQLException - if obtaining the statistics fail

getStatsTable

public IndexStatsUtil.IdxStats[] getStatsTable(java.lang.String table,
                                               int expectedCount)
                                        throws java.sql.SQLException

Obtains statistics for the specified table, fails if the number of statistics objects isn't as expected within the timeout.

Parameters:

table - table name

expectedCount - number of expected statistics objects

Returns:

A list of statistics entries (possibly empty).

Throws:

java.sql.SQLException - if obtaining the statistics fail

getNewStatsTable

public IndexStatsUtil.IdxStats[] getNewStatsTable(java.lang.String table,
                                                  IndexStatsUtil.IdxStats[] currentStats)
                                           throws java.sql.SQLException

Waits for the current statistics to disappear and expects to fetch the same number of new statistics for the table.

Parameters:

table - the table to get statistics for

currentStats - the current statistics

Returns:

The new statistics.

Throws:

java.sql.SQLException - if obtaining statistics fails

getStatsIndex

public IndexStatsUtil.IdxStats[] getStatsIndex(java.lang.String index)
                                        throws java.sql.SQLException

Obtains statistics for the specified index.

Parameters:

index - index name

Returns:

A list of statistics entries (possibly empty).

Throws:

java.sql.SQLException - if obtaining the statistics fail

getStatsIndex

public IndexStatsUtil.IdxStats[] getStatsIndex(java.lang.String index,
                                               int expectedCount)
                                        throws java.sql.SQLException

Obtains statistics for the specified index, fails if the number of statistics objects isn't as expected within the timeout.

Parameters:

index - index name

expectedCount - number of expected statistics objects

Returns:

A list of statistics entries (possibly empty).

Throws:

java.sql.SQLException - if obtaining the statistics fail

printStats

public void printStats()
                throws java.sql.SQLException

Prints all entries in the SYS.SYSSTATISTICS system table.

Throws:

java.sql.SQLException - if obtaining the statistics fails

release

public void release()

Releases resources and closes the associated connection.

release

public void release(boolean closeConnection)

Releases resources.

Parameters:

closeConnection - whether to close the associated connection