Package org.apache.calcite.sql.validate

Interface SemanticTable

All Known Implementing Classes:

MockCatalogReader.MustFilterMockTable

public interface SemanticTable

Extension to SqlValidatorTable with extra, optional metadata.

Used to flag individual columns as 'must-filter'.

Method Summary

Modifier and Type	Method	Description
default List<Integer>	bypassFieldList()	Returns a list of column ordinals (0-based) of fields that defuse must-filter columns when filtered on.
default @Nullable String	getFilter(int column)	Returns the filter expression for column if it is a must-filter column, or null if it is not a must-filter column.
default boolean	mustFilter(int column)	Returns whether column must be filtered in any query that references this table.

Method Details

getFilter

default @Nullable String getFilter(int column)

Returns the filter expression for column if it is a must-filter column, or null if it is not a must-filter column.

Parameters:

column - Column ordinal (0-based)

Throws:

IndexOutOfBoundsException - if column ordinal is out of range

mustFilter

default boolean mustFilter(int column)

Returns whether column must be filtered in any query that references this table.

Parameters:

column - Column ordinal (0-based)

Throws:

IndexOutOfBoundsException - if column ordinal is out of range

bypassFieldList

default List<Integer> bypassFieldList()

Returns a list of column ordinals (0-based) of fields that defuse must-filter columns when filtered on.