Package io.deephaven.uri

Class BarrageTableResolver

java.lang.Object

io.deephaven.uri.BarrageTableResolver

All Implemented Interfaces:

io.deephaven.uri.resolver.UriResolver

public final class BarrageTableResolver
extends Object
implements io.deephaven.uri.resolver.UriResolver

The barrage table resolver is able to resolve remote URIs into tables.

For more advanced use cases, see BarrageSession.

See Also:

• remote URI format

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	MAX_INBOUND_MESSAGE_SIZE
static final BarrageSnapshotOptions	SNAP_OPTIONS
static final BarrageSubscriptionOptions	SUB_OPTIONS	The default options, which uses BarrageSubscriptionOptions.useDeephavenNulls().

Constructor Summary

Constructors

Constructor	Description
BarrageTableResolver(@NotNull ScheduledExecutorService executor, @NotNull io.deephaven.shadow.client.flight.org.apache.arrow.memory.BufferAllocator allocator, @NotNull io.deephaven.ssl.config.SSLConfig sslConfig)	A UriResolver for resolving tables from a Core+ worker using dh:// urls

Method Summary

Modifier and Type	Method	Description
static BarrageTableResolver	get()
boolean	isResolvable(@NotNull URI uri)
Table	resolve(@NotNull URI uri)
Set<String>	schemes()
Table	snapshot(@NotNull io.deephaven.uri.DeephavenTarget target, @NotNull io.deephaven.qst.table.TableSpec table, @NotNull BarrageSnapshotOptions options)	Create a full snapshot to the table via the target.
Table	snapshot(@NotNull io.deephaven.uri.DeephavenTarget target, @NotNull io.deephaven.qst.table.TableSpec table, @NotNull BarrageSnapshotOptions options, @Nullable Index viewport, @Nullable BitSet columns, boolean reverseViewport)	Create a partial table snapshot to the table via the target.
Table	snapshot(@NotNull io.deephaven.uri.RemoteUri remoteUri)	Create a full snapshot of the remote URI.
Table	snapshot(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table)	Create a full snapshot to the table via the targetUri.
Table	snapshot(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table, @Nullable Index viewport, @Nullable BitSet columns)	Create a partial table snapshot to the table via the targetUri.
Table	snapshot(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table, @Nullable Index viewport, @Nullable BitSet columns, boolean reverseViewport)	Create a partial table snapshot to the table via the targetUri.
Table	subscribe(@NotNull io.deephaven.uri.DeephavenTarget target, @NotNull io.deephaven.qst.table.TableSpec table, @NotNull BarrageSubscriptionOptions options)	Create a full-subscription to the table via the target.
Table	subscribe(@NotNull io.deephaven.uri.DeephavenTarget target, @NotNull io.deephaven.qst.table.TableSpec table, @NotNull BarrageSubscriptionOptions options, @Nullable Index viewport, @Nullable BitSet columns, boolean reverseViewport)	Create a partial table subscription to the table via the target.
Table	subscribe(@NotNull io.deephaven.uri.RemoteUri remoteUri)	Create a full-subscription to the remote URI.
Table	subscribe(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table)	Create a full-subscription to the table via the targetUri.
Table	subscribe(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table, @Nullable Index viewport, @Nullable BitSet columns)	Create a partial table subscription to the table via the targetUri.
Table	subscribe(@NotNull String targetUri, @NotNull io.deephaven.qst.table.TableSpec table, @Nullable Index viewport, @Nullable BitSet columns, boolean reverseViewport)	Create a partial table subscription to the table via the targetUri.

Methods inherited from class java.lang.Object

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

Field Details

MAX_INBOUND_MESSAGE_SIZE

public static final Integer MAX_INBOUND_MESSAGE_SIZE

SUB_OPTIONS

public static final BarrageSubscriptionOptions SUB_OPTIONS

The default options, which uses BarrageSubscriptionOptions.useDeephavenNulls().

SNAP_OPTIONS

public static final BarrageSnapshotOptions SNAP_OPTIONS

Constructor Details

BarrageTableResolver

public BarrageTableResolver(@NotNull
 @NotNull ScheduledExecutorService executor,
 @NotNull
 @NotNull io.deephaven.shadow.client.flight.org.apache.arrow.memory.BufferAllocator allocator,
 @NotNull
 @NotNull io.deephaven.ssl.config.SSLConfig sslConfig)

