org.apache.calcite.rel.hint

Class HintPredicates

java.lang.Object

org.apache.calcite.rel.hint.HintPredicates

public abstract class HintPredicates
extends Object

Copied from Flink code base.

A collection of hint predicates.

Temporarily copy from calcite to cherry-pick [CALCITE-5107] and will be removed when upgrade the latest calcite.

Note: We need to copy to here from flink-table-planner for flink will use the HintPredicates to build HintStrategyTable. If we don't copy HintPredicates to here,it will use Calcite's HintPredicates to build HintStrategyTable with Hive dialect, which will then bring unexpected exception. Also can be removed when upgrade the latest calcite.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.calcite.rel.hint.HintPredicate	AGGREGATE A hint predicate that indicates a hint can only be used to Aggregate nodes.
static org.apache.calcite.rel.hint.HintPredicate	CALC A hint predicate that indicates a hint can only be used to Calc nodes.
static org.apache.calcite.rel.hint.HintPredicate	CORRELATE A hint predicate that indicates a hint can only be used to Correlate nodes.
static org.apache.calcite.rel.hint.HintPredicate	FILTER A hint predicate that indicates a hint can only be used to Filter nodes.
static org.apache.calcite.rel.hint.HintPredicate	JOIN A hint predicate that indicates a hint can only be used to Join nodes.
static org.apache.calcite.rel.hint.HintPredicate	PROJECT A hint predicate that indicates a hint can only be used to Project nodes.
static org.apache.calcite.rel.hint.HintPredicate	SET_VAR A hint predicate that indicates a hint can only be used to the whole query(no specific nodes).
static org.apache.calcite.rel.hint.HintPredicate	SETOP A hint predicate that indicates a hint can only be used to SetOp nodes.
static org.apache.calcite.rel.hint.HintPredicate	SNAPSHOT A hint predicate that indicates a hint can only be used to Snapshot nodes.
static org.apache.calcite.rel.hint.HintPredicate	SORT A hint predicate that indicates a hint can only be used to Sort nodes.
static org.apache.calcite.rel.hint.HintPredicate	TABLE_SCAN A hint predicate that indicates a hint can only be used to TableScan nodes.
static org.apache.calcite.rel.hint.HintPredicate	VALUES A hint predicate that indicates a hint can only be used to Values nodes.
static org.apache.calcite.rel.hint.HintPredicate	WINDOW A hint predicate that indicates a hint can only be used to Window nodes.

Constructor Summary

Constructors

Constructor and Description
HintPredicates()

Method Summary

Modifier and Type	Method and Description
static org.apache.calcite.rel.hint.HintPredicate	and(org.apache.calcite.rel.hint.HintPredicate... hintPredicates) Returns a composed hint predicate that represents a short-circuiting logical AND of an array of hint predicates hintPredicates.
static org.apache.calcite.rel.hint.HintPredicate	or(org.apache.calcite.rel.hint.HintPredicate... hintPredicates) Returns a composed hint predicate that represents a short-circuiting logical OR of an array of hint predicates hintPredicates.

Methods inherited from class java.lang.Object

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

Field Detail

SET_VAR

public static final org.apache.calcite.rel.hint.HintPredicate SET_VAR

A hint predicate that indicates a hint can only be used to the whole query(no specific nodes).

JOIN

public static final org.apache.calcite.rel.hint.HintPredicate JOIN

A hint predicate that indicates a hint can only be used to Join nodes.

TABLE_SCAN

public static final org.apache.calcite.rel.hint.HintPredicate TABLE_SCAN

A hint predicate that indicates a hint can only be used to TableScan nodes.

FILTER

public static final org.apache.calcite.rel.hint.HintPredicate FILTER

A hint predicate that indicates a hint can only be used to Filter nodes.

PROJECT

public static final org.apache.calcite.rel.hint.HintPredicate PROJECT

A hint predicate that indicates a hint can only be used to Project nodes.

CORRELATE

public static final org.apache.calcite.rel.hint.HintPredicate CORRELATE

A hint predicate that indicates a hint can only be used to Correlate nodes.

SETOP

public static final org.apache.calcite.rel.hint.HintPredicate SETOP

A hint predicate that indicates a hint can only be used to SetOp nodes.

SORT

public static final org.apache.calcite.rel.hint.HintPredicate SORT

A hint predicate that indicates a hint can only be used to Sort nodes.

AGGREGATE

public static final org.apache.calcite.rel.hint.HintPredicate AGGREGATE

A hint predicate that indicates a hint can only be used to Aggregate nodes.

CALC

public static final org.apache.calcite.rel.hint.HintPredicate CALC

A hint predicate that indicates a hint can only be used to Calc nodes.

VALUES

public static final org.apache.calcite.rel.hint.HintPredicate VALUES

A hint predicate that indicates a hint can only be used to Values nodes.

WINDOW

public static final org.apache.calcite.rel.hint.HintPredicate WINDOW

A hint predicate that indicates a hint can only be used to Window nodes.

SNAPSHOT

public static final org.apache.calcite.rel.hint.HintPredicate SNAPSHOT

A hint predicate that indicates a hint can only be used to Snapshot nodes.

Constructor Detail

HintPredicates

public HintPredicates()

Method Detail

and

public static org.apache.calcite.rel.hint.HintPredicate and(org.apache.calcite.rel.hint.HintPredicate... hintPredicates)

Returns a composed hint predicate that represents a short-circuiting logical AND of an array of hint predicates hintPredicates. When evaluating the composed predicate, if a predicate is false, then all the left predicates are not evaluated.

The predicates are evaluated in sequence.

or

public static org.apache.calcite.rel.hint.HintPredicate or(org.apache.calcite.rel.hint.HintPredicate... hintPredicates)

Returns a composed hint predicate that represents a short-circuiting logical OR of an array of hint predicates hintPredicates. When evaluating the composed predicate, if a predicate is true, then all the left predicates are not evaluated.

The predicates are evaluated in sequence.