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	BLOOM_FILTER_COST	Column-level Bloom filter needs to be used
static final long	DEFERRED_DATA_INDEX_COST	Requires reading and querying an external index table
static final long	DICTIONARY_DATA_COST	Requires reading a dictionary to determine matches
static final long	IN_MEMORY_DATA_INDEX_COST	Requires querying an in-memory index structure
static final long	METADATA_STATS_COST	Only table/row-group statistics are checked, assuming the metadata is already loaded
static final long	SINGLE_VALUE_COLUMN_COST	The entire column contains a single value, so a single read is sufficient to determine matches.
static final long	SORTED_DATA_COST	Requires using binary search on sorted data

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.
static PushdownResult	allNoMatch(@NotNull RowSet selection)	Constructs a new result with no match nor maybeMatch rows.
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	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

SINGLE_VALUE_COLUMN_COST

public static final long SINGLE_VALUE_COLUMN_COST

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

See Also:

• Constant Field Values

METADATA_STATS_COST

public static final long METADATA_STATS_COST

Only table/row-group statistics are checked, assuming the metadata is already loaded

See Also:

• Constant Field Values

BLOOM_FILTER_COST

public static final long BLOOM_FILTER_COST

Column-level Bloom filter needs to be used

See Also:

• Constant Field Values

IN_MEMORY_DATA_INDEX_COST

public static final long IN_MEMORY_DATA_INDEX_COST

Requires querying an in-memory index structure

See Also:

• Constant Field Values

DICTIONARY_DATA_COST

public static final long DICTIONARY_DATA_COST

Requires reading a dictionary to determine matches

See Also:

• Constant Field Values

SORTED_DATA_COST

public static final long SORTED_DATA_COST

Requires using binary search on sorted data

See Also:

• Constant Field Values

DEFERRED_DATA_INDEX_COST

public static final long DEFERRED_DATA_INDEX_COST

Requires reading and querying an external index table

See Also:

• Constant Field Values

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)

allNoMatch

public static PushdownResult allNoMatch(@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