org.apache.ignite.internal.processors.query.h2

Class H2Utils

java.lang.Object

org.apache.ignite.internal.processors.query.h2.H2Utils

public class H2Utils
extends Object

H2 utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BINARY_DEFAULT_PRECISION The default precision for a binary/varbinary value.
static int	BOOLEAN_DEFAULT_PRECISION The default precision for a boolean value (see ValueBoolean).
static int	BYTE_DEFAULT_PRECISION The default precision for a byte value (see ValueByte).
static int	DATE_DEFAULT_PRECISION The default precision for a date value (see ValueDate).
static int	DECIMAL_DEFAULT_PRECISION The default precision for a decimal value.
static int	DECIMAL_DEFAULT_SCALE The default scale for a decimal value.
static int	DFLT_HASH_JOIN_MAX_TABLE_SIZE Default hash join max table size.
static int	DOUBLE_DEFAULT_PRECISION The default precision for a double value (see ValueDouble).
static org.gridgain.internal.h2.table.IndexColumn[]	EMPTY_COLUMNS
static int	GEOMETRY_DEFAULT_PRECISION The default precision for a geometry value.
static String	IGNITE_SQL_ALLOW_IMPLICIT_PK Allow run CREATE TABLE statement without explicitly specifying a PK.
static int	INTEGER_DEFAULT_PRECISION The default precision for a integer value (see ValueInt).
static int	LONG_DEFAULT_PRECISION The default precision for a long value (see ValueLong).
static int	REAL_DEFAULT_PRECISION The default precision for real value (see ValueFloat).
static int	SHORT_DEFAULT_PRECISION The default precision for a short value (see ValueShort).
static int	STRING_DEFAULT_PRECISION The default precision for a char/varchar value.
static int	TIME_DEFAULT_PRECISION The default precision for a time value (see ValueTime).
static int	TIMESTAMP_DEFAULT_PRECISION The default precision for a timestamp value (see ValueTimestamp).
static int	TIMESTAMP_DEFAULT_SCALE The default scale for a timestamp value (see ValueTimestamp).
static List<GridQueryFieldMetadata>	UPDATE_RESULT_META Dummy metadata for update result.
static int	UUID_DEFAULT_PRECISION The default precision for a uuid value (see ValueUuid).

Method Summary

