Package se.kuseman.payloadbuilder.api.catalog

Class Catalog

java.lang.Object

se.kuseman.payloadbuilder.api.catalog.Catalog

public abstract class Catalog
extends Object

Catalog. Defines the hooking points for retrieving data, functions etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SYS_COLUMNS
protected static final String	SYS_COLUMNS_NAME
protected static final String	SYS_COLUMNS_TABLE
protected static final String	SYS_FUNCTIONS
protected static final String	SYS_FUNCTIONS_DESCRIPTION
protected static final String	SYS_FUNCTIONS_NAME
protected static final Schema	SYS_FUNCTIONS_SCHEMA
protected static final String	SYS_FUNCTIONS_TYPE
protected static final String	SYS_INDICES
protected static final String	SYS_INDICES_COLUMNS
protected static final String	SYS_INDICES_TABLE
protected static final String	SYS_TABLES
protected static final String	SYS_TABLES_NAME
static final String	SYSTEM_CATALOG_ALIAS

Constructor Summary

Constructors

Constructor	Description
Catalog(String name)

Method Summary

Modifier and Type	Method	Description
void	close()	Close catalog.
Map<String,Object>	getExecutionStatistics(IExecutionContext context)	Return summarized execution statistics for provided context.
Collection<FunctionInfo>	getFunctions()	Return registered functions for this catalog
protected TupleVector	getFunctionsTupleVector(Schema schema)	Return a functions tuple vector that can be used for getSystemTableDataSource(IQuerySession, String, QualifiedName, DatasourceData) when functions is requested.
String	getName()
OperatorFunctionInfo	getOperatorFunction(String name)	Get operator function info by name
ScalarFunctionInfo	getScalarFunction(String name)	Get scalar function info by name
IDatasource	getScanDataSource(IQuerySession session, String catalogAlias, QualifiedName table, DatasourceData data)	Create a scan IDatasource for provided table
IDatasource	getSeekDataSource(IQuerySession session, String catalogAlias, ISeekPredicate seekPredicate, DatasourceData data)	Create a seek IDatasource for provided predicate
IDatasource	getSystemTableDataSource(IQuerySession session, String catalogAlias, QualifiedName table, DatasourceData data)	Get system datasource for provided table.
TableSchema	getSystemTableSchema(IQuerySession session, String catalogAlias, QualifiedName table)	Return table schema for a system table
TableFunctionInfo	getTableFunction(String name)	Get table function info by name
TableSchema	getTableSchema(IQuerySession session, String catalogAlias, QualifiedName table)	Deprecated. Use #getTableSchema(IExecutionContext, String, QualifiedName, List) instead
TableSchema	getTableSchema(IQuerySession session, String catalogAlias, QualifiedName table, List<Option> options)	Return the table schema information for provided table.
protected void	registerFunction(FunctionInfo functionInfo)	Register function

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_CATALOG_ALIAS

public static final String SYSTEM_CATALOG_ALIAS

See Also:

• Constant Field Values

SYS_TABLES

protected static final String SYS_TABLES

See Also:

• Constant Field Values

SYS_TABLES_NAME

protected static final String SYS_TABLES_NAME

See Also:

• Constant Field Values

SYS_COLUMNS

protected static final String SYS_COLUMNS

See Also:

• Constant Field Values

SYS_COLUMNS_NAME

protected static final String SYS_COLUMNS_NAME

See Also:

• Constant Field Values

SYS_COLUMNS_TABLE

protected static final String SYS_COLUMNS_TABLE

See Also:

• Constant Field Values

SYS_FUNCTIONS

protected static final String SYS_FUNCTIONS

See Also:

• Constant Field Values

SYS_FUNCTIONS_NAME

protected static final String SYS_FUNCTIONS_NAME

See Also:

• Constant Field Values

SYS_FUNCTIONS_DESCRIPTION

protected static final String SYS_FUNCTIONS_DESCRIPTION

See Also:

• Constant Field Values

SYS_FUNCTIONS_TYPE

protected static final String SYS_FUNCTIONS_TYPE

See Also:

• Constant Field Values

SYS_INDICES

protected static final String SYS_INDICES

See Also:

• Constant Field Values

SYS_INDICES_TABLE

protected static final String SYS_INDICES_TABLE

See Also:

• Constant Field Values

SYS_INDICES_COLUMNS

protected static final String SYS_INDICES_COLUMNS

See Also:

• Constant Field Values

SYS_FUNCTIONS_SCHEMA

protected static final Schema SYS_FUNCTIONS_SCHEMA

Constructor Details

Catalog

public Catalog(String name)

Method Details

getName

public String getName()

getTableSchema

@Deprecated
public TableSchema getTableSchema(IQuerySession session,
 String catalogAlias,
 QualifiedName table)

Deprecated.

Use #getTableSchema(IExecutionContext, String, QualifiedName, List) instead

Return the table schema information for provided table.

getTableSchema

public TableSchema getTableSchema(IQuerySession session,
 String catalogAlias,
 QualifiedName table,
 List<Option> options)

Return the table schema information for provided table.

getScanDataSource

public IDatasource getScanDataSource(IQuerySession session,
 String catalogAlias,
 QualifiedName table,
 DatasourceData data)

Create a scan IDatasource for provided table

getSeekDataSource

public IDatasource getSeekDataSource(IQuerySession session,
 String catalogAlias,
 ISeekPredicate seekPredicate,
 DatasourceData data)

Create a seek IDatasource for provided predicate

getSystemTableDataSource

public IDatasource getSystemTableDataSource(IQuerySession session,
 String catalogAlias,
 QualifiedName table,
 DatasourceData data)

 Get system datasource for provided table.
 This method should return a system operator for various system tables like:
  - tables
     - Return tables in catalog
     - Preferable to return at least one column 'name'
  - columns
     - Return columns in catalog
     - Preferable to return at least two columns 'table', 'name'
  - indices
     - Return indices in catalog
     - Preferable to return at least two columns 'table', 'columns'
  - functions
     - Return functions in catalog
     - Preferable to return at least two columns 'name', 'description'

 NOTE! It's optional to implement this method, but it's a good way to expose
       things that the catalog supports
 NOTE! It's perfectly fine to support other system tables than listed above
 NOTE! The provided query session is not the session used when executing the query it's provided from IDatasource
 

getSystemTableSchema

public TableSchema getSystemTableSchema(IQuerySession session,
 String catalogAlias,
 QualifiedName table)

Return table schema for a system table

getExecutionStatistics

public Map<String,Object> getExecutionStatistics(IExecutionContext context)

Return summarized execution statistics for provided context. This is executed after an ANALZYE query and lets catalogs aggregate data for all it's datasources

getFunctions

public Collection<FunctionInfo> getFunctions()

Return registered functions for this catalog

registerFunction

protected void registerFunction(FunctionInfo functionInfo)

Register function

getScalarFunction

public ScalarFunctionInfo getScalarFunction(String name)

Get scalar function info by name

getTableFunction

public TableFunctionInfo getTableFunction(String name)

Get table function info by name

getOperatorFunction

public OperatorFunctionInfo getOperatorFunction(String name)

Get operator function info by name

getFunctionsTupleVector

protected TupleVector getFunctionsTupleVector(Schema schema)

Return a functions tuple vector that can be used for getSystemTableDataSource(IQuerySession, String, QualifiedName, DatasourceData) when functions is requested.

close

public void close()

Close catalog. Is called by clients to shut down to be able to close resources etc.