org.apache.ignite.internal.mxbean

Interface SqlQueryMXBean

All Known Implementing Classes:

SqlQueryMXBeanImpl

Deprecated.

Temporary monitoring solution.

@Deprecated
public interface SqlQueryMXBean

An MX bean allowing to monitor and tune SQL queries.

Method Summary

Modifier and Type	Method and Description
int	getLongQueryTimeoutMultiplier() Deprecated.
long	getLongQueryWarningTimeout() Deprecated.
long	getResultSetSizeThreshold() Deprecated.
int	getResultSetSizeThresholdMultiplier() Deprecated. Gets result set size threshold multiplier.
long	getSqlFreeMemoryBytes() Deprecated. Gets the amount of memory available for SQL queries.
String	getSqlGlobalMemoryQuota() Deprecated. Gets global query quota.
Long	getSqlGlobalMemoryQuotaBytes() Deprecated. Gets global query quota.
String	getSqlQueryMemoryQuota() Deprecated. Gets global query quota.
Long	getSqlQueryMemoryQuotaBytes() Deprecated. Gets global query quota.
boolean	isSqlOffloadingEnabled() Deprecated. Gets offloading flag.
void	setLongQueryTimeoutMultiplier(int longQueryTimeoutMultiplier) Deprecated. Sets long query timeout multiplier.
void	setLongQueryWarningTimeout(long longQueryWarningTimeout) Deprecated. Sets timeout in milliseconds after which long query warning will be printed.
void	setResultSetSizeThreshold(long rsSizeThreshold) Deprecated. Sets threshold result's row count, when count of fetched rows is bigger than the threshold warning will be printed.
void	setResultSetSizeThresholdMultiplier(int rsSizeThresholdMultiplier) Deprecated. Sets result set size threshold multiplier.
void	setSqlGlobalMemoryQuota(String size) Deprecated. Sets global query quota.
void	setSqlOffloadingEnabled(boolean enabled) Deprecated. Sets offloading flag.
void	setSqlQueryMemoryQuota(String size) Deprecated. Sets per-query memory quota.

Method Detail

getLongQueryWarningTimeout

@MXBeanDescription(value="Timeout in milliseconds after which long query warning will be printed.")
long getLongQueryWarningTimeout()

Deprecated.

Returns:

Timeout in milliseconds after which long query warning will be printed.

setLongQueryWarningTimeout

@MXBeanDescription(value="Sets timeout in milliseconds after which long query warning will be printed.")
 @MXBeanParametersNames(value="longQueryWarningTimeout")
 @MXBeanParametersDescriptions(value="Timeout in milliseconds after which long query warning will be printed.")
void setLongQueryWarningTimeout(long longQueryWarningTimeout)

Deprecated.

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

Parameters:

longQueryWarningTimeout - Timeout in milliseconds after which long query warning will be printed.

getLongQueryTimeoutMultiplier

@MXBeanDescription(value="Long query timeout multiplier. The warning will be printed after: timeout, timeout * multiplier, timeout * multiplier * multiplier, etc. If the multiplier <= 1, the warning message is printed once.")
int getLongQueryTimeoutMultiplier()

Deprecated.

Returns:

Long query timeout multiplier.

setLongQueryTimeoutMultiplier

@MXBeanDescription(value="Sets long query timeout multiplier. The warning will be printed after: timeout, timeout * multiplier, timeout * multiplier * multiplier, etc. If the multiplier <= 1, the warning message is printed once.")
 @MXBeanParametersNames(value="longQueryTimeoutMultiplier")
 @MXBeanParametersDescriptions(value="Long query timeout multiplier.")
void setLongQueryTimeoutMultiplier(int longQueryTimeoutMultiplier)

Deprecated.

Sets long query timeout multiplier. The warning will be printed after: - timeout; - timeout * multiplier; - timeout * multiplier * multiplier; - etc. If the multiplier <= 1, the warning message is printed once.

Parameters:

longQueryTimeoutMultiplier - Long query timeout multiplier.

getResultSetSizeThreshold

@MXBeanDescription(value="Threshold for the number of rows of the result, when count of fetched rows is bigger than the thresholdwarning will be printed.")
long getResultSetSizeThreshold()

Deprecated.

Returns:

Threshold for the number of rows of the result, when count of fetched rows is bigger than the threshold warning will be printed.

setResultSetSizeThreshold

@MXBeanDescription(value="Sets threshold for the number of rows of the result, when count of fetched rows is bigger than the threshold warning will be printed")
 @MXBeanParametersNames(value="rsSizeThreshold")
 @MXBeanParametersDescriptions(value="Threshold for the number of rows of the result, when count of fetched rows is bigger than the threshold warning will be printed.")
void setResultSetSizeThreshold(long rsSizeThreshold)

Deprecated.

Sets threshold result's row count, when count of fetched rows is bigger than the threshold warning will be printed.

Parameters:

rsSizeThreshold - Threshold result's row count, when count of fetched rows is bigger than the threshold warning will be printed.

getResultSetSizeThresholdMultiplier

@MXBeanDescription(value="Gets result set size threshold multiplier. The warning will be printed when size of result set is bugger than: threshold, threshold * multiplier, threshold * multiplier * multiplier, etc. If the multiplier <= 1, the warning message is printed once during query execution and the next one on the query end.")
int getResultSetSizeThresholdMultiplier()