Modifier and Type	Method and Description
static void	addUniqueColumns(List<org.gridgain.internal.h2.table.IndexColumn> dest, List<org.gridgain.internal.h2.table.IndexColumn> src) Add only new columns to destination list.
static void	bindParameters(PreparedStatement stmt, @Nullable Collection<Object> params) Binds parameters to prepared statement.
static <Z> void	bubbleUp(Z[] arr, int off, Comparator<Z> cmp)
static long	calculateMemoryDelta(org.gridgain.internal.h2.value.ValueRow distinctRowKey, Object[] oldRow, Object[] newRow) Calculates memory delta when old row was replaced with a new one.
static boolean	checkAndStartNotStartedCache(GridKernalContext ctx, GridH2Table tbl) Check that given table has not started cache and start it for such case.
static void	checkQuery(IgniteH2Indexing idx, List<Integer> cacheIds, Collection<QueryTable> tbls) Check if query is valid.
static List<Integer>	collectCacheIds(IgniteH2Indexing idx, @Nullable Integer mainCacheId, Collection<QueryTable> tbls) Collect cache identifiers from two-step query.
static boolean	collectMvccEnabled(IgniteH2Indexing idx, List<Integer> cacheIds) Collect MVCC enabled flag.
static boolean	containsColumn(List<org.gridgain.internal.h2.table.IndexColumn> cols, org.gridgain.internal.h2.table.IndexColumn col)
static boolean	containsKeyColumn(GridH2RowDescriptor desc, List<org.gridgain.internal.h2.table.IndexColumn> cols) Check whether columns list contains key or key alias column.
static QueryContext	context(Connection c)
static QueryContext	context(org.gridgain.internal.h2.engine.Session ses)
static Object	convert(Object val, IgniteH2Indexing idx, int type) Convert value to column's expected type by means of H2.
static GridH2IndexBase	createSpatialIndex(GridH2Table tbl, String idxName, org.gridgain.internal.h2.table.IndexColumn[] cols) Create spatial index.
static boolean	equals(org.gridgain.internal.h2.table.IndexColumn c1, org.gridgain.internal.h2.table.IndexColumn c2)
static String	generateFieldsQueryString(String qry, String tableAlias, H2TableDescriptor tbl) Generate SqlFieldsQuery string from SqlQuery.
static org.gridgain.internal.h2.store.DataHandler	getHandler(GridKernalContext ctx)
static int	getTypeFromClass(Class<?> x) Maps java class on H2's Value type that is supported by Ignite.
static String	indexColumnsSql(org.gridgain.internal.h2.table.IndexColumn[] idxCols) Generate String represenation of given indexed columns.
static String	indexCreateSql(String fullTblName, GridH2IndexBase h2Idx, boolean ifNotExists) Generate CREATE INDEX SQL statement for given params.
static String	indexDropSql(String schemaName, String idxName, boolean ifExists) Generate CREATE INDEX SQL statement for given params.
static boolean	isConvertableToColumnType(Class<?> cls, int colType)
static boolean	isNullValue(org.gridgain.internal.h2.value.Value v) Test if specified value is null.
static List<GridQueryFieldMetadata>	meta(ResultSetMetaData rsMeta)
static List<JdbcParameterMeta>	parametersMeta(ParameterMetaData h2ParamsMeta) Converts h2 parameters metadata to Ignite one.
static void	registerAggregateFunction(IgniteLogger log, ConnectionManager connMgr, String fnName, Class<? extends org.gridgain.internal.h2.api.AggregateFunction> cls) Register custom aggregate function.
static void	registerSqlFunctions(IgniteLogger log, ConnectionManager connMgr, String schema, Class<?>[] clss) Register custom SQL functions.
static void	resetSession(H2PooledConnection conn) Clean up session for further reuse.
static int	resolveDefaultPrecisionIfUndefined(GridQueryProperty prop) Gets the precision for the descriptor.
static int	resolveDefaultScaleIfUndefined(GridQueryProperty prop) Gets the scale for the descriptor.
static GridH2RetryException	retryException(String msg) Create retry exception for distributed join.
static long	rowSizeInBytes(Object[] row)
static org.gridgain.internal.h2.engine.Session	session(Connection c)
static org.gridgain.internal.h2.engine.Session	session(H2PooledConnection c)
static void	setupConnection(H2PooledConnection conn, org.apache.ignite.internal.processors.query.h2.H2QueryContext qctx, boolean distributedJoins, boolean enforceJoinOrder, boolean lazy)
static void	setupConnection(H2PooledConnection conn, QueryContext qctx, boolean distributedJoins, boolean enforceJoinOrder)
static String	tableCreateSql(H2TableDescriptor tbl) Prepare SQL statement for CREATE TABLE command.
static GridH2RowMessage	toRowMessage(org.gridgain.internal.h2.result.Row row)
static List<org.gridgain.internal.h2.table.IndexColumn>	treeIndexColumns(GridH2RowDescriptor desc, List<org.gridgain.internal.h2.table.IndexColumn> cols, org.gridgain.internal.h2.table.IndexColumn keyCol, org.gridgain.internal.h2.table.IndexColumn affCol)
static @NotNull org.gridgain.internal.h2.table.IndexColumn[]	unwrapKeyColumns(GridH2Table tbl, org.gridgain.internal.h2.table.IndexColumn[] idxCols) Create list of index columns.
static void	validateTypeDescriptor(GridQueryTypeDescriptor type) Validates properties described by query types.
static String	withQuotes(String str) Add quotes around the name.
static org.gridgain.internal.h2.value.Value	wrap(CacheObjectValueContext coCtx, Object obj, int type) Wraps object to respective Value.
static QueryCursorImpl<List<?>>	zeroCursor()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_HASH_JOIN_MAX_TABLE_SIZE

