Package org.apache.drill.exec.client

Class DrillClient

java.lang.Object

org.apache.drill.exec.client.DrillClient

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionThrottle

public class DrillClient
extends Object
implements Closeable, ConnectionThrottle

Thin wrapper around a UserClient that handles connect/close and transforms String into ByteBuf.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CLIENT_NAME

Constructor Summary

Constructors

Constructor	Description
DrillClient()
DrillClient(boolean isDirect)
DrillClient(String fileName)
DrillClient(DrillConfig config)
DrillClient(DrillConfig config, boolean isDirect)
DrillClient(DrillConfig config, ClusterCoordinator coordinator)
DrillClient(DrillConfig config, ClusterCoordinator coordinator, boolean isDirect)
DrillClient(DrillConfig config, ClusterCoordinator coordinator, BufferAllocator allocator)
DrillClient(DrillConfig config, ClusterCoordinator coordinator, BufferAllocator allocator, boolean isDirect)

Method Summary

Modifier and Type	Method	Description
DrillRpcFuture<GeneralRPCProtos.Ack>	cancelQuery(UserBitShared.QueryId id)
void	close()	Closes this client's connection to the server
void	connect()	Connects the client to a Drillbit server
void	connect(String connect, Properties props)	Start's a connection from client to server
void	connect(Properties props)	Start's a connection from client to server
boolean	connectionIsActive()
protected static io.netty.channel.EventLoopGroup	createEventLoop(int size, String prefix)
DrillRpcFuture<UserProtos.CreatePreparedStatementResp>	createPreparedStatement(String query)	Create a prepared statement for given the query.
List<QueryDataBatch>	executePreparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle)	Execute the given prepared statement and return the results.
void	executePreparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle, UserResultsListener resultsListener)	Execute the given prepared statement.
BufferAllocator	getAllocator()
DrillRpcFuture<UserProtos.GetCatalogsResp>	getCatalogs(UserProtos.LikeFilter catalogNameFilter)	Get the list of catalogs in INFORMATION_SCHEMA.CATALOGS table satisfying the given filters.
DrillRpcFuture<UserProtos.GetColumnsResp>	getColumns(UserProtos.LikeFilter catalogNameFilter, UserProtos.LikeFilter schemaNameFilter, UserProtos.LikeFilter tableNameFilter, UserProtos.LikeFilter columnNameFilter)	Get the list of columns in INFORMATION_SCHEMA.COLUMNS table satisfying the given filters.
DrillConfig	getConfig()
DrillRpcFuture<UserProtos.GetSchemasResp>	getSchemas(UserProtos.LikeFilter catalogNameFilter, UserProtos.LikeFilter schemaNameFilter)	Get the list of schemas in INFORMATION_SCHEMA.SCHEMATA table satisfying the given filters.
UserProtos.RpcEndpointInfos	getServerInfos()	Deprecated. use DrillClient#getServerVersion()
DrillRpcFuture<UserProtos.GetServerMetaResp>	getServerMeta()	Get server meta information Get meta information about the server like the the available functions or the identifier quoting string used by the current session
String	getServerName()	Return the server name.
Version	getServerVersion()	Return the server version.
Set<ServerMethod>	getSupportedMethods()	Returns the list of methods supported by the server based on its advertised information.
DrillRpcFuture<UserProtos.GetTablesResp>	getTables(UserProtos.LikeFilter catalogNameFilter, UserProtos.LikeFilter schemaNameFilter, UserProtos.LikeFilter tableNameFilter, List<String> tableTypeFilter)	Get the list of tables in INFORMATION_SCHEMA.TABLES table satisfying the given filters.
boolean	hasPing(long timeoutSec)	Verify connection with request-answer.
DrillRpcFuture<UserProtos.QueryPlanFragments>	planQuery(UserBitShared.QueryType type, String query, boolean isSplitPlan)	API to just plan a query without execution
boolean	reconnect()
DrillRpcFuture<GeneralRPCProtos.Ack>	resumeQuery(UserBitShared.QueryId queryId)
List<QueryDataBatch>	runQuery(UserBitShared.QueryType type, String plan)	Submits a string based query plan for execution and returns the result batches.
void	runQuery(UserBitShared.QueryType type, String plan, UserResultsListener resultsListener)	Submits a Logical plan for direct execution (bypasses parsing)
void	runQuery(UserBitShared.QueryType type, List<BitControl.PlanFragment> planFragments, UserResultsListener resultsListener)	Run query based on list of fragments that were supposedly produced during query planning phase.
void	setAutoRead(boolean enableAutoRead)
void	setClientName(String name)	Sets the client name.
void	setSupportComplexTypes(boolean supportComplexTypes)	Sets whether the application is willing to accept complex types (Map, Arrays) in the returned result set.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CLIENT_NAME

