Package io.deephaven.enterprise.derivedtablewriter

Class DerivedTableWriter.PartitionedOptions

java.lang.Object
io.deephaven.enterprise.derivedtablewriter.DerivedTableWriter.PartitionedOptions
Enclosing class:
DerivedTableWriter
public static class DerivedTableWriter.PartitionedOptions extends Object
Represents options for partitioned table ingestion.

In particular, the PartitionedOptions determine how the column and internal partition are computed. By default, the source PartitionedTable is assumed to contain a TableLocationKey with one column partition and one internal partition that are propagated to the result table. You may also specify a fixed value or a key column for the column or internal partition.

  • Constructor Details

    • PartitionedOptions

      public PartitionedOptions()

  • Method Details

    • columnPartitionValue

      public DerivedTableWriter.PartitionedOptions columnPartitionValue(String columnPartition)
      Sets the fixed column partition value.

      If a column partition key column is already specified, throws an IllegalStateException. If neither columnPartitionKey nor columnPartitionValue is specified, then the PartitionedTable key must be a TableLocation, from which the columnPartition is extracted.

      Parameters:
      columnPartition - the fixed column partition value to set
      Returns:
      the PartitionedOptions object
      Throws:
      IllegalStateException - if both columnPartitionValue and columnPartitionKey are specified

    • internalPartitionValue

      public DerivedTableWriter.PartitionedOptions internalPartitionValue(String internalPartition)
      Sets the fixed internal partition value.

      If a internal partition key column is already specified, throws an IllegalStateException. If neither internalPartitionKey nor internalPartitionValue is specified, then the PartitionedTable key must be a TableLocation, from which the internalPartition is extracted.

      Parameters:
      internalPartition - the fixed internal partition value to set
      Returns:
      the PartitionedOptions object

    • columnPartitionKey

      public String columnPartitionKey()
      Retrieves the column partition key column name.

      If a column partition value is already specified, throws an IllegalStateException. If neither columnPartitionKey nor columnPartitionValue is specified, then the PartitionedTable key must be a TableLocation, from which the columnPartition is extracted.

      Returns:
      the column partition key column name

    • columnPartitionKey

      public DerivedTableWriter.PartitionedOptions columnPartitionKey(String columnName)
      Sets the column partition key column name.

      If a column partition value is already specified, throws an IllegalStateException.

      Parameters:
      columnName - the column partition key column name to set
      Returns:
      the PartitionedOptions object
      Throws:
      IllegalStateException - if both columnPartitionValue and columnPartitionKey are specified

    • internalPartitionKey

      public String internalPartitionKey()
      Retrieves the internal partition key column name.
      Returns:
      the internal partition key value

    • internalPartitionKey

      public DerivedTableWriter.PartitionedOptions internalPartitionKey(String internalPartitionKey)
      Sets the internal partition key column name.

      If a internal partition value is already specified, throws an IllegalStateException. If neither internalPartitionKey nor internalPartitionValue is specified, then the PartitionedTable key must be a TableLocation, from which the internalPartition is extracted.

      Parameters:
      internalPartitionKey - the internal partition key column name to set
      Returns:
      the PartitionedOptions object
      Throws:
      IllegalStateException - if both internalPartitionValue and internalPartitionKey are specified