Top Description Fields Constructors Methods
org.h2.table

public Class FunctionTable

extends VirtualConstructedTable
Class Inheritance
Imports
org.h2.engine.SessionLocal, org.h2.expression.function.table.TableFunction, org.h2.result.ResultInterface, org.h2.schema.Schema
A table backed by a system or user-defined function that returns a result set.

Field Summary

Modifier and TypeField and Description
private final TableFunction
function

Constructor Summary

AccessConstructor and Description
public
FunctionTable(Schema schema, SessionLocal session, TableFunction function)

Method Summary

Modifier and TypeMethod and Description
public boolean
canGetRowCount(SessionLocal
the session
session)

Implements abstract org.h2.table.Table.canGetRowCount.

Check if the row count can be retrieved quickly.

public ResultInterface
getResult(SessionLocal
the session
session)

Implements abstract org.h2.table.VirtualConstructedTable.getResult.

Read the rows from the table.

public long
getRowCount(SessionLocal
the session
session)

Implements abstract org.h2.table.Table.getRowCount.

Get the row count for this table.

public long
getRowCountApproximation(SessionLocal
the session
session)

Implements abstract org.h2.table.Table.getRowCountApproximation.

Get the approximated row count for this table.

public String
getSQL(int
formatting flags
sqlFlags)

Overrides org.h2.schema.SchemaObject.getSQL.

Overrides default org.h2.util.HasSQL.getSQL.

Get the SQL statement of this expression.

public StringBuilder
getSQL(StringBuilder
string builder
builder, int
formatting flags
sqlFlags)

Overrides org.h2.table.VirtualTable.getSQL.

Implements org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

public boolean
isDeterministic()

Implements abstract org.h2.table.Table.isDeterministic.

Check if the table is deterministic.

Inherited from org.h2.table.VirtualConstructedTable:
getMaxDataModificationIdgetScanIndex

Field Detail

functionback to summary
private final TableFunction function

Constructor Detail

FunctionTableback to summary
public FunctionTable(Schema schema, SessionLocal session, TableFunction function)

Method Detail

canGetRowCountback to summary
public boolean canGetRowCount(SessionLocal session)

Implements abstract org.h2.table.Table.canGetRowCount.

Doc from org.h2.table.Table.canGetRowCount.

Check if the row count can be retrieved quickly.

Parameters
session:SessionLocal

the session

Returns:boolean

true if it can

Annotations
@Override
getResultback to summary
public ResultInterface getResult(SessionLocal session)

Implements abstract org.h2.table.VirtualConstructedTable.getResult.

Doc from org.h2.table.VirtualConstructedTable.getResult.

Read the rows from the table.

Parameters
session:SessionLocal

the session

Returns:ResultInterface

the result

Annotations
@Override
getRowCountback to summary
public long getRowCount(SessionLocal session)

Implements abstract org.h2.table.Table.getRowCount.

Doc from org.h2.table.Table.getRowCount.

Get the row count for this table.

Parameters
session:SessionLocal

the session

Returns:long

the row count

Annotations
@Override
getRowCountApproximationback to summary
public long getRowCountApproximation(SessionLocal session)

Implements abstract org.h2.table.Table.getRowCountApproximation.

Doc from org.h2.table.Table.getRowCountApproximation.

Get the approximated row count for this table.

Parameters
session:SessionLocal

the session

Returns:long

the approximated row count

Annotations
@Override
getSQLback to summary
public String getSQL(int sqlFlags)

Overrides org.h2.schema.SchemaObject.getSQL.

Overrides default org.h2.util.HasSQL.getSQL.

Doc from org.h2.util.HasSQL.getSQL.

Get the SQL statement of this expression. This may not always be the original SQL statement, specially after optimization.

Parameters
sqlFlags:int

formatting flags

Returns:String

the SQL statement

Annotations
@Override
getSQLback to summary
public StringBuilder getSQL(StringBuilder builder, int sqlFlags)

Overrides org.h2.table.VirtualTable.getSQL.

Implements org.h2.util.HasSQL.getSQL.

Doc from org.h2.util.HasSQL.getSQL.

Appends the SQL statement of this object to the specified builder.

Parameters
builder:StringBuilder

string builder

sqlFlags:int

formatting flags

Returns:StringBuilder

the specified string builder

Annotations
@Override
isDeterministicback to summary
public boolean isDeterministic()

Implements abstract org.h2.table.Table.isDeterministic.

Doc from org.h2.table.Table.isDeterministic.

Check if the table is deterministic.

Returns:boolean

true if it is

Annotations
@Override