public static final String DEFAULT_CLIENT_NAME

See Also:

• Constant Field Values

Constructor Details

DrillClient

public DrillClient()
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(boolean isDirect)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(String fileName)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config,
 boolean isDirect)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config,
 ClusterCoordinator coordinator)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config,
 ClusterCoordinator coordinator,
 boolean isDirect)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config,
 ClusterCoordinator coordinator,
 BufferAllocator allocator)
            throws OutOfMemoryException

Throws:

OutOfMemoryException

DrillClient

public DrillClient(DrillConfig config,
 ClusterCoordinator coordinator,
 BufferAllocator allocator,
 boolean isDirect)

Method Details

getConfig

public DrillConfig getConfig()

setAutoRead

public void setAutoRead(boolean enableAutoRead)

Specified by:

setAutoRead in interface ConnectionThrottle

setClientName

public void setClientName(String name)

Sets the client name. If not set, default is DrillClient#DEFAULT_CLIENT_NAME.

Parameters:

name - the client name

Throws:

IllegalStateException - if called after a connection has been established.

NullPointerException - if client name is null

setSupportComplexTypes

public void setSupportComplexTypes(boolean supportComplexTypes)

Sets whether the application is willing to accept complex types (Map, Arrays) in the returned result set. Default is true. If set to false, the complex types are returned as JSON encoded VARCHAR type.

Throws:

IllegalStateException - if called after a connection has been established.

connect

public void connect()
             throws RpcException

Connects the client to a Drillbit server

Throws:

RpcException

connect

public void connect(Properties props)
             throws RpcException

Start's a connection from client to server

Parameters:

props - - not null Properties filled with connection url parameters

Throws:

RpcException

connect

public void connect(String connect,
 Properties props)
             throws RpcException

Start's a connection from client to server

Parameters:

connect - - Zookeeper connection string provided at connection URL

props - - not null Properties filled with connection url parameters

Throws:

RpcException

createEventLoop

protected static io.netty.channel.EventLoopGroup createEventLoop(int size,
 String prefix)

reconnect

public boolean reconnect()

getAllocator

public BufferAllocator getAllocator()

close

public void close()

Closes this client's connection to the server

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getServerInfos

@Deprecated
public UserProtos.RpcEndpointInfos getServerInfos()

Deprecated.

use DrillClient#getServerVersion()

Return the server infos. Only available after connecting The result might be null if the server doesn't provide the informations.

Returns:

the server informations, or null if not connected or if the server doesn't provide the information

getServerName

public String getServerName()

Return the server name. Only available after connecting The result might be null if the server doesn't provide the name information.

Returns:

the server name, or null if not connected or if the server doesn't provide the name

getServerVersion

public Version getServerVersion()

Return the server version. Only available after connecting The result might be null if the server doesn't provide the version information.

Returns:

the server version, or null if not connected or if the server doesn't provide the version

getServerMeta

public DrillRpcFuture<UserProtos.GetServerMetaResp> getServerMeta()

Get server meta information Get meta information about the server like the the available functions or the identifier quoting string used by the current session

Returns:

a future to the server meta response

getSupportedMethods

public Set<ServerMethod> getSupportedMethods()

Returns the list of methods supported by the server based on its advertised information.

Returns:

an immutable set of capabilities

runQuery

public List<QueryDataBatch> runQuery(UserBitShared.QueryType type,
 String plan)
                              throws RpcException

Submits a string based query plan for execution and returns the result batches. Supported query types are:

• UserBitShared.QueryType.LOGICAL
• UserBitShared.QueryType.PHYSICAL
• UserBitShared.QueryType.SQL

Parameters:

type - Query type

plan - Query to execute

Returns:

a handle for the query result

Throws:

RpcException

planQuery

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

API to just plan a query without execution

Parameters:

type -

query -

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

Returns:

list of PlanFragments that can be used later on in runQuery(org.apache.drill.exec.proto.UserBitShared.QueryType, java.util.List, org.apache.drill.exec.rpc.user.UserResultsListener) to run a query without additional planning

runQuery

public void runQuery(UserBitShared.QueryType type,
 List<BitControl.PlanFragment> planFragments,
 UserResultsListener resultsListener)
              throws RpcException

Run query based on list of fragments that were supposedly produced during query planning phase. Supported query type is UserBitShared.QueryType.EXECUTION

Parameters:

