Package org.h2.table
Class TableFilter
java.lang.Object
org.h2.table.TableFilter
- All Implemented Interfaces:
ColumnResolver
A table filter represents a table that is used in a query. There is one such
object whenever a table (or view) is used in a query. For example the
following query has 2 table filters: SELECT * FROM TEST T1, TEST T2.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
A visitor that maps columns.static interface
A visitor for table filters. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private String
private static final int
private LinkedHashMap
<Column, Column> Map of common join columns, used for NATURAL joins and USING clause of other joins.private TableFilter
private Row
private SearchRow
private final IndexCursor
The filter used to walk through the index.private LinkedHashMap
<Column, String> Map of derived column names.private boolean
private Expression
Additional conditions that can't be used for index lookup, but for row filter for this table (ID=ID, NAME LIKE '%X%')private static final int
private boolean
private Expression
private final int
private Index
private final ArrayList
<IndexCondition> The index conditions used for direct index lookup (start or end).private final IndexHints
private static final TableFilter.TableFilterVisitor
A visitor that sets joinOuterIndirect to true.private TableFilter
The joined table (if there is one).private Expression
The complete join condition.private boolean
Whether this is an outer join.protected boolean
Whether this is a direct or indirect (nested) outer joinprivate int[]
private TableFilter
The nested joined table (if there is one).private static final int
static final Comparator
<TableFilter> Comparator that uses order in FROM clause as a sort key.private final int
private int
private final Select
private SessionLocal
private int
private final Table
private boolean
Indicates that this filter is used in the plan. -
Constructor Summary
ConstructorsConstructorDescriptionTableFilter
(SessionLocal session, Table table, String alias, boolean rightsChecked, Select select, int orderInFrom, IndexHints indexHints) Create a new table filter object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommonJoinColumns
(Column leftColumn, Column replacementColumn, TableFilter replacementFilter) Add a column to the common join column list for a left table filter.void
addCommonJoinColumnToExclude
(Column columnToExclude) Add an excluded column to the common join column list.void
addFilterCondition
(Expression condition, boolean isJoin) Add a filter condition.void
addIndexCondition
(IndexCondition condition) Add an index condition.void
addJoin
(TableFilter filter, boolean outer, Expression on) Add a joined table.private void
void
Create the index conditions for this filter if needed.findColumn
(String name) Get the column with the specified name.get()
Get the current row.getBestPlanItem
(SessionLocal s, TableFilter[] filters, int filter, AllColumnsForPlan allColumnsSet) Get the best plan item (index, cost) to use for the current join order.Get the column with the given name.getColumnName
(Column column) Get the name of the specified column.Column[]
Get the column list.Returns common join columns map.Returns common join columns table filter.private Value
getDelegatedValue
(Column column) getIndex()
getJoin()
int[]
getMasks()
int
Get the order number (index) of this table filter in the "from" clause of the query.getPlanSQL
(StringBuilder builder, boolean isJoin, int sqlFlags) Get the query execution plan text to use for this table filter and append it to the specified builder.Get the row id pseudo column, if there is one.Get the schema name or null.Get the select statement.Column[]
Get the system columns that this table understands.getTable()
Get the table alias name.Get the table filter.Get the value for the given column.boolean
Returns whether this column resolver has a derived column list.int
hashCode()
boolean
Are there any index conditions that involve IN(...).boolean
Check if the given column is an excluded common join column.boolean
boolean
Whether this is an outer joined table.boolean
Whether this is indirectly an outer joined table (nested within an inner join).boolean
Returns whether this is a table filter with implicit DUAL table for a SELECT without a FROM clause.boolean
(package private) boolean
isOk
(Expression condition) Whether the current value of the condition is true, or there is no condition.boolean
isUsed()
void
lock
(SessionLocal s) Lock the table.void
Map the columns and add the join condition.boolean
next()
Check if there are more rows to read.(package private) void
Optimize the full condition.void
prepare()
Prepare reading rows.void
Remove the filter condition.void
Remove the joined tablevoid
Remove the join condition.(package private) void
Remove all index conditions that are not used by the current index.void
reset()
Reset to the current position.void
Set the current row.void
void
setDerivedColumns
(ArrayList<String> derivedColumnNames) Set derived column list.void
setEvaluatable
(boolean evaluatable) void
setEvaluatable
(TableFilter filter, boolean b) Update the filter and join conditions of this and all joined tables with the information that the given table filter and all nested filter can now return rows or not.void
setFullCondition
(Expression condition) void
void
setNestedJoin
(TableFilter filter) Set a nested joined table.protected void
Set the state of this and all nested tables to the NULL row.void
setPlanItem
(PlanItem item) Set what plan item (index, cost, masks) to use.private void
Set all missing indexes to scan indexes recursively.void
setUsed
(boolean used) void
Start the query.toString()
void
visit
(TableFilter.TableFilterVisitor visitor) Visit this and all joined or nested table filters.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.h2.table.ColumnResolver
optimize
-
Field Details
-
BEFORE_FIRST
private static final int BEFORE_FIRST- See Also:
-
FOUND
private static final int FOUND- See Also:
-
AFTER_LAST
private static final int AFTER_LAST- See Also:
-
NULL_ROW
private static final int NULL_ROW- See Also:
-
ORDER_IN_FROM_COMPARATOR
Comparator that uses order in FROM clause as a sort key. -
JOI_VISITOR
A visitor that sets joinOuterIndirect to true. -
joinOuterIndirect
protected boolean joinOuterIndirectWhether this is a direct or indirect (nested) outer join -
session
-
table
-
select
-
alias
-
index
-
indexHints
-
masks
private int[] masks -
scanCount
private int scanCount -
evaluatable
private boolean evaluatable -
used
private boolean usedIndicates that this filter is used in the plan. -
cursor
The filter used to walk through the index. -
indexConditions
The index conditions used for direct index lookup (start or end). -
filterCondition
Additional conditions that can't be used for index lookup, but for row filter for this table (ID=ID, NAME LIKE '%X%') -
joinCondition
The complete join condition. -
currentSearchRow
-
current
-
state
private int state -
join
The joined table (if there is one). -
joinOuter
private boolean joinOuterWhether this is an outer join. -
nestedJoin
The nested joined table (if there is one). -
commonJoinColumns
Map of common join columns, used for NATURAL joins and USING clause of other joins. This map preserves original order of the columns. -
commonJoinColumnsFilter
-
commonJoinColumnsToExclude
-
foundOne
private boolean foundOne -
fullCondition
-
hashCode
private final int hashCode -
orderInFrom
private final int orderInFrom -
derivedColumnMap
Map of derived column names. This map preserves original order of the columns.
-
-
Constructor Details
-
TableFilter
public TableFilter(SessionLocal session, Table table, String alias, boolean rightsChecked, Select select, int orderInFrom, IndexHints indexHints) Create a new table filter object.- Parameters:
session
- the sessiontable
- the table from where to read dataalias
- the alias namerightsChecked
- true if rights are already checkedselect
- the select statementorderInFrom
- original order number (index) of this table filter inindexHints
- the index hints to be used by the query planner
-
-
Method Details
-
getOrderInFrom
public int getOrderInFrom()Get the order number (index) of this table filter in the "from" clause of the query.- Returns:
- the index (0, 1, 2,...)
-
getIndexCursor
-
getSelect
Description copied from interface:ColumnResolver
Get the select statement.- Specified by:
getSelect
in interfaceColumnResolver
- Returns:
- the select statement
-
getTable
-
lock
Lock the table. This will also lock joined tables.- Parameters:
s
- the session
-
getBestPlanItem
public PlanItem getBestPlanItem(SessionLocal s, TableFilter[] filters, int filter, AllColumnsForPlan allColumnsSet) Get the best plan item (index, cost) to use for the current join order.- Parameters:
s
- the sessionfilters
- all joined table filtersfilter
- the current table filter indexallColumnsSet
- the set of all columns- Returns:
- the best plan item
-
setPlanItem
Set what plan item (index, cost, masks) to use.- Parameters:
item
- the plan item
-
setScanIndexes
private void setScanIndexes()Set all missing indexes to scan indexes recursively. -
prepare
public void prepare()Prepare reading rows. This method will remove all index conditions that can not be used, and optimize the conditions. -
startQuery
Start the query. This will reset the scan counts.- Parameters:
s
- the session
-
reset
public void reset()Reset to the current position. -
next
public boolean next()Check if there are more rows to read.- Returns:
- true if there are
-
isNullRow
public boolean isNullRow() -
setNullRow
protected void setNullRow()Set the state of this and all nested tables to the NULL row. -
checkTimeout
private void checkTimeout() -
isOk
Whether the current value of the condition is true, or there is no condition.- Parameters:
condition
- the condition (null for no condition)- Returns:
- true if yes
-
get
Get the current row.- Returns:
- the current row, or null
-
set
Set the current row.- Parameters:
current
- the current row
-
getTableAlias
Get the table alias name. If no alias is specified, the table name is returned.- Specified by:
getTableAlias
in interfaceColumnResolver
- Returns:
- the alias name
-
addIndexCondition
Add an index condition.- Parameters:
condition
- the index condition
-
addFilterCondition
Add a filter condition.- Parameters:
condition
- the conditionisJoin
- if this is in fact a join condition
-
addJoin
Add a joined table.- Parameters:
filter
- the joined table filterouter
- if this is an outer joinon
- the join condition
-
setNestedJoin
Set a nested joined table.- Parameters:
filter
- the joined table filter
-
mapAndAddFilter
Map the columns and add the join condition.- Parameters:
on
- the condition
-
createIndexConditions
public void createIndexConditions()Create the index conditions for this filter if needed. -
getJoin
-
isJoinOuter
public boolean isJoinOuter()Whether this is an outer joined table.- Returns:
- true if it is
-
isJoinOuterIndirect
public boolean isJoinOuterIndirect()Whether this is indirectly an outer joined table (nested within an inner join).- Returns:
- true if it is
-
getPlanSQL
Get the query execution plan text to use for this table filter and append it to the specified builder.- Parameters:
builder
- string builder to append toisJoin
- if this is a joined tablesqlFlags
- formatting flags- Returns:
- the specified builder
-
removeUnusableIndexConditions
void removeUnusableIndexConditions()Remove all index conditions that are not used by the current index. -
getMasks
public int[] getMasks() -
getIndexConditions
-
getIndex
-
setIndex
-
setUsed
public void setUsed(boolean used) -
isUsed
public boolean isUsed() -
removeJoin
public void removeJoin()Remove the joined table -
getJoinCondition
-
removeJoinCondition
public void removeJoinCondition()Remove the join condition. -
getFilterCondition
-
removeFilterCondition
public void removeFilterCondition()Remove the filter condition. -
setFullCondition
-
optimizeFullCondition
void optimizeFullCondition()Optimize the full condition. This will add the full condition to the filter condition. -
setEvaluatable
Update the filter and join conditions of this and all joined tables with the information that the given table filter and all nested filter can now return rows or not.- Parameters:
filter
- the table filterb
- the new flag
-
setEvaluatable
public void setEvaluatable(boolean evaluatable) -
getSchemaName
Description copied from interface:ColumnResolver
Get the schema name or null.- Specified by:
getSchemaName
in interfaceColumnResolver
- Returns:
- the schema name or null
-
getColumns
Description copied from interface:ColumnResolver
Get the column list.- Specified by:
getColumns
in interfaceColumnResolver
- Returns:
- the column list
-
findColumn
Description copied from interface:ColumnResolver
Get the column with the specified name.- Specified by:
findColumn
in interfaceColumnResolver
- Parameters:
name
- the column name, must be a derived name if this column resolver has a derived column list- Returns:
- the column with the specified name, or
null
-
getColumnName
Description copied from interface:ColumnResolver
Get the name of the specified column.- Specified by:
getColumnName
in interfaceColumnResolver
- Parameters:
column
- column- Returns:
- column name
-
hasDerivedColumnList
public boolean hasDerivedColumnList()Description copied from interface:ColumnResolver
Returns whether this column resolver has a derived column list.- Specified by:
hasDerivedColumnList
in interfaceColumnResolver
- Returns:
true
if this column resolver has a derived column list,false
otherwise
-
getColumn
Get the column with the given name.- Parameters:
columnName
- the column nameifExists
- if (@code true) returnnull
if column does not exist- Returns:
- the column
- Throws:
DbException
- if the column was not found andifExists
isfalse
-
getSystemColumns
Get the system columns that this table understands. This is used for compatibility with other databases. The columns are only returned if the current mode supports system columns.- Specified by:
getSystemColumns
in interfaceColumnResolver
- Returns:
- the system columns
-
getRowIdColumn
Description copied from interface:ColumnResolver
Get the row id pseudo column, if there is one.- Specified by:
getRowIdColumn
in interfaceColumnResolver
- Returns:
- the row id column or null
-
getValue
Description copied from interface:ColumnResolver
Get the value for the given column.- Specified by:
getValue
in interfaceColumnResolver
- Parameters:
column
- the column- Returns:
- the value
-
getDelegatedValue
-
getTableFilter
Description copied from interface:ColumnResolver
Get the table filter.- Specified by:
getTableFilter
in interfaceColumnResolver
- Returns:
- the table filter
-
setAlias
-
setDerivedColumns
Set derived column list.- Parameters:
derivedColumnNames
- names of derived columns
-
toString
-
addCommonJoinColumns
public void addCommonJoinColumns(Column leftColumn, Column replacementColumn, TableFilter replacementFilter) Add a column to the common join column list for a left table filter.- Parameters:
leftColumn
- the column on the left sidereplacementColumn
- the column to use instead, may be the same as column on the left sidereplacementFilter
- the table filter for replacement columns
-
addCommonJoinColumnToExclude
Add an excluded column to the common join column list.- Parameters:
columnToExclude
- the column to exclude
-
getCommonJoinColumns
Returns common join columns map.- Returns:
- common join columns map, or
null
-
getCommonJoinColumnsFilter
Returns common join columns table filter.- Returns:
- common join columns table filter, or
null
-
isCommonJoinColumnToExclude
Check if the given column is an excluded common join column.- Parameters:
c
- the column to check- Returns:
- true if this is an excluded common join column
-
hashCode
public int hashCode() -
hasInComparisons
public boolean hasInComparisons()Are there any index conditions that involve IN(...).- Returns:
- whether there are IN(...) comparisons
-
getNestedJoin
-
visit
Visit this and all joined or nested table filters.- Parameters:
visitor
- the visitor
-
isEvaluatable
public boolean isEvaluatable() -
getSession
-
getIndexHints
-
isNoFromClauseFilter
public boolean isNoFromClauseFilter()Returns whether this is a table filter with implicit DUAL table for a SELECT without a FROM clause.- Returns:
- whether this is a table filter with implicit DUAL table
-