org.apache.ignite.internal.processors.query

Class QueryUtils

java.lang.Object

org.apache.ignite.internal.processors.query.QueryUtils

public class QueryUtils
extends Object

Utility methods for queries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryUtils.KeyOrValProperty Property used for keyFieldName or valueFieldName

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLUMNS_COUNT
static char	DEFAULT_DELIM Default SQL delimeter.
static int	DFLT_INDEXING_DISCOVERY_HISTORY_SIZE
static String	DFLT_SCHEMA Default schema.
static boolean	INCLUDE_SENSITIVE Setting to true enables writing sensitive information in toString() output.
static ThreadLocal<Boolean>	INCLUDE_SENSITIVE_TL Enables IgniteSystemProperties.IGNITE_TO_STRING_INCLUDE_SENSITIVE mode for current thread.
static int	KEY_COL Key column.
static String	KEY_FIELD_NAME Field name for key.
static String	SCHEMA_INFORMATION Schema for system view.
static String	SCHEMA_SYS Schema for system view.
static char	SPACE_DELIM Space SQL delimeter.
static String	TEMPLATE_PARTITIONED Well-known template name for PARTITIONED cache.
static String	TEMPLATE_REPLICATED Well-known template name for REPLICATED cache.
static int	VAL_COL Value column.
static String	VAL_FIELD_NAME Field name for value.

Method Summary

Modifier and Type	Method and Description
static QueryBinaryProperty	buildBinaryProperty(GridKernalContext ctx, String pathStr, Class<?> resType, Map<String,String> aliases, boolean isKeyField, boolean notNull, Object dlftVal, int precision, int scale) Builds binary object property.
static QueryClassProperty	buildClassProperty(boolean key, Class<?> cls, String pathStr, Class<?> resType, Map<String,String> aliases, boolean notNull, CacheObjectContext coCtx)
static QueryClassProperty	buildClassProperty(Class<?> keyCls, Class<?> valCls, String pathStr, Class<?> resType, Map<String,String> aliases, boolean notNull, CacheObjectContext coCtx)
static GridQueryProperty	buildProperty(Class<?> keyCls, Class<?> valCls, String keyFieldName, String valueFieldName, String pathStr, Class<?> resType, Map<String,String> aliases, boolean notNull, CacheObjectContext coCtx)
static void	checkNotNullAllowed(CacheConfiguration cfg) Performs checks to forbid cache configurations that are not compatible with NOT NULL query fields.
static SchemaOperationException	checkQueryEntityConflicts(CacheConfiguration<?,?> ccfg, Collection<DynamicCacheDescriptor> descs) Check given CacheConfiguration for conflicts in table and index names from any query entities found in collection of DynamicCacheDescriptors and belonging to the same schema.
static QueryEntity	copy(QueryEntity entity) Copy query entity.
static QueryIndexDescriptorImpl	createIndexDescriptor(QueryTypeDescriptorImpl typeDesc, QueryIndex idx) Create index descriptor.
static String	createTableCacheName(String schemaName, String tblName) Construct cache name for table.
static String	createTableKeyTypeName(String valTypeName) Construct key type name for table.
static String	createTableValueTypeName(String schemaName, String tblName) Construct value type name for table.
static char	delimeter() Return space character as an SQL delimeter in case includeSensitive() is false to make output SQL one line.
static int	discoveryHistorySize() Discovery history size.
static String	fieldNameByAlias(QueryEntity entity, String alias) Get field name by alias.
static String	globalQueryId(UUID nodeId, long qryId) Get global query ID.
static boolean	includeSensitive()
static String	indexName(QueryEntity entity, QueryIndex idx) Get index name.
static String	indexName(String tblName, QueryIndex idx) Get index name.
static boolean	isCustomAffinityMapper(AffinityKeyMapper affinityKeyMapper) Checks whether affinity key mapper is custom or default.
static boolean	isEnabled(CacheConfiguration<?,?> ccfg)
static boolean	isGeometryClass(Class<?> cls) Checks if the given class is GEOMETRY.
static boolean	isSqlType(Class<?> cls) Checks if the given class can be mapped to a simple SQL type.
static boolean	matches(String str, String sqlPtrn) Checks whether string matches SQL pattern.
static @Nullable String	normalizeObjectName(@Nullable String str, boolean replace) Normalize object name.
static Collection<QueryEntity>	normalizeQueryEntities(Collection<QueryEntity> entities, CacheConfiguration<?,?> cfg) Normalize cache query entities.
static QueryEntity	normalizeQueryEntity(QueryEntity entity, boolean escape) Normalize query entity.
static String	normalizeSchemaName(String cacheName, @Nullable String schemaName) Stores rule for constructing schemaName according to cache configuration.
static void	processBinaryMeta(GridKernalContext ctx, QueryEntity qryEntity, QueryTypeDescriptorImpl d) Processes declarative metadata for binary object.
static void	processClassMeta(QueryEntity qryEntity, QueryTypeDescriptorImpl d, CacheObjectContext coCtx) Processes declarative metadata for binary object.
static void	processDynamicIndexChange(String idxName, @Nullable QueryIndex idx, QueryTypeDescriptorImpl d) Process dynamic index change.
static String	propertyInitializationExceptionMessage(Class<?> keyCls, Class<?> valCls, String pathStr, Class<?> resType) Exception message to compare in tests.
static boolean	removeField(QueryEntity entity, String alias) Remove field by alias.
static String	tableName(QueryEntity entity) Get table name for entity.
static @NotNull SQLException	toSqlException(Exception e) Converts exception in to IgniteSqlException.
static QueryTypeCandidate	typeForQueryEntity(GridKernalContext ctx, String cacheName, String schemaName, GridCacheContextInfo cacheInfo, QueryEntity qryEntity, List<Class<?>> mustDeserializeClss, boolean escape) Create type candidate for query entity.
static String	typeName(Class<?> cls) Gets type name by class.
static String	typeName(String clsName) Gets type name by class.
static SchemaOperationException	validateDropColumn(GridQueryTypeDescriptor type, String colName) Checks if given column can be removed from the table using its GridQueryTypeDescriptor.
static SchemaOperationException	validateDropColumn(QueryEntity entity, String fieldName, String colName) Checks if given column can be removed from table using its QueryEntity.
static int	validateTimeout(int timeout, TimeUnit timeUnit)
static boolean	wasCancelled(Throwable e) Returns true if the exception is triggered by query cancel.
static SqlFieldsQuery	withQueryTimeout(SqlFieldsQuery qry, int timeout, TimeUnit timeUnit)
static @Nullable SchemaOperationException	wrapIfNeeded(@Nullable Throwable e) Wrap schema exception if needed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLUMNS_COUNT

