This is an automated email from the ASF dual-hosted git repository.
alexpl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 709829ade2d IGNITE-24956 Documentation: Add SQL_PLANS_HISTORY view
performance considerations - Fixes #11979.
709829ade2d is described below
commit 709829ade2d60c6b541674e4c4585aed181654ff
Author: oleg-vlsk <[email protected]>
AuthorDate: Fri Apr 4 10:33:38 2025 +0300
IGNITE-24956 Documentation: Add SQL_PLANS_HISTORY view performance
considerations - Fixes #11979.
Signed-off-by: Aleksey Plekhanov <[email protected]>
---
docs/_docs/monitoring-metrics/system-views.adoc | 30 +++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/docs/_docs/monitoring-metrics/system-views.adoc
b/docs/_docs/monitoring-metrics/system-views.adoc
index 43b36fb980f..109973db9e5 100644
--- a/docs/_docs/monitoring-metrics/system-views.adoc
+++ b/docs/_docs/monitoring-metrics/system-views.adoc
@@ -534,6 +534,36 @@ This view displays a list of plans of previously executed
SQL queries.
|LAST_START_TIME | date | Last execution date
|===
+=== Performance Considerations
+
+When using the H2 engine, collecting SQL plans may introduce a performance
overhead under high SQL query load, impacting both latency and throughput. For
this reason, SQL plan collection is disabled by default for H2.
+
+To enable it, you need to configure the SQL plan history size:
+
+[tabs]
+--
+tab:XML[]
+[source, xml]
+----
+<bean id="grid.cfg"
class="org.apache.ignite.configuration.IgniteConfiguration">
+ <property name="sqlConfiguration">
+ <bean class="org.apache.ignite.configuration.SqlConfiguration">
+ <property name="sqlPlanHistorySize" value="1000"/>
+ </bean>
+ </property>
+</bean>
+----
+tab:Java[]
+[source, java]
+----
+IgniteConfiguration cfg = new IgniteConfiguration();
+
+cfg.setSqlConfiguration(new SqlConfiguration().setSqlPlanHistorySize(1000));
+----
+--
+
+When using the Calcite engine, collecting SQL plans does not impact
performance. Therefore, it is enabled by default. The default history size is
1000 entries.
+
== SCHEMAS
This view exposes information about SQL schemas.