public static final int DFLT_HASH_JOIN_MAX_TABLE_SIZE

Default hash join max table size.

See Also:

Constant Field Values

IGNITE_SQL_ALLOW_IMPLICIT_PK

@TestOnly
public static final String IGNITE_SQL_ALLOW_IMPLICIT_PK

Allow run CREATE TABLE statement without explicitly specifying a PK. This mode is for testing purposes only.

See Also:

Constant Field Values

STRING_DEFAULT_PRECISION

public static final int STRING_DEFAULT_PRECISION

The default precision for a char/varchar value.

See Also:

Constant Field Values

BINARY_DEFAULT_PRECISION

public static final int BINARY_DEFAULT_PRECISION

The default precision for a binary/varbinary value.

See Also:

Constant Field Values

GEOMETRY_DEFAULT_PRECISION

public static final int GEOMETRY_DEFAULT_PRECISION

The default precision for a geometry value.

See Also:

Constant Field Values

DECIMAL_DEFAULT_PRECISION

public static final int DECIMAL_DEFAULT_PRECISION

The default precision for a decimal value.

See Also:

Constant Field Values

DECIMAL_DEFAULT_SCALE

public static final int DECIMAL_DEFAULT_SCALE

The default scale for a decimal value.

See Also:

Constant Field Values

BOOLEAN_DEFAULT_PRECISION

public static final int BOOLEAN_DEFAULT_PRECISION

The default precision for a boolean value (see ValueBoolean).

See Also:

Constant Field Values

BYTE_DEFAULT_PRECISION

public static final int BYTE_DEFAULT_PRECISION

The default precision for a byte value (see ValueByte).

See Also:

Constant Field Values

SHORT_DEFAULT_PRECISION

public static final int SHORT_DEFAULT_PRECISION

The default precision for a short value (see ValueShort).

See Also:

Constant Field Values

INTEGER_DEFAULT_PRECISION

public static final int INTEGER_DEFAULT_PRECISION

The default precision for a integer value (see ValueInt).

See Also:

Constant Field Values

LONG_DEFAULT_PRECISION

public static final int LONG_DEFAULT_PRECISION

The default precision for a long value (see ValueLong).

See Also:

Constant Field Values

DOUBLE_DEFAULT_PRECISION

public static final int DOUBLE_DEFAULT_PRECISION

The default precision for a double value (see ValueDouble).

See Also:

Constant Field Values

REAL_DEFAULT_PRECISION

public static final int REAL_DEFAULT_PRECISION

The default precision for real value (see ValueFloat).

See Also:

Constant Field Values

UUID_DEFAULT_PRECISION

public static final int UUID_DEFAULT_PRECISION

The default precision for a uuid value (see ValueUuid).

See Also:

Constant Field Values

TIME_DEFAULT_PRECISION

public static final int TIME_DEFAULT_PRECISION

The default precision for a time value (see ValueTime).

See Also:

Constant Field Values

DATE_DEFAULT_PRECISION

public static final int DATE_DEFAULT_PRECISION

The default precision for a date value (see ValueDate).

See Also:

Constant Field Values

TIMESTAMP_DEFAULT_PRECISION

public static final int TIMESTAMP_DEFAULT_PRECISION

The default precision for a timestamp value (see ValueTimestamp).

See Also:

Constant Field Values

TIMESTAMP_DEFAULT_SCALE

public static final int TIMESTAMP_DEFAULT_SCALE

The default scale for a timestamp value (see ValueTimestamp).

See Also:

Constant Field Values

UPDATE_RESULT_META

public static final List<GridQueryFieldMetadata> UPDATE_RESULT_META

Dummy metadata for update result.

EMPTY_COLUMNS

public static final org.gridgain.internal.h2.table.IndexColumn[] EMPTY_COLUMNS

Method Detail

equals

public static boolean equals(org.gridgain.internal.h2.table.IndexColumn c1,
                             org.gridgain.internal.h2.table.IndexColumn c2)

Parameters:

c1 - First column.

c2 - Second column.

Returns:

true If they are the same.

containsColumn