public static final int DEFAULT_COLUMNS_COUNT

See Also:

Constant Field Values

KEY_COL

public static final int KEY_COL

Key column.

See Also:

Constant Field Values

VAL_COL

public static final int VAL_COL

Value column.

See Also:

Constant Field Values

DFLT_SCHEMA

public static final String DFLT_SCHEMA

Default schema.

See Also:

Constant Field Values

SCHEMA_SYS

public static final String SCHEMA_SYS

Schema for system view.

SCHEMA_INFORMATION

public static final String SCHEMA_INFORMATION

Schema for system view.

See Also:

Constant Field Values

KEY_FIELD_NAME

public static final String KEY_FIELD_NAME

Field name for key.

See Also:

Constant Field Values

VAL_FIELD_NAME

public static final String VAL_FIELD_NAME

Field name for value.

See Also:

Constant Field Values

TEMPLATE_PARTITIONED

public static final String TEMPLATE_PARTITIONED

Well-known template name for PARTITIONED cache.

See Also:

Constant Field Values

TEMPLATE_REPLICATED

public static final String TEMPLATE_REPLICATED

Well-known template name for REPLICATED cache.

See Also:

Constant Field Values

DFLT_INDEXING_DISCOVERY_HISTORY_SIZE

public static final int DFLT_INDEXING_DISCOVERY_HISTORY_SIZE

See Also:

IgniteSystemProperties.IGNITE_INDEXING_DISCOVERY_HISTORY_SIZE, Constant Field Values

DEFAULT_DELIM

public static final char DEFAULT_DELIM

Default SQL delimeter.

See Also:

Constant Field Values

SPACE_DELIM

public static final char SPACE_DELIM

Space SQL delimeter.

See Also:

Constant Field Values

INCLUDE_SENSITIVE

public static boolean INCLUDE_SENSITIVE

Setting to true enables writing sensitive information in toString() output.

INCLUDE_SENSITIVE_TL

public static final ThreadLocal<Boolean> INCLUDE_SENSITIVE_TL

