org.apache.drill.test

Class ClientFixture

java.lang.Object

org.apache.drill.test.ClientFixture

All Implemented Interfaces:

AutoCloseable

public class ClientFixture
extends Object
implements AutoCloseable

Represents a Drill client. Provides many useful test-specific operations such as setting system options, running queries, and using the @{link TestBuilder} class.

See Also:

ExampleTest for usage examples

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientFixture.ClientBuilder
static class	ClientFixture.StatementParser Very simple parser for semi-colon separated lists of SQL statements which handles quoted semicolons.

Constructor Summary

Constructors

Constructor and Description
ClientFixture(ClientFixture.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
BufferAllocator	allocator()
void	alterSession(String key, Object value) Set a runtime option.
void	alterSystem(String key, Object value)
DrillClient	client()
void	close()
ClusterFixture	cluster()
int	countResults(List<QueryDataBatch> results)
int	exec(File source) Execute a set of statements from a file.
int	exec(Reader in)
int	exec(String stmts) Execute a set of statements from a string.
ProfileParser	parseProfile(QueryBuilder.QuerySummary summary) Return a parsed query profile for a query summary.
ProfileParser	parseProfile(String queryId) Parse a query profile from the local storage location given the query ID.
UserProtos.QueryPlanFragments	planQuery(String sql)
UserProtos.QueryPlanFragments	planQuery(UserBitShared.QueryType type, String query, boolean isSplitPlan) Plan a query without execution.
QueryBuilder	queryBuilder()
void	resetSession(String key) Reset a system option
void	resetSystem(String key)
RowSetBuilder	rowSetBuilder(BatchSchema schema)
RowSetBuilder	rowSetBuilder(TupleMetadata schema)
void	runQueriesAndLog(String queryString) Run zero or more queries and log the output in TSV format.
void	runQueriesAndPrint(String queryString) Run zero or more queries and print the output in TSV format.
void	runSqlSilently(String sql, Object... args) Run SQL silently (discard results).
void	setControls(String controls) Set a set of injection controls that apply on the next query only.
TestBuilder	testBuilder()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientFixture

public ClientFixture(ClientFixture.ClientBuilder builder)
              throws RpcException

Throws:

RpcException

Method Detail

client

public DrillClient client()

cluster

public ClusterFixture cluster()

allocator

public BufferAllocator allocator()

alterSession

public void alterSession(String key,
                         Object value)

Set a runtime option.

Parameters:

key - option name

value - option value

alterSystem

public void alterSystem(String key,
                        Object value)

resetSession

public void resetSession(String key)

Reset a system option

Parameters:

key - option name

resetSystem

public void resetSystem(String key)

runSqlSilently

public void runSqlSilently(String sql,
                           Object... args)

Run SQL silently (discard results).

Parameters:

sql - query

args - format params

Throws:

IllegalStateException - if something goes wrong

queryBuilder

public QueryBuilder queryBuilder()

countResults

public int countResults(List<QueryDataBatch> results)

testBuilder

public TestBuilder testBuilder()

runQueriesAndLog

public void runQueriesAndLog(String queryString)

Run zero or more queries and log the output in TSV format.

Parameters:

queryString - query string

runQueriesAndPrint

public void runQueriesAndPrint(String queryString)

Run zero or more queries and print the output in TSV format.

Parameters:

queryString - query string

planQuery

public UserProtos.QueryPlanFragments planQuery(UserBitShared.QueryType type,
                                               String query,
                                               boolean isSplitPlan)

Plan a query without execution.

Parameters:

type - query type

query - query string

isSplitPlan - option to tell whether to return single or split plans for a query

Returns:

query plan fragments

planQuery

public UserProtos.QueryPlanFragments planQuery(String sql)

close

public void close()

Specified by:

close in interface AutoCloseable

parseProfile

public ProfileParser parseProfile(QueryBuilder.QuerySummary summary)
                           throws IOException

Return a parsed query profile for a query summary. Saving of profiles must be turned on.

Parameters:

summary - query summary

Returns:

profile parser

Throws:

IOException - if unable to parse query profile

parseProfile

public ProfileParser parseProfile(String queryId)
                           throws IOException

Parse a query profile from the local storage location given the query ID. Saving of profiles must be turned on. This is a bit of a hack: the profile should be available directly from the server.

Parameters:

queryId - query ID

Returns:

profile parser

Throws:

IOException - if unable to parse the profile

setControls

public void setControls(String controls)

Set a set of injection controls that apply on the next query only. That query should be your target query, but may accidentally be an ALTER SESSION, EXPLAIN, etc. So, call this just before the SELECT statement.

Parameters:

controls - the controls string created by Controls.newBuilder() builder.

rowSetBuilder

public RowSetBuilder rowSetBuilder(BatchSchema schema)

rowSetBuilder

public RowSetBuilder rowSetBuilder(TupleMetadata schema)

exec

public int exec(Reader in)
         throws IOException

Throws:

IOException

exec

public int exec(File source)
         throws IOException

Execute a set of statements from a file.

Parameters:

source - the set of statements, separated by semicolons

Returns:

the number of statements executed

Throws:

IOException - if anable to execute statements from file

exec

public int exec(String stmts)

Execute a set of statements from a string.

Parameters:

stmts - the set of statements, separated by semicolons

Returns:

the number of statements executed