A UriResolver for resolving tables from a Core+ worker using dh:// urls

Parameters:

executor - the executor for servicing requests

allocator - the allocator for Barrrage

sslConfig - the ssl configuration

Method Details

get

public static BarrageTableResolver get()

schemes

public Set<String> schemes()

Specified by:

schemes in interface io.deephaven.uri.resolver.UriResolver

isResolvable

public boolean isResolvable(@NotNull
 @NotNull URI uri)

Specified by:

isResolvable in interface io.deephaven.uri.resolver.UriResolver

resolve

public Table resolve(@NotNull
 @NotNull URI uri)
              throws InterruptedException

Specified by:

resolve in interface io.deephaven.uri.resolver.UriResolver

Throws:

InterruptedException

subscribe

public Table subscribe(@NotNull
 @NotNull io.deephaven.uri.RemoteUri remoteUri)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
ExecutionException,
InterruptedException

Create a full-subscription to the remote URI. Uses SUB_OPTIONS.

Parameters:

remoteUri - the remote URI

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

ExecutionException

InterruptedException

subscribe

public Table subscribe(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
ExecutionException,
InterruptedException

Create a full-subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

ExecutionException

InterruptedException

subscribe

public Table subscribe(@NotNull
 @NotNull io.deephaven.uri.DeephavenTarget target,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @NotNull
 @NotNull BarrageSubscriptionOptions options)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a full-subscription to the table via the target.

Parameters:

target - the target

table - the table

options - the options

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

subscribe

public Table subscribe(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
ExecutionException,
InterruptedException

Create a partial table subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

ExecutionException

InterruptedException

subscribe

public Table subscribe(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns,
 boolean reverseViewport)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a partial table subscription to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

subscribe

public Table subscribe(@NotNull
 @NotNull io.deephaven.uri.DeephavenTarget target,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @NotNull
 @NotNull BarrageSubscriptionOptions options,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns,
 boolean reverseViewport)
                throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a partial table subscription to the table via the target.

Parameters:

target - the target

table - the table

options - the options

viewport - the position-space viewport to use for the subscription

columns - the columns to include in the subscription

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the subscribed table

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull io.deephaven.uri.RemoteUri remoteUri)
               throws InterruptedException,
io.deephaven.client.impl.TableHandle.TableHandleException,
ExecutionException

Create a full snapshot of the remote URI. Uses SUB_OPTIONS.

Parameters:

remoteUri - the remote URI

Returns:

the table to snapshot

Throws:

InterruptedException

io.deephaven.client.impl.TableHandle.TableHandleException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table)
               throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a full snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

Returns:

the table to snapshot

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull io.deephaven.uri.DeephavenTarget target,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @NotNull
 @NotNull BarrageSnapshotOptions options)
               throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a full snapshot to the table via the target.

Parameters:

target - the target

table - the table

options - the options

Returns:

the table to snapshot

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns)
               throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a partial table snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

Returns:

the table to snapshot

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull String targetUri,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns,
 boolean reverseViewport)
               throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a partial table snapshot to the table via the targetUri. Uses SUB_OPTIONS.

Parameters:

targetUri - the target URI

table - the table spec

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the table to snapshot

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException

snapshot

public Table snapshot(@NotNull
 @NotNull io.deephaven.uri.DeephavenTarget target,
 @NotNull
 @NotNull io.deephaven.qst.table.TableSpec table,
 @NotNull
 @NotNull BarrageSnapshotOptions options,
 @Nullable
 @Nullable Index viewport,
 @Nullable
 @Nullable BitSet columns,
 boolean reverseViewport)
               throws io.deephaven.client.impl.TableHandle.TableHandleException,
InterruptedException,
ExecutionException

Create a partial table snapshot to the table via the target.

Parameters:

target - the target

table - the table

options - the options

viewport - the position-space viewport to use for the snapshot

columns - the columns to include in the snapshot

reverseViewport - Whether to treat viewport as offsets from LongSizedDataStructure.size() rather than 0

Returns:

the table to snapshot

Throws:

io.deephaven.client.impl.TableHandle.TableHandleException

InterruptedException

ExecutionException