Enables IgniteSystemProperties.IGNITE_TO_STRING_INCLUDE_SENSITIVE mode for current thread. Note, setting INCL_SENS_TL to false will lead to generation of invalid SQL query. For example:
source query - "SELECT * FROM TBL WHERE name = 'Name'"
generated query - "SELECT * FROM TBL WHERE name = ?" - there is no parameter value in query.
It's a desired behaviour, because, when IgniteSystemProperties.IGNITE_TO_STRING_INCLUDE_SENSITIVE = false we want to filter out all sensitive data and those data can be sitting in SQL constants. Please, see GridSqlConst#getSQL(), IgniteH2Indexing#sqlWithoutConst(GridSqlStatement).

Method Detail

tableName

public static String tableName(QueryEntity entity)

Get table name for entity.

Parameters:

entity - Entity.

Returns:

Table name.

indexName

public static String indexName(QueryEntity entity,
                               QueryIndex idx)

Get index name.

Parameters:

entity - Query entity.

idx - Index.

Returns:

Index name.

indexName

public static String indexName(String tblName,
                               QueryIndex idx)

Get index name.

Parameters:

tblName - Table name.

idx - Index.

Returns:

Index name.

normalizeQueryEntities

public static Collection<QueryEntity> normalizeQueryEntities(Collection<QueryEntity> entities,
                                                             CacheConfiguration<?,?> cfg)

Normalize cache query entities.

Parameters:

entities - Query entities.

cfg - Cache config.

Returns:

Normalized query entities.

normalizeQueryEntity

public static QueryEntity normalizeQueryEntity(QueryEntity entity,
                                               boolean escape)

Normalize query entity. If "escape" flag is set, nothing changes. Otherwise we convert all object names to upper case and replace inner class separator characters ('$' for Java and '.' for .NET) with underscore.

Parameters:

entity - Query entity.

escape - Escape flag taken form configuration.

Returns:

Normalized query entity.

normalizeSchemaName

public static String normalizeSchemaName(String cacheName,
                                         @Nullable
                                         @Nullable String schemaName)

Stores rule for constructing schemaName according to cache configuration.

Parameters:

cacheName - Cache name.

schemaName - Schema name.

Returns:

Proper schema name according to ANSI-99 standard.

normalizeObjectName

@Nullable
public static @Nullable String normalizeObjectName(@Nullable
                                                             @Nullable String str,
                                                             boolean replace)

Normalize object name.

Parameters:

str - String.

replace - Whether to perform replace of special characters.

Returns:

Escaped string.

typeForQueryEntity

public static QueryTypeCandidate typeForQueryEntity(GridKernalContext ctx,
                                                    String cacheName,
                                                    String schemaName,
                                                    GridCacheContextInfo cacheInfo,
                                                    QueryEntity qryEntity,
                                                    List<Class<?>> mustDeserializeClss,
                                                    boolean escape)
                                             throws IgniteCheckedException

Create type candidate for query entity.

Parameters:

cacheName - Cache name.

schemaName - Schema name.

cacheInfo - Cache context info.

qryEntity - Query entity.

mustDeserializeClss - Classes which must be deserialized.

escape - Escape flag.

Returns:

Type candidate.

Throws:

IgniteCheckedException - If failed.

processBinaryMeta

public static void processBinaryMeta(GridKernalContext ctx,
                                     QueryEntity qryEntity,
                                     QueryTypeDescriptorImpl d)
                              throws IgniteCheckedException

Processes declarative metadata for binary object.

Parameters:

ctx - Kernal context.

qryEntity - Declared metadata.

d - Type descriptor.

Throws:

IgniteCheckedException - If failed.

processClassMeta

public static void processClassMeta(QueryEntity qryEntity,
                                    QueryTypeDescriptorImpl d,
                                    CacheObjectContext coCtx)
                             throws IgniteCheckedException

Processes declarative metadata for binary object.

Parameters:

qryEntity - Declared metadata.

d - Type descriptor.

Throws:

IgniteCheckedException - If failed.

processDynamicIndexChange

public static void processDynamicIndexChange(String idxName,
                                             @Nullable
                                             @Nullable QueryIndex idx,
                                             QueryTypeDescriptorImpl d)
                                      throws IgniteCheckedException

Process dynamic index change.

Parameters:

idx - Index.

d - Type descriptor to populate.

Throws:

IgniteCheckedException - If failed to build index information.

createIndexDescriptor

public static QueryIndexDescriptorImpl createIndexDescriptor(QueryTypeDescriptorImpl typeDesc,
                                                             QueryIndex idx)
                                                      throws IgniteCheckedException

Create index descriptor.

Parameters:

