Package io.deephaven.enterprise.locations

Interface EnterpriseTableKey

All Superinterfaces:
ImmutableTableKey, LogOutputAppendable, io.deephaven.shadow.enterprise.com.fishlib.base.log.LogOutputAppendable, NamedImplementation, TableKey
All Known Implementing Classes:
EnterpriseTableKeyImpl
public interface EnterpriseTableKey extends ImmutableTableKey, io.deephaven.shadow.enterprise.com.fishlib.base.log.LogOutputAppendable
A TableKey implementation for addressing Deephaven Enterprise Tables. Allows presentation of DnD V2 table types or the corresponding DHE V1 table types. V2 table types are needed for data routing, and V1 table types are needed because DHE (in particular, BinaryLogFileManager) cannot interpret V2 table types just from binary log files.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final EnterpriseTableKey
    STANDALONE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableKey
    adapt()
    Get an Enterprise formatted version of this EnterpriseTableKey, which will contain a V2 table type.
    io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableKey
    adaptWithV1TableType()
    Get an Enterprise formatted version of this EnterpriseTableKey, which will be logically equivalent, except for table type adapted to its V1 equivalent.
    @NotNull String
    getNamespace()
    Get the namespace of the table.
    @NotNull String
    getTableName()
    Get the name of the table.
    @NotNull io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType
    getTableType()
    Get the table type.
    static EnterpriseTableKey
    ofHistorical(@NotNull String namespace, @NotNull String tableName, io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType tableType)
    Create an EnterpriseTableKey for a historical table.
    static EnterpriseTableKey
    ofTicking(@NotNull String namespace, @NotNull String tableName, io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType tableType)
    Create an EnterpriseTableKey for an Intraday table.

    Methods inherited from interface io.deephaven.engine.table.impl.locations.ImmutableTableKey

    makeImmutable

    Methods inherited from interface io.deephaven.base.log.LogOutputAppendable

    append

    Methods inherited from interface io.deephaven.shadow.enterprise.com.fishlib.base.log.LogOutputAppendable

    append

    Methods inherited from interface io.deephaven.util.type.NamedImplementation

    getImplementationName

  • Field Details

  • Method Details

    • ofHistorical

      static EnterpriseTableKey ofHistorical(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType tableType)
      Create an EnterpriseTableKey for a historical table.
      Parameters:
      namespace - the namespace of the table
      tableName - the name of the table
      tableType - the TableType
      Returns:
      a new EnterpriseTableKey

    • ofTicking

      static EnterpriseTableKey ofTicking(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType tableType)
      Create an EnterpriseTableKey for an Intraday table.
      Parameters:
      namespace - the namespace of the table
      tableName - the name of the table
      tableType - the TableType
      Returns:
      a new EnterpriseTableKey

    • getNamespace

      @NotNull @NotNull String getNamespace()
      Get the namespace of the table.
      Returns:
      the namespace

    • getTableName

      @NotNull @NotNull String getTableName()
      Get the name of the table.
      Returns:
      the name of the table

    • getTableType

      @NotNull @NotNull io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableType getTableType()
      Get the table type.
      Returns:
      the TableType

    • adapt

      io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableKey adapt()
      Get an Enterprise formatted version of this EnterpriseTableKey, which will contain a V2 table type.
      Returns:
      an enterprise TableKey

    • adaptWithV1TableType

      io.deephaven.shadow.enterprise.com.illumon.iris.db.v2.locations.TableKey adaptWithV1TableType()
      Get an Enterprise formatted version of this EnterpriseTableKey, which will be logically equivalent, except for table type adapted to its V1 equivalent.
      Returns:
      an enterprise TableKey