public static boolean containsColumn(List<org.gridgain.internal.h2.table.IndexColumn> cols,
                                     org.gridgain.internal.h2.table.IndexColumn col)

Parameters:

cols - Columns list.

col - Column to find.

Returns:

true If found.

containsKeyColumn

public static boolean containsKeyColumn(GridH2RowDescriptor desc,
                                        List<org.gridgain.internal.h2.table.IndexColumn> cols)

Check whether columns list contains key or key alias column.

Parameters:

desc - Row descriptor.

cols - Columns list.

Returns:

Result.

tableCreateSql

public static String tableCreateSql(H2TableDescriptor tbl)

Prepare SQL statement for CREATE TABLE command.

Parameters:

tbl - Table descriptor.

Returns:

SQL.

indexCreateSql

public static String indexCreateSql(String fullTblName,
                                    GridH2IndexBase h2Idx,
                                    boolean ifNotExists)

Generate CREATE INDEX SQL statement for given params.

Parameters:

fullTblName - Fully qualified table name.

h2Idx - H2 index.

ifNotExists - Quietly skip index creation if it exists.

Returns:

Statement string.

indexColumnsSql

public static String indexColumnsSql(org.gridgain.internal.h2.table.IndexColumn[] idxCols)

Generate String represenation of given indexed columns.

Parameters:

idxCols - Indexed columns.

Returns:

String represenation of given indexed columns.

indexDropSql

public static String indexDropSql(String schemaName,
                                  String idxName,
                                  boolean ifExists)

Generate CREATE INDEX SQL statement for given params.

Parameters:

schemaName - Quoted schema name.

idxName - Index name.

ifExists - Quietly skip index drop if it exists.

Returns:

Statement string.

treeIndexColumns

public static List<org.gridgain.internal.h2.table.IndexColumn> treeIndexColumns(GridH2RowDescriptor desc,
                                                                                List<org.gridgain.internal.h2.table.IndexColumn> cols,
                                                                                org.gridgain.internal.h2.table.IndexColumn keyCol,
                                                                                org.gridgain.internal.h2.table.IndexColumn affCol)

Parameters:

desc - Row descriptor.

cols - Columns list.

keyCol - Primary key column.

affCol - Affinity key column.

Returns:

The same list back.

createSpatialIndex

public static GridH2IndexBase createSpatialIndex(GridH2Table tbl,
                                                 String idxName,
                                                 org.gridgain.internal.h2.table.IndexColumn[] cols)

Create spatial index.

Parameters:

tbl - Table.

idxName - Index name.

cols - Columns.

withQuotes

public static String withQuotes(String str)

Add quotes around the name.

Parameters:

str - String.

Returns:

String with quotes.

meta

public static List<GridQueryFieldMetadata> meta(ResultSetMetaData rsMeta)
                                         throws SQLException

Parameters:

rsMeta - Metadata.

Returns:

List of fields metadata.

Throws:

SQLException - If failed.

parametersMeta

public static List<JdbcParameterMeta> parametersMeta(ParameterMetaData h2ParamsMeta)
                                              throws IgniteCheckedException

Converts h2 parameters metadata to Ignite one.

Parameters:

h2ParamsMeta - parameters metadata returned by h2.

Returns:

Descriptions of the parameters.

Throws:

IgniteCheckedException

session

public static org.gridgain.internal.h2.engine.Session session(H2PooledConnection c)

Parameters:

c - Connection.

Returns:

Session.

session

public static org.gridgain.internal.h2.engine.Session session(Connection c)

Parameters:

c - Connection.

Returns:

Session.

setupConnection

public static void setupConnection(H2PooledConnection conn,
                                   QueryContext qctx,
                                   boolean distributedJoins,
                                   boolean enforceJoinOrder)

Parameters:

conn - Connection to use.

qctx - Query context.

distributedJoins - If distributed joins are enabled.

enforceJoinOrder - Enforce join order of tables.

setupConnection

public static void setupConnection(H2PooledConnection conn,
                                   org.apache.ignite.internal.processors.query.h2.H2QueryContext qctx,
                                   boolean distributedJoins,
                                   boolean enforceJoinOrder,
                                   boolean lazy)