typeDesc - Type descriptor.

idx - Index.

Returns:

Index descriptor.

Throws:

IgniteCheckedException - If failed.

buildBinaryProperty

public static QueryBinaryProperty buildBinaryProperty(GridKernalContext ctx,
                                                      String pathStr,
                                                      Class<?> resType,
                                                      Map<String,String> aliases,
                                                      boolean isKeyField,
                                                      boolean notNull,
                                                      Object dlftVal,
                                                      int precision,
                                                      int scale)

Builds binary object property.

Parameters:

ctx - Kernal context.

pathStr - String representing path to the property. May contains dots '.' to identify nested fields.

resType - Result type.

aliases - Aliases.

isKeyField - Key ownership flag, true if this property is a field of the key object. Note that key not a field of itself.

notNull - true if null value is not allowed.

dlftVal - Default value.

precision - Precision.

scale - Scale.

Returns:

Binary property.

buildClassProperty

public static QueryClassProperty buildClassProperty(Class<?> keyCls,
                                                    Class<?> valCls,
                                                    String pathStr,
                                                    Class<?> resType,
                                                    Map<String,String> aliases,
                                                    boolean notNull,
                                                    CacheObjectContext coCtx)
                                             throws IgniteCheckedException

Parameters:

keyCls - Key class.

valCls - Value class.

pathStr - Path string.

resType - Result type.

aliases - Aliases.

notNull - true if null value is not allowed.

coCtx - Cache object context.

Returns:

Class property.

Throws:

IgniteCheckedException - If failed.

buildProperty

public static GridQueryProperty buildProperty(Class<?> keyCls,
                                              Class<?> valCls,
                                              String keyFieldName,
                                              String valueFieldName,
                                              String pathStr,
                                              Class<?> resType,
                                              Map<String,String> aliases,
                                              boolean notNull,
                                              CacheObjectContext coCtx)
                                       throws IgniteCheckedException

Parameters:

keyCls - Key class.

valCls - Value class.

keyFieldName - Key Field.

valueFieldName - Value Field.

pathStr - Path string.

resType - Result type.

aliases - Aliases.

notNull - true if null value is not allowed.

coCtx - Cache object context.

Returns:

Class property.

Throws:

IgniteCheckedException - If failed.

propertyInitializationExceptionMessage

public static String propertyInitializationExceptionMessage(Class<?> keyCls,
                                                            Class<?> valCls,
                                                            String pathStr,
                                                            Class<?> resType)

Exception message to compare in tests.

Parameters:

keyCls - key class

valCls - value class

pathStr - property name

resType - property type

Returns:

Exception message.

buildClassProperty

public static QueryClassProperty buildClassProperty(boolean key,
                                                    Class<?> cls,
                                                    String pathStr,
                                                    Class<?> resType,
                                                    Map<String,String> aliases,
                                                    boolean notNull,
                                                    CacheObjectContext coCtx)

Parameters:

key - If this is a key property.

cls - Source type class.

pathStr - String representing path to the property. May contains dots '.' to identify nested fields.

resType - Expected result type.

aliases - Aliases.

notNull - true if null value is not allowed.

coCtx - Cache object context.

Returns:

Property instance corresponding to the given path.

isSqlType

public static boolean isSqlType(Class<?> cls)

Checks if the given class can be mapped to a simple SQL type.

Parameters:

cls - Class.

Returns:

true If can.

isGeometryClass

public static boolean isGeometryClass(Class<?> cls)

Checks if the given class is GEOMETRY.

Parameters:

cls - Class.

Returns:

true If this is geometry.

typeName

public static String typeName(String clsName)

Gets type name by class.

Parameters:

clsName - Class name.

Returns:

Type name.

typeName

public static String typeName(Class<?> cls)

Gets type name by class.

Parameters:

cls - Class.

Returns:

Type name.

validateTimeout

public static int validateTimeout(int timeout,
                                  TimeUnit timeUnit)

Parameters:

timeout - Timeout.

timeUnit - Time unit.

Returns:

Converted time.

isEnabled

public static boolean isEnabled(CacheConfiguration<?,?> ccfg)

Parameters:

ccfg - Cache configuration.

Returns:

true If query index must be enabled for this cache.

discoveryHistorySize

public static int discoveryHistorySize()

Discovery history size.

Returns:

Discovery history size.

wrapIfNeeded

@Nullable
public static @Nullable SchemaOperationException wrapIfNeeded(@Nullable
                                                                        @Nullable Throwable e)

