Package io.deephaven.enterprise.schema

Interface Schema

All Known Subinterfaces:
SchemaInternal
All Known Implementing Classes:
DeephavenSchema, InvalidSchema, Schema.AbstractSchema, Schema.Delegating
public interface Schema
This defines a minimal interface with commonly accessed scheme-related methods

  • Method Details

    • of

      static Schema of(@NotNull io.deephaven.shadow.enterprise.com.illumon.iris.db.schema.Schema legacySchema)
      Construct a Schema instance which delegates to a legacy instance
      Parameters:
      legacySchema - a Legacy Schema instance to which we will delegate most work
      Returns:
      a new Schema instance

    • getNamespace

      @NotNull @NotNull String getNamespace()
      Gets the namespace of the table
      Returns:
      The namespace of the table

    • getTableName

      @NotNull @NotNull String getTableName()
      Gets the name of the table
      Returns:
      The name of the table

    • getNamespaceSet

      @NotNull @NotNull NamespaceSet getNamespaceSet()
      Gets the NamespaceSet to which this schema belongs
      Returns:
      The NamespaceSet to which this schema belongs

    • getTableDefinition

      @NotNull @NotNull TableDefinition getTableDefinition()
      Gets the TableDefinition corresponding to this Schema
      Returns:
      The TableDefinition corresponding to this Schema

    • getVersion

      @NotNull @NotNull SchemaVersion getVersion()
      Gets the version information of this schema
      Returns:
      The version of this schema

    • getColumnDescriptions

      @NotNull @NotNull Map<String,String> getColumnDescriptions()
      Get an unmodifiable map of column names to column descriptions. Columns which do not have a description defined may not be represented in the map.
      Returns:
      A map of column names to column descriptions

    • getTableDescription

      @NotNull @NotNull String getTableDescription()
      Gets the table description from the schema.
      Returns:
      The table description from the schema.

    • getInputTableStateSpec

      Optional<InputTableStateSpec> getInputTableStateSpec()
      Return the input table specification from this schema.
      Returns:
      The input table specification if present, or null.