org.apache.ignite.internal.processors.query.schema.management

Class SchemaManager

java.lang.Object

org.apache.ignite.internal.processors.query.schema.management.SchemaManager

public class SchemaManager
extends Object

Schema manager. Responsible for all manipulations on schema objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SQL_IDXS_VIEW
static String	SQL_IDXS_VIEW_DESC
static String	SQL_SCHEMA_VIEW
static String	SQL_SCHEMA_VIEW_DESC
static String	SQL_TBL_COLS_VIEW
static String	SQL_TBL_COLS_VIEW_DESC
static String	SQL_TBLS_VIEW
static String	SQL_TBLS_VIEW_DESC
static String	SQL_VIEW_COLS_VIEW
static String	SQL_VIEW_COLS_VIEW_DESC
static String	SQL_VIEWS_VIEW
static String	SQL_VIEWS_VIEW_DESC

Constructor Summary

Constructors

Constructor and Description
SchemaManager(GridKernalContext ctx) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addColumn(String schemaName, String tblName, List<QueryField> cols, boolean ifTblExists, boolean ifColNotExists) Add column.
void	addIndex(TableDescriptor tbl, IndexDescriptor idxDesc) Add index to the schema.
Collection<IndexDescriptor>	allIndexes()
@Nullable GridCacheContextInfo<?,?>	cacheInfo(String cacheName) Find registered cache info by it's name.
boolean	clearCacheContext(GridCacheContext<?,?> cctx) Clear cache context on call cache.close() on non-affinity node.
Collection<ColumnInformation>	columnsInformation(String schemaNamePtrn, String tblNamePtrn, String colNamePtrn) Return column information filtered by given patterns.
void	createIndex(String schemaName, String tblName, QueryIndexDescriptorImpl idxDesc, boolean ifNotExists, SchemaIndexCacheVisitor cacheVisitor) Create index dynamically.
void	createSystemView(String schema, SystemView<?> view) Registers new system view.
void	dropColumn(String schemaName, String tblName, List<String> cols, boolean ifTblExists, boolean ifColExists) Drop column.
void	dropIndex(String schemaName, String idxName, boolean ifExists) Drop index.
static String	generateProxyIdxName(String idxName)
@Nullable IndexDescriptor	index(String schemaName, String idxName) Find index by it's identifier.
boolean	initCacheContext(GridCacheContext<?,?> cctx) Initialize table's cache context created for not started cache.
void	markIndexRebuild(String cacheName, boolean mark) Mark tables for index rebuild, so that their indexes are not used.
void	onCacheCreated(String cacheName, String schemaName, Class<?>[] sqlFuncs) Invoked when cache is created.
void	onCacheDestroyed(String cacheName, boolean rmvIdx, boolean clearIdx) Handle cache destroy.
void	onCacheTypeCreated(GridCacheContextInfo<?,?> cacheInfo, GridQueryTypeDescriptor type, boolean isSql) Registers new class description.
static void	registerIndexDescriptorFactory(QueryIndexType type, IndexDescriptorFactory factory) Register index descriptor factory for custom index type.
String	schemaName(String cacheName) Get schema name for cache.
Set<String>	schemaNames() Get schemas names.
void	start(String[] schemaNames) Handle node start.
void	stop() Handle node stop.
@Nullable TableDescriptor	table(String schemaName, String tblName) Find table by it's identifier.
Collection<TableDescriptor>	tablesForCache(String cacheName) Gets collection of table for given schema name.
Collection<TableInformation>	tablesInformation(String schemaNamePtrn, String tblNamePtrn, String... tblTypes) Return table information filtered by given patterns.
@Nullable GridQueryTypeDescriptor	typeDescriptorForType(String schemaName, String cacheName, String type) Get table descriptor.
static void	unregisterIndexDescriptorFactory(QueryIndexType type) Unregister index descriptor factory for custom index type.

Methods inherited from class java.lang.Object

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

Field Detail

SQL_SCHEMA_VIEW

public static final String SQL_SCHEMA_VIEW

See Also:

Constant Field Values

SQL_SCHEMA_VIEW_DESC

public static final String SQL_SCHEMA_VIEW_DESC

See Also:

Constant Field Values