Wrap schema exception if needed.

Parameters:

e - Original exception.

Returns:

Schema exception.

checkQueryEntityConflicts

public static SchemaOperationException checkQueryEntityConflicts(CacheConfiguration<?,?> ccfg,
                                                                 Collection<DynamicCacheDescriptor> descs)

Check given CacheConfiguration for conflicts in table and index names from any query entities found in collection of DynamicCacheDescriptors and belonging to the same schema.

Parameters:

ccfg - New cache configuration.

descs - Cache descriptors.

Returns:

Exception message describing found conflict or null if none found.

createTableCacheName

public static String createTableCacheName(String schemaName,
                                          String tblName)

Construct cache name for table.

Parameters:

schemaName - Schema name.

tblName - Table name.

Returns:

Cache name.

createTableValueTypeName

public static String createTableValueTypeName(String schemaName,
                                              String tblName)

Construct value type name for table.

Parameters:

schemaName - Schema name.

tblName - Table name.

Returns:

Value type name.

createTableKeyTypeName

public static String createTableKeyTypeName(String valTypeName)

Construct key type name for table.

Parameters:

valTypeName - Value type name.

Returns:

Key type name.

copy

public static QueryEntity copy(QueryEntity entity)

Copy query entity.

Parameters:

entity - Query entity.

Returns:

Copied entity.

checkNotNullAllowed

public static void checkNotNullAllowed(CacheConfiguration cfg)

Performs checks to forbid cache configurations that are not compatible with NOT NULL query fields. See QueryEntity.setNotNullFields(Set).

Parameters:

cfg - Cache configuration.

isCustomAffinityMapper

public static boolean isCustomAffinityMapper(AffinityKeyMapper affinityKeyMapper)

Checks whether affinity key mapper is custom or default.

Parameters:

affinityKeyMapper - Affinity key mapper.

Returns:

true if affinity key mapper is custom.

validateDropColumn

public static SchemaOperationException validateDropColumn(QueryEntity entity,
                                                          String fieldName,
                                                          String colName)

Checks if given column can be removed from table using its QueryEntity.

Parameters:

entity - Query entity.

fieldName - Name of the field of the key or value object.

colName - Name of the column.

Returns:

null if it's OK to remove the column and exception otherwise.

validateDropColumn

public static SchemaOperationException validateDropColumn(GridQueryTypeDescriptor type,
                                                          String colName)

Checks if given column can be removed from the table using its GridQueryTypeDescriptor.

Parameters:

type - Type descriptor.

colName - Name of the column.

Returns:

null if it's OK to remove the column and exception otherwise.

wasCancelled

public static boolean wasCancelled(Throwable e)

Returns true if the exception is triggered by query cancel.

Parameters:

e - Exception.

Returns:

true if exception is caused by cancel.

toSqlException

@NotNull
public static @NotNull SQLException toSqlException(Exception e)

Converts exception in to IgniteSqlException.

Parameters:

e - Exception.

Returns:

IgniteSqlException.

globalQueryId

public static String globalQueryId(UUID nodeId,
                                   long qryId)

Get global query ID.

Parameters:

nodeId - Node ID.

qryId - Query ID.

Returns:

Global query ID.

matches

public static boolean matches(String str,
                              String sqlPtrn)

Checks whether string matches SQL pattern.

Parameters:

str - String.

sqlPtrn - Pattern.

Returns:

Whether string matches pattern.

fieldNameByAlias

public static String fieldNameByAlias(QueryEntity entity,
                                      String alias)

Get field name by alias.

Parameters:

entity - Query entity.

alias - Filed's alias.

Returns:

Field name.

removeField

public static boolean removeField(QueryEntity entity,
                                  String alias)

Remove field by alias.

Parameters:

entity - Query entity.

alias - Filed's alias.

Returns:

true if the field is removed. Otherwise returns false.

withQueryTimeout

public static SqlFieldsQuery withQueryTimeout(SqlFieldsQuery qry,
                                              int timeout,
                                              TimeUnit timeUnit)

Parameters:

qry - Query.

timeout - Timeout.

timeUnit - Time units.

includeSensitive

public static boolean includeSensitive()

Returns:

True if output sensitive data allowed.

delimeter

public static char delimeter()

Return space character as an SQL delimeter in case includeSensitive() is false to make output SQL one line. Default multiline SQL output looks ugly in system view and other view tool. See, GridSqlConst and IgniteH2Indexing#sqlWithoutConst() for details.

Returns:

Delimeter to use.