Package io.deephaven.engine.table.impl

Class PushdownResult

java.lang.Object

io.deephaven.engine.table.impl.PushdownResult

All Implemented Interfaces:

SafeCloseable, AutoCloseable

public final class PushdownResult
extends Object
implements SafeCloseable

Records the results of a push-down predicate filter operation.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	LOCATION_DEFERRED_DATA_INDEX_COST	Loads and filters a location-level index.
static final long	LOCATION_IN_MEMORY_DATA_INDEX_COST	Filters an already-materialized location-level index.
static final long	REGION_BLOOM_FILTER_COST	Loads and uses Bloom filters.
static final long	REGION_DICTIONARY_DATA_COST	Loads and reads a dictionary to determine matches.
static final long	REGION_METADATA_STATS_COST	Loads and uses region metadata (min/max/null_count, etc.).
static final long	REGION_SINGLE_VALUE_COST	The entire region contains a single value, so a single read is sufficient to determine matches.
static final long	REGION_SORTED_DATA_COST	Binary searches sorted data.
static final long	TABLE_IN_MEMORY_DATA_INDEX_COST	Filters an already-materialized Table-level index.
static final long	TABLE_SINGLE_VALUE_COLUMN_COST	The entire column contains a single in memory value, so a single read is sufficient to determine matches.
static final long	TABLE_SORTED_DATA_COST	Binary searches sorted data at the Table-level.
static final long	UNSUPPORTED_ACTION_COST	The estimated cost when the filter cannot or should not be pushed down.

Method Summary

Modifier and Type	Method	Description
static PushdownResult	allMatch(@NotNull RowSet selection)	Constructs a new result with all of selection as match.
static PushdownResult	allMaybeMatch(@NotNull RowSet selection)	Constructs a new result with all of selection as maybeMatch.
void	close()	Closes match() and maybeMatch().
PushdownResult	copy()	Creates a copy of this.
WritableRowSet	match()	Rows that are known to match.
WritableRowSet	maybeMatch()	Rows that may match.
static PushdownResult	noneMatch(@NotNull RowSet selection)	Constructs a new result with no match nor maybeMatch rows.
static PushdownResult	of(@NotNull RowSet selection, @NotNull RowSet match, @NotNull RowSet maybeMatch)	Constructs a new result with selection, match, and maybeMatch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UNSUPPORTED_ACTION_COST

public static final long UNSUPPORTED_ACTION_COST

The estimated cost when the filter cannot or should not be pushed down.

See Also:

• Constant Field Values

TABLE_SINGLE_VALUE_COLUMN_COST

public static final long TABLE_SINGLE_VALUE_COLUMN_COST

The entire column contains a single in memory value, so a single read is sufficient to determine matches.

Complexity/access: O(1) / In-Memory Data, resolves "yes", "no"

TABLE_SORTED_DATA_COST

public static final long TABLE_SORTED_DATA_COST

Binary searches sorted data at the Table-level.

Complexity/access: O(log(rows)) / In-Memory or Storage Data, resolves "yes", "no"

TABLE_IN_MEMORY_DATA_INDEX_COST

public static final long TABLE_IN_MEMORY_DATA_INDEX_COST

Filters an already-materialized Table-level index.

Complexity/access: O(rows / 4) / In-Memory Data, resolves "yes", "no"

REGION_SINGLE_VALUE_COST

public static final long REGION_SINGLE_VALUE_COST

The entire region contains a single value, so a single read is sufficient to determine matches. Requires additional overhead in applying the filter (e.g. chunk/context/dummy table creation).

Complexity/access: O(regions) / In-Memory Data, resolves "yes", "no"

LOCATION_IN_MEMORY_DATA_INDEX_COST

public static final long LOCATION_IN_MEMORY_DATA_INDEX_COST

Filters an already-materialized location-level index. Requires filter copying and initialization per region compared to table-level.

Complexity/access: O(rows / 4) / In-Memory Access, resolves "yes", "no"

REGION_METADATA_STATS_COST

public static final long REGION_METADATA_STATS_COST

Loads and uses region metadata (min/max/null_count, etc.).

Complexity/access: O(regions) / Storage Data, resolves "no", "maybe"

REGION_BLOOM_FILTER_COST

public static final long REGION_BLOOM_FILTER_COST

Loads and uses Bloom filters.

Complexity/access: O(regions) / Storage Data, resolves "no", "maybe"

LOCATION_DEFERRED_DATA_INDEX_COST

public static final long LOCATION_DEFERRED_DATA_INDEX_COST

Loads and filters a location-level index. Requires additional filter copying and initialization per region compared to table-level.

Complexity/access: O(rows / 4) / Storage Data, resolves "yes", "no"

REGION_SORTED_DATA_COST

public static final long REGION_SORTED_DATA_COST

Binary searches sorted data.

Complexity/access: O(log(rows)) / Storage Data, resolves "yes", "no"

REGION_DICTIONARY_DATA_COST

public static final long REGION_DICTIONARY_DATA_COST

Loads and reads a dictionary to determine matches.

Complexity/access: O(rows) / Storage Data, resolves "yes", "no" for dictionary regions ("maybe" otherwise)

Method Details

allMaybeMatch

public static PushdownResult allMaybeMatch(@NotNull
 @NotNull RowSet selection)

Constructs a new result with all of selection as maybeMatch. Semantically equivalent to of(selection, RowSetFactory.empty(), selection), but this method is preferred over that case as no preconditions need to be checked. selection must be the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer).

Parameters:

selection - the selection assigned to maybeMatch

Returns:

the result

See Also:

• of(RowSet, RowSet, RowSet)

allMatch

public static PushdownResult allMatch(@NotNull
 @NotNull RowSet selection)

Constructs a new result with all of selection as match. Semantically equivalent to of(selection, selection, RowSetFactory.empty()), but this method is preferred over that case as no preconditions need to be checked. selection must be the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer).

Parameters:

selection - the selection assigned to match

Returns:

the result

See Also:

• of(RowSet, RowSet, RowSet)

noneMatch

public static PushdownResult noneMatch(@NotNull
 @NotNull RowSet selection)

Constructs a new result with no match nor maybeMatch rows. Semantically equivalent to of(selection, RowSetFactory.empty(), RowSetFactory.empty()), but this method is preferred over that case as no preconditions need to be checked. selection must be the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer).

Parameters:

selection - the selection (representing the full "no match" case)

Returns:

the result

See Also:

• of(RowSet, RowSet, RowSet)

of

public static PushdownResult of(@NotNull
 @NotNull RowSet selection,
 @NotNull
 @NotNull RowSet match,
 @NotNull
 @NotNull RowSet maybeMatch)

Constructs a new result with selection, match, and maybeMatch. match and maybeMatch must be non-overlapping subsets of selection, but this may not be thoroughly checked. selection must be the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer).

Parameters:

selection - the selection

match - rows that match

maybeMatch - rows that might match

Returns:

the result

match

public WritableRowSet match()

Rows that are known to match. Is a subset of the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer). Does not overlap with maybeMatch nor noMatch. Ownership does not transfer to the caller.

maybeMatch

public WritableRowSet maybeMatch()

Rows that may match. Is a subset of the selection from PushdownFilterMatcher.pushdownFilter(WhereFilter, RowSet, boolean, PushdownFilterContext, long, JobScheduler, Consumer, Consumer). Does not overlap with match nor noMatch. Ownership does not transfer to the caller.

copy

public PushdownResult copy()

Creates a copy of this.

Returns:

the copy

close

public void close()

Closes match() and maybeMatch().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SafeCloseable