SQL_TBLS_VIEW

public static final String SQL_TBLS_VIEW

See Also:

Constant Field Values

SQL_TBLS_VIEW_DESC

public static final String SQL_TBLS_VIEW_DESC

See Also:

Constant Field Values

SQL_VIEWS_VIEW

public static final String SQL_VIEWS_VIEW

See Also:

Constant Field Values

SQL_VIEWS_VIEW_DESC

public static final String SQL_VIEWS_VIEW_DESC

See Also:

Constant Field Values

SQL_IDXS_VIEW

public static final String SQL_IDXS_VIEW

See Also:

Constant Field Values

SQL_IDXS_VIEW_DESC

public static final String SQL_IDXS_VIEW_DESC

See Also:

Constant Field Values

SQL_TBL_COLS_VIEW

public static final String SQL_TBL_COLS_VIEW

SQL_TBL_COLS_VIEW_DESC

public static final String SQL_TBL_COLS_VIEW_DESC

See Also:

Constant Field Values

SQL_VIEW_COLS_VIEW

public static final String SQL_VIEW_COLS_VIEW

SQL_VIEW_COLS_VIEW_DESC

public static final String SQL_VIEW_COLS_VIEW_DESC

See Also:

Constant Field Values

Constructor Detail

SchemaManager

public SchemaManager(GridKernalContext ctx)

Constructor.

Parameters:

ctx - Kernal context.

Method Detail

registerIndexDescriptorFactory

public static void registerIndexDescriptorFactory(QueryIndexType type,
                                                  IndexDescriptorFactory factory)

Register index descriptor factory for custom index type.

unregisterIndexDescriptorFactory

public static void unregisterIndexDescriptorFactory(QueryIndexType type)

Unregister index descriptor factory for custom index type.

start

public void start(String[] schemaNames)
           throws IgniteCheckedException

Handle node start.

Parameters:

schemaNames - Schema names.

Throws:

IgniteCheckedException

stop

public void stop()

Handle node stop.

createSystemView

public void createSystemView(String schema,
                             SystemView<?> view)

Registers new system view.

Parameters:

schema - Schema to create view in.

view - System view.

onCacheCreated

public void onCacheCreated(String cacheName,
                           String schemaName,
                           Class<?>[] sqlFuncs)
                    throws IgniteCheckedException

Invoked when cache is created.

Parameters:

cacheName - Cache name.

schemaName - Schema name.

sqlFuncs - Custom SQL functions.

Throws:

IgniteCheckedException - If failed.

onCacheTypeCreated

public void onCacheTypeCreated(GridCacheContextInfo<?,?> cacheInfo,
                               GridQueryTypeDescriptor type,
                               boolean isSql)
                        throws IgniteCheckedException

Registers new class description.

Parameters:

cacheInfo - Cache info.

type - Type descriptor.

isSql - Whether SQL enabled.

Throws:

IgniteCheckedException - If failed.

onCacheDestroyed

public void onCacheDestroyed(String cacheName,
                             boolean rmvIdx,
                             boolean clearIdx)

Handle cache destroy.

Parameters:

cacheName - Cache name.

rmvIdx - Whether to remove indexes.

clearIdx - Whether to clear the index.

schemaName

public String schemaName(String cacheName)

Get schema name for cache.

Parameters:

cacheName - Cache name.

Returns:

Schema name.

schemaNames

public Set<String> schemaNames()

Get schemas names.

Returns:

Schemas names.

generateProxyIdxName

public static String generateProxyIdxName(String idxName)

createIndex

public void createIndex(String schemaName,
                        String tblName,
                        QueryIndexDescriptorImpl idxDesc,
                        boolean ifNotExists,
                        SchemaIndexCacheVisitor cacheVisitor)
                 throws IgniteCheckedException

Create index dynamically.

Parameters:

schemaName - Schema name.

tblName - Table name.

idxDesc - Index descriptor.

ifNotExists - If-not-exists.

cacheVisitor - Cache visitor.

Throws:

IgniteCheckedException - If failed.

addIndex

public void addIndex(TableDescriptor tbl,
                     IndexDescriptor idxDesc)
              throws IgniteCheckedException

Add index to the schema.

Parameters:

