Package io.deephaven.enterprise.database

Class TableOptions

java.lang.Object
io.deephaven.enterprise.database.TableOptions
@Immutable public abstract class TableOptions extends Object
A collection of options that control the construction of a live table

  • Constructor Details

    • TableOptions

      public TableOptions()

  • Method Details

    • internalPartitionColumn

      @Default @Nullable public @Nullable String internalPartitionColumn()
      The name of the internal partition column in the fetched table.
      Returns:
      The name, or null if the internal partition will not be included.

    • isBlink

      @Default public boolean isBlink()
      Get if the result table will be a Blink table.
      Returns:
      True if the table is a blink table false otherwise.

    • isRefreshing

      @Default public boolean isRefreshing()
      Get if the result table will be refreshing.
      Returns:
      True if the table is refreshing.

    • newLiveBuilder

      public static TableOptions.Builder newLiveBuilder()
      Create a new TableOptions.Builder for setting options on a live ticking table.
      Returns:
      a new TableOptions.Builder

    • newStaticBuilder

      public static TableOptions.Builder newStaticBuilder()
      Create a new TableOptions.Builder for setting options on a static table.
      Returns:
      a new TableOptions.Builder

    • forLive

      public static TableOptions forLive()
      Get the default TableOptions for a live ticking table.
      Returns:
      the live options.

    • forStatic

      public static TableOptions forStatic()
      Get the default TableOptions for a static table.
      Returns:
      the static options.

    • forBlink

      public static TableOptions forBlink()
      Get the default TableOptions for a live blink table.
      Returns:
      the blink options.