com.illumon.iris.db.tables.remotequery

Class RemoteQueryClient

java.lang.Object

com.illumon.iris.db.tables.remotequery.RemoteQueryClient

public class RemoteQueryClient
extends Object

Interface for remotely connecting to Deephaven.

Constructor Summary

Constructors

Constructor and Description
RemoteQueryClient() Create a new Deephaven dispatcher connection.
RemoteQueryClient(com.fishlib.net.ConnectionMonitor.Params connectionMonitorParams) Create a new Deephaven dispatcher connection.
RemoteQueryClient(String serverHost, int serverPort) Create a RemoteQueryClient and connect it to the RemoteQueryDispatcher.
RemoteQueryClient(String serverHost, int serverPort, com.fishlib.net.ConnectionMonitor.Params connectionMonitorParams) Create a RemoteQueryClient and connect it to the RemoteQueryDispatcher.

Method Summary

Modifier and Type	Method and Description
RemoteDatabase	getRemoteDB() Creates a Database object that communicates with a remote query worker.
RemoteDatabase	getRemoteDB(int maxHeapSizeMb) Creates a Database object that communicates with a remote query worker.

Constructor Detail

RemoteQueryClient

public RemoteQueryClient()

Create a new Deephaven dispatcher connection. The default host and port are selected using the RemoteQueryDispatcherParameters.host and RemoteQueryDispatcherParameters.queryPort properties.

Throws:

IOException - if an error occurred connecting to the RemoteQueryDispatcher

RemoteQueryClient

public RemoteQueryClient(@Nullable
                         com.fishlib.net.ConnectionMonitor.Params connectionMonitorParams)

Create a new Deephaven dispatcher connection. The default host and port are selected using the RemoteQueryDispatcherParameters.host and RemoteQueryDispatcherParameters.queryPort properties.

Parameters:

connectionMonitorParams - heartbeat and idle monitoring parameters

Throws:

IOException - if an error occurred connecting to the RemoteQueryDispatcher

RemoteQueryClient

public RemoteQueryClient(String serverHost,
                         int serverPort)

Create a RemoteQueryClient and connect it to the RemoteQueryDispatcher.

Parameters:

serverHost - the hostname of the RemoteQueryDispatcher

serverPort - the port of the RemoteQueryDispatcher

Throws:

IOException - if an error occurred connecting to the RemoteQueryDispatcher

RemoteQueryClient

public RemoteQueryClient(String serverHost,
                         int serverPort,
                         @Nullable
                         com.fishlib.net.ConnectionMonitor.Params connectionMonitorParams)

Create a RemoteQueryClient and connect it to the RemoteQueryDispatcher.

Parameters:

serverHost - the hostname of the RemoteQueryDispatcher

serverPort - the port of the RemoteQueryDispatcher

connectionMonitorParams - heartbeat and idle monitoring parameters

Throws:

IOException - if an error occurred connecting to the RemoteQueryDispatcher

Method Detail

getRemoteDB

public RemoteDatabase getRemoteDB()

Creates a Database object that communicates with a remote query worker. The requested worker will have the heap size specified by RemoteProcessingRequest.defaultQueryHeapMB property.

Returns:

a RemoteDatabase that can be used to query Deephaven

Throws:

IOException - if there was an error communicating with the query server

getRemoteDB

public RemoteDatabase getRemoteDB(int maxHeapSizeMb)

Creates a Database object that communicates with a remote query worker.

Parameters:

maxHeapSizeMb - the worker heap size to request

Returns:

a RemoteDatabase that can be used to query Deephaven

Throws:

IOException - if there was an error communicating with the query server