Package io.deephaven.enterprise.remote

Class RemoteTableBuilder

java.lang.Object

io.deephaven.enterprise.remote.RemoteTableBuilder

public class RemoteTableBuilder
extends Object

A Builder class for creating reliable subscriptions to remote tables. Subscribed tables will gracefully handle disconnections of the upstream table and reconnect when they become available.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RemoteTableBuilder.Unauthenticated	An interposed interface that forces users to authenticate with the remote system before they can call any subscription methods.

Constructor Summary

Constructors

Constructor	Description
RemoteTableBuilder(@NotNull CorePlusClusterSessionFactory clusterDetails)	Create a new RemoteTableBuilder for connecting to queries within a Core+ cluster.

Method Summary

Modifier and Type	Method	Description
static @NotNull RemoteTableBuilder	forLocalCluster()	Create a new RemoteTableBuilder for the current cluster.
static RemoteTableBuilder	forRemoteCluster(@NotNull DeephavenClusterConnection clusterConnection)	Create a new RemoteTableBuilder to connect to the specified remote cluster.
static RemoteTableBuilder.Unauthenticated	forRemoteCluster(@NotNull String clusterUrl)	Create a new RemoteTableBuilder to connect to the specified remote cluster.
@NotNull RemoteTableBuilder	isBlink(boolean isBlink)	Mark the fetched table as a blink table.
@NotNull RemoteTableBuilder	queryName(@NotNull String queryName)	Set the name of the query to fetch the table from.
static void	setLocalClusterDetails(@NotNull CorePlusClusterSessionFactory localClusterDetails)	Set the CorePlusClusterSessionFactory details for the current cluster.
@NotNull Table	snapshot()	Create a static snapshot of the entire upstream Table.
@NotNull Table	snapshot(@Nullable Set<String> includedColumns)	Create a static snapshot of the upstream Table including only the specified columns.
@NotNull Table	snapshot(String... includedColumns)	Create a static snapshot of the upstream Table including only the specified columns.
@NotNull Table	subscribe()	Subscribe to the entire table using the default SubscriptionOptions.
@NotNull Table	subscribe(@NotNull SubscriptionOptions subscriptionOptions)	Subscribe to the table using the specified SubscriptionOptions.
@NotNull RemoteTableBuilder	tableDefinition(@NotNull TableDefinition tableDefinition)	Set the prototype TableDefinition of the table to fetch.
@NotNull RemoteTableBuilder	tableName(@NotNull String tableName)	Set the Table name to fetch from the query.

Methods inherited from class java.lang.Object

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

Constructor Details

RemoteTableBuilder

public RemoteTableBuilder(@NotNull
 @NotNull CorePlusClusterSessionFactory clusterDetails)

Create a new RemoteTableBuilder for connecting to queries within a Core+ cluster.

Parameters:

clusterDetails - the cluster details

Method Details

setLocalClusterDetails

public static void setLocalClusterDetails(@NotNull
 @NotNull CorePlusClusterSessionFactory localClusterDetails)

Set the CorePlusClusterSessionFactory details for the current cluster.

Parameters:

localClusterDetails - the details.

forLocalCluster

@NotNull
public static @NotNull RemoteTableBuilder forLocalCluster()

Create a new RemoteTableBuilder for the current cluster.

Returns:

a new RemoteTableBuilder

forRemoteCluster

public static RemoteTableBuilder.Unauthenticated forRemoteCluster(@NotNull
 @NotNull String clusterUrl)
                                                           throws IOException

Create a new RemoteTableBuilder to connect to the specified remote cluster. You must authenticate with RemoteTableBuilder.Unauthenticated.password(java.lang.String, java.lang.String) or RemoteTableBuilder.Unauthenticated.privateKey(String) before any tables can be created.

Parameters:

clusterUrl - the url for the remote cluster

Returns:

a new RemoteTableBuilder.Unauthenticated

Throws:

IOException - if there is a problem connecting to the remote cluster

forRemoteCluster

public static RemoteTableBuilder forRemoteCluster(@NotNull
 @NotNull DeephavenClusterConnection clusterConnection)

Create a new RemoteTableBuilder to connect to the specified remote cluster. The passed in cluster connection must be authenticated. See DeephavenClusterConnection.password(String, String) and DeephavenClusterConnection.privateKey(String).

Parameters:

clusterConnection - the cluster connection

Returns:

a new RemoteTableBuilder

queryName

@NotNull
public @NotNull RemoteTableBuilder queryName(@NotNull
 @NotNull String queryName)

Set the name of the query to fetch the table from.

Parameters:

queryName - the name of the Query

Returns:

this RemoteTableBuilder

tableName

@NotNull
public @NotNull RemoteTableBuilder tableName(@NotNull
 @NotNull String tableName)

Set the Table name to fetch from the query.

Parameters:

tableName - the table name

Returns:

this RemoteTableBuilder

tableDefinition

@NotNull
public @NotNull RemoteTableBuilder tableDefinition(@NotNull
 @NotNull TableDefinition tableDefinition)

Set the prototype TableDefinition of the table to fetch. If this is not specified, the definition will be discovered by connecting to the query, which requires it to be available.

Parameters:

tableDefinition - the prototype TableDefinition

Returns:

this RemoteTableBuilder

isBlink

@NotNull
public @NotNull RemoteTableBuilder isBlink(boolean isBlink)

Mark the fetched table as a blink table. The remote table must also be a blink table or the subscription will fail.

Parameters:

isBlink - true if the table is a blink table

Returns:

this RemoteTableBuilder

subscribe

@NotNull
public @NotNull Table subscribe()

Subscribe to the entire table using the default SubscriptionOptions.

Returns:

the subscribed Table

subscribe

@NotNull
public @NotNull Table subscribe(@NotNull
 @NotNull SubscriptionOptions subscriptionOptions)

Subscribe to the table using the specified SubscriptionOptions.

Parameters:

subscriptionOptions - the SubscriptionOptions

Returns:

the subscribed Table

snapshot

@NotNull
public @NotNull Table snapshot()

Create a static snapshot of the entire upstream Table.

Returns:

the table snapshot.

snapshot

@NotNull
public @NotNull Table snapshot(String... includedColumns)

Create a static snapshot of the upstream Table including only the specified columns.

Parameters:

includedColumns - the columns to include.

Returns:

the table snapshot.

snapshot

@NotNull
public @NotNull Table snapshot(@Nullable
 @Nullable Set<String> includedColumns)

Create a static snapshot of the upstream Table including only the specified columns.

Parameters:

includedColumns - the columns to include.

Returns:

the table snapshot.