Package io.deephaven.enterprise.database

Interface Database

All Known Subinterfaces:
DatabaseInternal
All Known Implementing Classes:
DatabaseImpl
@ScriptApi public interface Database
This interface presents a view of the data store for the system in both Live, and Historical versions.

  • Method Details

    • liveTable

      @ScriptApi @FinalDefault default Table liveTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Fetch a live Table for the specified namespace and table name.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      a new live Table for the specified parameters.

    • liveTable

      @ScriptApi Table liveTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull TableOptions options)
      Fetch a live Table for the specified namespace and table name.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      options - a TableOptions to set table options.
      Returns:
      a new live Table for the specified parameters.

    • livePartitionedTable

      @ScriptApi @FinalDefault default PartitionedTable livePartitionedTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Retrieve the specified live table as a PartitionedTable from the Database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      a new PartitionedTable for the specified table

    • livePartitionedTable

      @ScriptApi PartitionedTable livePartitionedTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull TableOptions options)
      Retrieve the specified live table as a PartitionedTable from the Database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      options - a TableOptions to set table options.
      Returns:
      a new PartitionedTable for the specified table

    • historicalTable

      @ScriptApi @FinalDefault default Table historicalTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Fetch a static historical Table from the database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      a new static Table for the specified parameters.

    • historicalTable

      @ScriptApi Table historicalTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull TableOptions options)
      Fetch a static historical Table from the database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      options - a TableOptions to set table options.
      Returns:
      a new static Table for the specified parameters.

    • historicalPartitionedTable

      @ScriptApi @FinalDefault default PartitionedTable historicalPartitionedTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Retrieve the specified historical table as a PartitionedTable from the Database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      a new PartitionedTable for the specified table

    • historicalPartitionedTable

      @ScriptApi PartitionedTable historicalPartitionedTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull TableOptions options)
      Retrieve the specified historical table as a PartitionedTable from the Database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      options - a TableOptions to set table options.
      Returns:
      a new PartitionedTable for the specified table

    • getTableDefinition

      @ScriptApi TableDefinition getTableDefinition(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Fetch a TableDefinition from the database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      the TableDefinition for the specified parameters.

    • getTableDefinitionTable

      @ScriptApi Table getTableDefinitionTable(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Fetch a table's definition table from the database.
      Parameters:
      namespace - the Namespace in which the table exists
      tableName - the name of the table in the Namespace.
      Returns:
      a Table of the column definitions for the specified parameters.

    • getNamespaces

      @ScriptApi Collection<String> getNamespaces()
      Get the available namespaces.
      Returns:
      the list of namespaces

    • getTableNames

      @ScriptApi Collection<String> getTableNames(String namespace)
      Get the tables within a namespace
      Parameters:
      namespace - the namespace to interrogate
      Returns:
      the list of tables within namespace

    • getCatalogTable

      @ScriptApi Table getCatalogTable()
      Retrieve a table containing the tables that exist in this database.

      The returned table has a column for "Namespace", "Tablename" and "NamespaceSet".

      Returns:
      a table containing the tables that exist in this database.