Parameters:

conn - Connection to use.

qctx - Query context.

distributedJoins - If distributed joins are enabled.

enforceJoinOrder - Enforce join order of tables.

lazy - Lazy query execution mode.

resetSession

public static void resetSession(H2PooledConnection conn)

Clean up session for further reuse.

Parameters:

conn - Connection to use.

convert

public static Object convert(Object val,
                             IgniteH2Indexing idx,
                             int type)
                      throws IgniteCheckedException

Convert value to column's expected type by means of H2.

Parameters:

val - Source value.

idx - Row descriptor.

type - Expected column type to convert to.

Returns:

Converted object.

Throws:

IgniteCheckedException - if failed.

isNullValue

public static boolean isNullValue(org.gridgain.internal.h2.value.Value v)

Test if specified value is null.

Parameters:

v - Value to test.

Returns:

true if value is null, false - otherwise.

zeroCursor

public static QueryCursorImpl<List<?>> zeroCursor()

Returns:

Single-column, single-row cursor with 0 as number of updated records.

addUniqueColumns

public static void addUniqueColumns(List<org.gridgain.internal.h2.table.IndexColumn> dest,
                                    List<org.gridgain.internal.h2.table.IndexColumn> src)

Add only new columns to destination list.

Parameters:

dest - List of index columns to add new elements from src list.

src - List of IndexColumns to add to dest list.

checkAndStartNotStartedCache

public static boolean checkAndStartNotStartedCache(GridKernalContext ctx,
                                                   GridH2Table tbl)

Check that given table has not started cache and start it for such case.

Parameters:

tbl - Table to check on not started cache.

Returns:

true in case not started and has been started.

isConvertableToColumnType

public static boolean isConvertableToColumnType(Class<?> cls,
                                                int colType)

Parameters:

cls - The class whose convertibility is to be tested.

colType - Column target type.

Returns:

Whether specified class can be implicitly converted to the specified type.

See Also:

wrap(CacheObjectValueContext, Object, int)

wrap

public static org.gridgain.internal.h2.value.Value wrap(CacheObjectValueContext coCtx,
                                                        Object obj,
                                                        int type)
                                                 throws IgniteCheckedException

Wraps object to respective Value. Note, implicit type conversions must be also included into CONVERTABLE_TYPES.

Parameters:

obj - Object.

type - Value type.

Returns:

Value.

Throws:

IgniteCheckedException - If failed.

See Also:

isConvertableToColumnType(Class, int)

getTypeFromClass

public static int getTypeFromClass(Class<?> x)

Maps java class on H2's Value type that is supported by Ignite.

Note that Ignite supports fewer types than H2.

Parameters:

x - java class to map on H2's type.

Returns:

H2 type if Ignite supports this type or Value.JAVA_OBJECT otherwise.

See Also:

Value, DataType.getTypeFromClass(Class)

resolveDefaultPrecisionIfUndefined

public static int resolveDefaultPrecisionIfUndefined(GridQueryProperty prop)

Gets the precision for the descriptor.

Parameters:

prop - Query entity field descriptor.

Returns:

Precision of the query entity, if it has been set, or the default precision of the type.

resolveDefaultScaleIfUndefined

public static int resolveDefaultScaleIfUndefined(GridQueryProperty prop)

Gets the scale for the descriptor.

Parameters:

prop - Query entity field descriptor.

Returns:

Scale of the query entity, if it has been set, or the default scale of the type.

validateTypeDescriptor

public static void validateTypeDescriptor(GridQueryTypeDescriptor type)
                                   throws IgniteCheckedException

Validates properties described by query types.

Parameters:

type - Type descriptor.

Throws:

IgniteCheckedException - If validation failed.

generateFieldsQueryString

public static String generateFieldsQueryString(String qry,
                                               String tableAlias,
                                               H2TableDescriptor tbl)
                                        throws IgniteCheckedException

Generate SqlFieldsQuery string from SqlQuery.

Parameters:

qry - Query string.

tableAlias - table alias.

tbl - Table to use.

Returns:

Prepared statement.

Throws:

IgniteCheckedException - In case of error.

toRowMessage

public static GridH2RowMessage toRowMessage(org.gridgain.internal.h2.result.Row row)

Parameters:

row - Row.

Returns:

Row message.

retryException

public static GridH2RetryException retryException(String msg)

Create retry exception for distributed join.

Parameters:

msg - Message.

Returns:

Exception.

bindParameters

public static void bindParameters(PreparedStatement stmt,
                                  @Nullable
                                  @Nullable Collection<Object> params)
                           throws IgniteCheckedException

Binds parameters to prepared statement.

Parameters:

stmt - Prepared statement.

params - Parameters collection.

Throws:

IgniteCheckedException - If failed.

bubbleUp

public static <Z> void bubbleUp(Z[] arr,
                                int off,
                                Comparator<Z> cmp)

Parameters:

arr - Array.

off - Offset.

cmp - Comparator.

collectCacheIds

public static List<Integer> collectCacheIds(IgniteH2Indexing idx,
                                            @Nullable
                                            @Nullable Integer mainCacheId,
                                            Collection<QueryTable> tbls)

Collect cache identifiers from two-step query.

Parameters:

mainCacheId - Id of main cache.

Returns:

Result.

collectMvccEnabled

public static boolean collectMvccEnabled(IgniteH2Indexing idx,
                                         List<Integer> cacheIds)

Collect MVCC enabled flag.

Parameters:

idx - Indexing.

cacheIds - Cache IDs.

Returns:

True if indexing is enabled.

checkQuery

public static void checkQuery(IgniteH2Indexing idx,
                              List<Integer> cacheIds,
                              Collection<QueryTable> tbls)

Check if query is valid.

Parameters:

idx - Indexing.

cacheIds - Cache IDs.

tbls - Tables.

unwrapKeyColumns

@NotNull
public static @NotNull org.gridgain.internal.h2.table.IndexColumn[] unwrapKeyColumns(GridH2Table tbl,
                                                                                              org.gridgain.internal.h2.table.IndexColumn[] idxCols)

Create list of index columns. Where possible _KEY columns will be unwrapped.

Parameters:

tbl - GridH2Table instance

idxCols - List of index columns.

Returns:

Array of key and affinity columns. Key's, if it possible, splitted into simple components.

context

public static QueryContext context(org.gridgain.internal.h2.engine.Session ses)

Parameters:

ses - H2 session.

Returns:

Query context.

context

public static QueryContext context(Connection c)

Parameters:

c - Connection.

Returns:

Query context.

rowSizeInBytes

public static long rowSizeInBytes(Object[] row)

Parameters:

row - Data row.

Returns:

Row size in bytes.

calculateMemoryDelta

public static long calculateMemoryDelta(org.gridgain.internal.h2.value.ValueRow distinctRowKey,
                                        Object[] oldRow,
                                        Object[] newRow)

Calculates memory delta when old row was replaced with a new one.

Parameters:

distinctRowKey - Distinct row key.

oldRow - Old row.

newRow - New row.

Returns:

Memory delta.

getHandler

public static org.gridgain.internal.h2.store.DataHandler getHandler(GridKernalContext ctx)

Parameters:

ctx - Kernal context/

Returns:

Data handler.

registerSqlFunctions

public static void registerSqlFunctions(IgniteLogger log,
                                        ConnectionManager connMgr,
                                        String schema,
                                        Class<?>[] clss)
                                 throws IgniteCheckedException

Register custom SQL functions.

Parameters:

schema - Schema.

clss - Classes.

Throws:

IgniteCheckedException - If failed.

registerAggregateFunction

public static void registerAggregateFunction(IgniteLogger log,
                                             ConnectionManager connMgr,
                                             String fnName,
                                             Class<? extends org.gridgain.internal.h2.api.AggregateFunction> cls)
                                      throws IgniteCheckedException

Register custom aggregate function.

Parameters:

fnName - SQL function name.

cls - Function implementation class.

Throws:

IgniteCheckedException - If failed.