type -

planFragments -

resultsListener -

Throws:

RpcException

cancelQuery

public DrillRpcFuture<GeneralRPCProtos.Ack> cancelQuery(UserBitShared.QueryId id)

resumeQuery

public DrillRpcFuture<GeneralRPCProtos.Ack> resumeQuery(UserBitShared.QueryId queryId)

getCatalogs

public DrillRpcFuture<UserProtos.GetCatalogsResp> getCatalogs(UserProtos.LikeFilter catalogNameFilter)

Get the list of catalogs in INFORMATION_SCHEMA.CATALOGS table satisfying the given filters.

Parameters:

catalogNameFilter - Filter on catalog name. Pass null to apply no filter.

Returns:

The list of catalogs in INFORMATION_SCHEMA.CATALOGS table satisfying the given filters.

getSchemas

public DrillRpcFuture<UserProtos.GetSchemasResp> getSchemas(UserProtos.LikeFilter catalogNameFilter,
 UserProtos.LikeFilter schemaNameFilter)

Get the list of schemas in INFORMATION_SCHEMA.SCHEMATA table satisfying the given filters.

Parameters:

catalogNameFilter - Filter on catalog name. Pass null to apply no filter.

schemaNameFilter - Filter on schema name. Pass null to apply no filter.

Returns:

The list of schemas in INFORMATION_SCHEMA.SCHEMATA table satisfying the given filters.

getTables

public DrillRpcFuture<UserProtos.GetTablesResp> getTables(UserProtos.LikeFilter catalogNameFilter,
 UserProtos.LikeFilter schemaNameFilter,
 UserProtos.LikeFilter tableNameFilter,
 List<String> tableTypeFilter)

Get the list of tables in INFORMATION_SCHEMA.TABLES table satisfying the given filters.

Parameters:

catalogNameFilter - Filter on catalog name. Pass null to apply no filter.

schemaNameFilter - Filter on schema name. Pass null to apply no filter.

tableNameFilter - Filter in table name. Pass null to apply no filter.

tableTypeFilter - Filter in table type. Pass null to apply no filter

Returns:

The list of tables in INFORMATION_SCHEMA.TABLES table satisfying the given filters.

getColumns

public DrillRpcFuture<UserProtos.GetColumnsResp> getColumns(UserProtos.LikeFilter catalogNameFilter,
 UserProtos.LikeFilter schemaNameFilter,
 UserProtos.LikeFilter tableNameFilter,
 UserProtos.LikeFilter columnNameFilter)

Get the list of columns in INFORMATION_SCHEMA.COLUMNS table satisfying the given filters.

Parameters:

catalogNameFilter - Filter on catalog name. Pass null to apply no filter.

schemaNameFilter - Filter on schema name. Pass null to apply no filter.

tableNameFilter - Filter in table name. Pass null to apply no filter.

columnNameFilter - Filter in column name. Pass null to apply no filter.

Returns:

The list of columns in INFORMATION_SCHEMA.COLUMNS table satisfying the given filters.

createPreparedStatement

public DrillRpcFuture<UserProtos.CreatePreparedStatementResp> createPreparedStatement(String query)

Create a prepared statement for given the query.

Parameters:

query -

Returns:

The prepared statement for given the query.

executePreparedStatement

public void executePreparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle,
 UserResultsListener resultsListener)

Execute the given prepared statement.

Parameters:

preparedStatementHandle - Prepared statement handle returned in response to createPreparedStatement(String).

resultsListener - UserResultsListener instance for listening for query results.

executePreparedStatement

public List<QueryDataBatch> executePreparedStatement(UserProtos.PreparedStatementHandle preparedStatementHandle)
                                              throws RpcException

Execute the given prepared statement and return the results.

Parameters:

preparedStatementHandle - Prepared statement handle returned in response to createPreparedStatement(String).

Returns:

List of QueryDataBatchs. It is responsibility of the caller to release query data batches.

Throws:

RpcException

runQuery

public void runQuery(UserBitShared.QueryType type,
 String plan,
 UserResultsListener resultsListener)

Submits a Logical plan for direct execution (bypasses parsing)

Parameters:

plan - the plan to execute

connectionIsActive

public boolean connectionIsActive()

Returns:

true if client has connection and it is connected, false otherwise

hasPing

public boolean hasPing(long timeoutSec)
                throws DrillRuntimeException

Verify connection with request-answer.

Parameters:

timeoutSec - time in seconds to wait answer receiving. If 0 then won't wait.

Returns:

true if PONG received until timeout, false otherwise

Throws:

DrillRuntimeException