tbl - Table descriptor.

idxDesc - Index descriptor.

Throws:

IgniteCheckedException

dropIndex

public void dropIndex(String schemaName,
                      String idxName,
                      boolean ifExists)
               throws IgniteCheckedException

Drop index.

Parameters:

schemaName - Schema name.

idxName - Index name.

ifExists - If exists.

Throws:

IgniteCheckedException

addColumn

public void addColumn(String schemaName,
                      String tblName,
                      List<QueryField> cols,
                      boolean ifTblExists,
                      boolean ifColNotExists)
               throws IgniteCheckedException

Add column.

Parameters:

schemaName - Schema name.

tblName - Table name.

cols - Columns.

ifTblExists - If table exists.

ifColNotExists - If column not exists.

Throws:

IgniteCheckedException - If failed.

dropColumn

public void dropColumn(String schemaName,
                       String tblName,
                       List<String> cols,
                       boolean ifTblExists,
                       boolean ifColExists)
                throws IgniteCheckedException

Drop column.

Parameters:

schemaName - Schema name.

tblName - Table name.

cols - Columns.

ifTblExists - If table exists.

ifColExists - If column exists.

Throws:

IgniteCheckedException - If failed.

initCacheContext

public boolean initCacheContext(GridCacheContext<?,?> cctx)

Initialize table's cache context created for not started cache.

Parameters:

cctx - Cache context.

Returns:

true If context has been initialized.

clearCacheContext

public boolean clearCacheContext(GridCacheContext<?,?> cctx)

Clear cache context on call cache.close() on non-affinity node.

Parameters:

cctx - Cache context.

Returns:

true If context has been cleared.

markIndexRebuild

public void markIndexRebuild(String cacheName,
                             boolean mark)

Mark tables for index rebuild, so that their indexes are not used.

Parameters:

cacheName - Cache name.

mark - Mark/unmark flag, true if index rebuild started, false if finished.

typeDescriptorForType

@Nullable
public @Nullable GridQueryTypeDescriptor typeDescriptorForType(String schemaName,
                                                                         String cacheName,
                                                                         String type)

Get table descriptor.

Parameters:

schemaName - Schema name.

cacheName - Cache name.

type - Type name.

Returns:

Descriptor.

tablesForCache

public Collection<TableDescriptor> tablesForCache(String cacheName)

Gets collection of table for given schema name.

Parameters:

cacheName - Cache name.

Returns:

Collection of table descriptors.

cacheInfo

@Nullable
public @Nullable GridCacheContextInfo<?,?> cacheInfo(String cacheName)

Find registered cache info by it's name.

table

@Nullable
public @Nullable TableDescriptor table(String schemaName,
                                                 String tblName)

Find table by it's identifier.

Parameters:

schemaName - Schema name.

tblName - Table name.

Returns:

Table descriptor or null if none found.

index

@Nullable
public @Nullable IndexDescriptor index(String schemaName,
                                                 String idxName)

Find index by it's identifier.

Parameters:

schemaName - Schema name.

idxName - Index name.

Returns:

Index or null if none found.

allIndexes

public Collection<IndexDescriptor> allIndexes()

Returns:

Collection of all present index descriptors.

tablesInformation

public Collection<TableInformation> tablesInformation(String schemaNamePtrn,
                                                      String tblNamePtrn,
                                                      String... tblTypes)

Return table information filtered by given patterns.

Parameters:

schemaNamePtrn - Filter by schema name. Can be null to don't use the filter.

tblNamePtrn - Filter by table name. Can be null to don't use the filter.

tblTypes - Filter by table type. As Of now supported only 'TABLES' and 'VIEWS'. Can be null or empty to don't use the filter.

Returns:

Table information filtered by given patterns.

columnsInformation

public Collection<ColumnInformation> columnsInformation(String schemaNamePtrn,
                                                        String tblNamePtrn,
                                                        String colNamePtrn)

Return column information filtered by given patterns.

Parameters:

schemaNamePtrn - Filter by schema name. Can be null to don't use the filter.

tblNamePtrn - Filter by table name. Can be null to don't use the filter.

colNamePtrn - Filter by column name. Can be null to don't use the filter.

Returns:

Column information filtered by given patterns.