Package io.deephaven.client.impl

Interface BarrageSnapshot

All Known Implementing Classes:
BarrageSnapshotImpl
public interface BarrageSnapshot
A BarrageSnapshot represents a snapshot of a table that may or may not be filtered to a viewport of the remote source table.

  • Method Details

    • make

      static BarrageSnapshot make(BarrageSession session, @Nullable @Nullable ScheduledExecutorService executorService, TableHandle tableHandle, BarrageSnapshotOptions options)
      Create a BarrageSnapshot from a TableHandle.
      Parameters:
      session - the Deephaven session that this export belongs to
      executorService - an executor service used to flush metrics when enabled
      tableHandle - the tableHandle to snapshot (ownership is transferred to the snapshot)
      options - the transport level options for this snapshot
      Returns:
      a BarrageSnapshot

    • entireTable

      Future<Table> entireTable()
      Request a full snapshot of the data and populate a Table with the data that is received. The returned future will block until all rows for the snapshot table are available.
      Returns:
      a Future that will be populated with the result Table

    • partialTable

      Future<Table> partialTable(RowSet viewport, BitSet columns)
      Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received. The returned future will block until the snapshot table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the snapshot
      columns - the columns to include in the snapshot
      Returns:
      a Future that will be populated with the result Table

    • partialTable

      Future<Table> partialTable(RowSet viewport, BitSet columns, boolean reverseViewport)
      Request a partial snapshot of the data limited by viewport or column set and populate a Table with the data that is received. Allows the viewport to be reversed. The returned future will block until the snapshot table viewport is satisfied.
      Parameters:
      viewport - the position-space viewport to use for the snapshot
      columns - the columns to include in the snapshot
      reverseViewport - Whether to treat posRowSet as offsets from LongSizedDataStructure.size() rather than 0
      Returns:
      a Future that will be populated with the result Table