Deprecated.

Gets result set size threshold multiplier. The warning will be printed after: - size of result set > threshold; - size of result set > threshold * multiplier; - size of result set > threshold * multiplier * multiplier; - etc. If the multiplier <= 1, the warning message is printed once during query execution and the next one on the query end.

Returns:

Result set size threshold multiplier.

setResultSetSizeThresholdMultiplier

@MXBeanDescription(value="Sets result set size threshold multiplier. The warning will be printed when size of result set is bugger than: threshold, threshold * multiplier, threshold * multiplier * multiplier,etc. If the multiplier <= 1, the warning message is printed once.")
 @MXBeanParametersNames(value="rsSizeThresholdMultiplier")
 @MXBeanParametersDescriptions(value="TResult set size threshold multiplier.")
void setResultSetSizeThresholdMultiplier(int rsSizeThresholdMultiplier)

Deprecated.

Sets result set size threshold multiplier.

Parameters:

rsSizeThresholdMultiplier - Result set size threshold multiplier.

getSqlGlobalMemoryQuotaBytes

@MXBeanDescription(value="Gets global SQL query memory quota. 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.  Same as SqlGlobalMemoryQuota, but with a Long return type.")
Long getSqlGlobalMemoryQuotaBytes()

Deprecated.

Gets global query quota.

Returns:

Global query quota as a long.

getSqlGlobalMemoryQuota

@MXBeanDescription(value="Gets global SQL query memory quota. 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.")
String getSqlGlobalMemoryQuota()

Deprecated.

Gets global query quota.

Returns:

Global query quota.

setSqlGlobalMemoryQuota

@MXBeanDescription(value="Sets global query quota. 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 sqlQueryMemoryQuota}")
 @MXBeanParametersNames(value="size")
 @MXBeanParametersDescriptions(value="Size of global memory pool for SQL queries in bytes. Can be followed by theletters \'k\' for kilobytes, \'m\' for megabytes, \'g\' for gigabytes and \'%\' for the percentage of the current heap.For example:  \'1000\', \'10M\', \'100k\', \'1G\', \'70%\'")
void setSqlGlobalMemoryQuota(String size)

Deprecated.

Sets global query quota.

Parameters:

size - Size of global memory pool for SQL queries.

getSqlQueryMemoryQuotaBytes

@MXBeanDescription(value="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. Same as SqlQueryMemoryQuota, but with a Long return type.")
Long getSqlQueryMemoryQuotaBytes()

Deprecated.

Gets global query quota.

Returns:

Global query quota as a long.

getSqlQueryMemoryQuota

@MXBeanDescription(value="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.")
String getSqlQueryMemoryQuota()

Deprecated.

Gets global query quota.

Returns:

Global query quota.

getSqlFreeMemoryBytes

@MXBeanDescription(value="The amount of memory available for SQL queries. This is equal to SqlGlobalMemoryQuotaBytes minus the amount of memory currently occupied by the queries.")
long getSqlFreeMemoryBytes()

Deprecated.

Gets the amount of memory available for SQL queries. This is equal to the getSqlGlobalMemoryQuotaBytes() minus the amount of memory currently occupied by the queries.

Returns:

Amount of memory bytes available for SQL queries.

setSqlQueryMemoryQuota

@MXBeanDescription(value="Gets SQL query memory quota. Query memory quota is the maximum amount of memory intended for the particular single query execution. If a query execution exceeds this bound, the either would happen:\n If disk offloading is disabled, the query caller gets an error that quota was exceeded. </li>\n If disk offloading is enabled, the intermediate query results will be offloaded to a disk. </li>\n See SqlOffloadingEnabled for details")
 @MXBeanParametersNames(value="size")
 @MXBeanParametersDescriptions(value="Size of per-query memory pool for SQL queries in bytes. Can be followed by theletters \'k\' for kilobytes, \'m\' for megabytes, \'g\' for gigabytes and \'%\' for the percentage of the current heap.For example:  \'1000\', \'10M\', \'100k\', \'1G\', \'70%\'")
void setSqlQueryMemoryQuota(String size)

Deprecated.

Sets per-query memory quota.

Parameters:

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

isSqlOffloadingEnabled

@MXBeanDescription(value="Offloading flag specifies the query execution behavior on either global or query memory quota excess. If flag is set to \'true\', the query result will be offloaded to the disk. If flag is set to \'false\', an exception will be thrown.")
boolean isSqlOffloadingEnabled()

Deprecated.

Gets offloading flag.

Returns:

Flag whether query disk offloading is enabled.

setSqlOffloadingEnabled

@MXBeanDescription(value="Offloading flag specifies the query execution behavior on either global or query memory quota excess. If flag is set to \'true\', the query result will be offloaded to disk. If flag is set to \'false\', an exception will be thrown.")
 @MXBeanParametersNames(value="enabled")
 @MXBeanParametersDescriptions(value="The value whether offloading flag is enabled.")
void setSqlOffloadingEnabled(boolean enabled)

Deprecated.

Sets offloading flag.

Parameters:

enabled - The value whether offloading flag is enabled.