Package io.deephaven.engine.table

Interface DataIndexOptions

@Immutable
public interface DataIndexOptions

Options for controlling the function of a DataIndex.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataIndexOptions.Builder	The builder interface to construct a DataIndexOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final DataIndexOptions	DEFAULT	Static default options, which expect that operations will use the full table.
static final DataIndexOptions	USING_PARTIAL_TABLE	Static options for operations that use a partial table instead of the full table.

Method Summary

Modifier and Type	Method	Description
static DataIndexOptions.Builder	builder()	Create a new builder for a DataIndexOptions.
default boolean	operationUsesPartialTable()	Does this operation use only a subset of the DataIndex?

Field Details

DEFAULT

static final DataIndexOptions DEFAULT

Static default options, which expect that operations will use the full table.

USING_PARTIAL_TABLE

static final DataIndexOptions USING_PARTIAL_TABLE

Static options for operations that use a partial table instead of the full table.

Method Details

operationUsesPartialTable

@Default
default boolean operationUsesPartialTable()

Does this operation use only a subset of the DataIndex?

The DataIndex implementation may use this hint to defer work for some row sets.

Presently, this is used for the TableOperations.where(Filter) operation to hint that work for computing RowSets for non-matching keys should be deferred.

Returns:

if this operation is only going to use a subset of this data index

builder

static DataIndexOptions.Builder builder()

Create a new builder for a DataIndexOptions.

Returns: