org.apache.ignite.configuration

Class SqlConfiguration

java.lang.Object

org.apache.ignite.configuration.SqlConfiguration

public class SqlConfiguration
extends Object

The configuration of the SQL query subsystem.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_LONG_QRY_WARN_TIMEOUT Default timeout after which long query warning will be printed.
static long	DFLT_QRY_TIMEOUT Default query timeout.
static String	DFLT_SQL_QUERY_GLOBAL_MEMORY_QUOTA Default SQL query global memory quota.
static int	DFLT_SQL_QUERY_HISTORY_SIZE Default SQL query history size.
static String	DFLT_SQL_QUERY_MEMORY_QUOTA Default SQL per query memory quota.
static boolean	DFLT_SQL_QUERY_OFFLOADING_ENABLED Default value for SQL offloading flag.

Constructor Summary

Constructors

Constructor and Description
SqlConfiguration()

Method Summary

Modifier and Type	Method and Description
long	getDefaultQueryTimeout() Deprecated. Since 8.7.26. Please use distributed default query timeout.
long	getLongQueryWarningTimeout() Gets timeout in milliseconds after which long query warning will be printed.
String	getSqlGlobalMemoryQuota() Returns global memory pool size for SQL queries.
int	getSqlQueryHistorySize() Number of SQL query history elements to keep in memory.
String	getSqlQueryMemoryQuota() Returns per-query memory quota.
String[]	getSqlSchemas() Gets SQL schemas to be created on node startup.
boolean	isSqlOffloadingEnabled() Returns flag whether disk offloading is enabled.
SqlConfiguration	setDefaultQueryTimeout(long dfltQryTimeout) Deprecated. Since 8.7.26. Please use distributed default query timeout.
SqlConfiguration	setLongQueryWarningTimeout(long longQryWarnTimeout) Sets timeout in milliseconds after which long query warning will be printed.
SqlConfiguration	setSqlGlobalMemoryQuota(String size) Sets global memory pool size for SQL queries.
SqlConfiguration	setSqlOffloadingEnabled(boolean offloadingEnabled) Sets the SQL query offloading enabled flag.
SqlConfiguration	setSqlQueryHistorySize(int size) Sets number of SQL query history elements kept in memory.
SqlConfiguration	setSqlQueryMemoryQuota(String size) Sets per-query memory quota.
SqlConfiguration	setSqlSchemas(String... sqlSchemas) Sets SQL schemas to be created on node startup.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DFLT_SQL_QUERY_HISTORY_SIZE

public static final int DFLT_SQL_QUERY_HISTORY_SIZE

Default SQL query history size.

See Also:

Constant Field Values

DFLT_LONG_QRY_WARN_TIMEOUT

public static final long DFLT_LONG_QRY_WARN_TIMEOUT

Default timeout after which long query warning will be printed.

See Also:

Constant Field Values

DFLT_SQL_QUERY_GLOBAL_MEMORY_QUOTA

public static final String DFLT_SQL_QUERY_GLOBAL_MEMORY_QUOTA

Default SQL query global memory quota.

See Also:

Constant Field Values

DFLT_SQL_QUERY_MEMORY_QUOTA

public static final String DFLT_SQL_QUERY_MEMORY_QUOTA

Default SQL per query memory quota.

See Also:

Constant Field Values

DFLT_SQL_QUERY_OFFLOADING_ENABLED

public static final boolean DFLT_SQL_QUERY_OFFLOADING_ENABLED

Default value for SQL offloading flag.

See Also:

Constant Field Values

DFLT_QRY_TIMEOUT

public static final long DFLT_QRY_TIMEOUT

Default query timeout.

See Also:

Constant Field Values

Constructor Detail

SqlConfiguration

public SqlConfiguration()

Method Detail

getSqlQueryHistorySize

public int getSqlQueryHistorySize()

Number of SQL query history elements to keep in memory. If not provided, then default value DFLT_SQL_QUERY_HISTORY_SIZE is used. If provided value is less or equals 0, then gathering SQL query history will be switched off.

Returns:

SQL query history size.

setSqlQueryHistorySize

public SqlConfiguration setSqlQueryHistorySize(int size)

Sets number of SQL query history elements kept in memory. If not explicitly set, then default value is DFLT_SQL_QUERY_HISTORY_SIZE.

Parameters:

size - Number of SQL query history elements kept in memory.

Returns:

this for chaining.

getSqlSchemas

public String[] getSqlSchemas()

Gets SQL schemas to be created on node startup.

See setSqlSchemas(String...) for more information.

Returns:

SQL schemas to be created on node startup.

setSqlSchemas

public SqlConfiguration setSqlSchemas(String... sqlSchemas)

Sets SQL schemas to be created on node startup. Schemas are created on local node only and are not propagated to other cluster nodes. Created schemas cannot be dropped.

By default schema names are case-insensitive, i.e. my_schema and My_Schema represents the same object. Use quotes to enforce case sensitivity (e.g. "My_Schema").

Property is ignored if ignite-indexing module is not in classpath.

Parameters:

sqlSchemas - SQL schemas to be created on node startup.

Returns:

this for chaining.

getLongQueryWarningTimeout

public long getLongQueryWarningTimeout()

Gets timeout in milliseconds after which long query warning will be printed.

Returns:

Timeout in milliseconds.

setLongQueryWarningTimeout

public SqlConfiguration setLongQueryWarningTimeout(long longQryWarnTimeout)

Sets timeout in milliseconds after which long query warning will be printed.

Parameters:

longQryWarnTimeout - Timeout in milliseconds.

Returns:

this for chaining.

getSqlGlobalMemoryQuota

public String getSqlGlobalMemoryQuota()

Returns global memory pool size for SQL queries.

See setSqlGlobalMemoryQuota(String) for details.

Returns:

Global memory pool size for SQL queries.

setSqlGlobalMemoryQuota

public SqlConfiguration setSqlGlobalMemoryQuota(String size)

Sets global memory pool size for SQL queries.

Global SQL query memory pool size or SQL query memory quota - is an upper bound for the heap memory part which might be occupied by the SQL query execution engine. This quota is shared among all simultaneously running queries, hence it be easily consumed by the single heavy analytics query. If you want to control memory quota on per-query basis consider setSqlQueryMemoryQuota(String).

There are two options of query behaviour when either query or global memory quota is exceeded:

• If disk offloading is disabled, the query caller gets an error that quota was exceeded.
• If disk offloading is enabled, the intermediate query results will be offloaded to a disk.

See setSqlOffloadingEnabled(boolean) for details.

If not provided, the default value is defined by DFLT_SQL_QUERY_GLOBAL_MEMORY_QUOTA.

The value is specified as string value of size of in bytes.

Value 0 means no quota at all.

Quota may be specified also in:

• Kilobytes - just append the letter 'K' or 'k': 10k, 400K
• Megabytes - just append the letter 'M' or 'm': 60m, 420M
• Gigabytes - just append the letter 'G' or 'g': 7g, 2G
• Percent of heap - just append the sign '%': 45%, 80%

Parameters:

size - Size of global memory pool for SQL queries in bytes, kilobytes, megabytes, or percentage of the max heap.

Returns:

this for chaining.

getSqlQueryMemoryQuota

public String getSqlQueryMemoryQuota()

Returns per-query memory quota. See setSqlQueryMemoryQuota(String) for details.

Returns:

Per-query memory quota.

setSqlQueryMemoryQuota

public SqlConfiguration setSqlQueryMemoryQuota(String size)

Sets per-query memory quota.

It is the maximum amount of memory intended for the particular single query execution. If a query execution exceeds this bound, the either would happen:

• If disk offloading is disabled, the query caller gets an error that quota was exceeded.
• If disk offloading is enabled, the intermediate query results will be offloaded to a disk.

See setSqlOffloadingEnabled(boolean) for details.

If not provided, the default value is defined by DFLT_SQL_QUERY_MEMORY_QUOTA.

The value is specified as string value of size of in bytes.

Value 0 means no quota at all.

Quota may be specified also in:

• Kilobytes - just append the letter 'K' or 'k': 10k, 400K
• Megabytes - just append the letter 'M' or 'm': 60m, 420M
• Gigabytes - just append the letter 'G' or 'g': 7g, 2G
• Percent of the heap - just append the sign '%': 45%, 80%

Parameters:

size - Size of per-query memory quota in bytes, kilobytes, megabytes, or percentage of the max heap.

Returns:

this for chaining.

isSqlOffloadingEnabled

public boolean isSqlOffloadingEnabled()

Returns flag whether disk offloading is enabled. See setSqlOffloadingEnabled(boolean) for details.

Returns:

Flag whether disk offloading is enabled.

setSqlOffloadingEnabled

public SqlConfiguration setSqlOffloadingEnabled(boolean offloadingEnabled)

Sets the SQL query offloading enabled flag.

Offloading flag specifies the query execution behavior on memory quota excess - either global quota (see setSqlGlobalMemoryQuota(String)) or per query quota (see setSqlQueryMemoryQuota(String)). Possible options on quota excess are:

• If offloadingEnabled flag set to false, the exception will be thrown when memory quota is exceeded.
• If offloadingEnabled flag set to true, the intermediate query results will be offloaded to disk. It may slow down the query execution time by orders of magnitude, but eventually the query will be executed and the caller will get a result.

If not provided, the default value is false.

Parameters:

offloadingEnabled - Offloading enabled flag.

Returns:

this for chaining.

getDefaultQueryTimeout

@Deprecated
public long getDefaultQueryTimeout()

Deprecated. Since 8.7.26. Please use distributed default query timeout.

Defines the default query timeout. Defaults to DFLT_QRY_TIMEOUT. 0 means there is no timeout (this is a default value)

Returns:

Default query timeout.

setDefaultQueryTimeout

@Deprecated
public SqlConfiguration setDefaultQueryTimeout(long dfltQryTimeout)

Deprecated. Since 8.7.26. Please use distributed default query timeout.

Sets timeout in milliseconds for default query timeout. 0 means there is no timeout (this is a default value)

Parameters:

dfltQryTimeout - Timeout in milliseconds.

Returns:

this for chaining.

toString

public String toString()

Overrides:

toString in class Object