[ignite] branch master updated: IGNITE-13450 [MINOR] Added missed javadoc for EVT_CACHE_QUERY_EXECUTED event.

[sk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sk0x50 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 3c2535e  IGNITE-13450 [MINOR] Added missed javadoc for EVT_CACHE_QUERY_EXECUTED event.
3c2535e is described below

commit 3c2535edac18b3de5180797c895cbb5cb5031448
Author: Slava Koptilin <sl...@gmail.com>
AuthorDate: Thu Dec 10 16:01:15 2020 +0300

    IGNITE-13450 [MINOR] Added missed javadoc for EVT_CACHE_QUERY_EXECUTED event.
---
 modules/core/src/main/java/org/apache/ignite/events/EventType.java   | 5 +++++
 .../main/java/org/apache/ignite/events/SqlQueryExecutionEvent.java   | 4 ++++
 2 files changed, 9 insertions(+)

diff --git a/modules/core/src/main/java/org/apache/ignite/events/EventType.java b/modules/core/src/main/java/org/apache/ignite/events/EventType.java
index 3da9801..6fb7056 100644
--- a/modules/core/src/main/java/org/apache/ignite/events/EventType.java
+++ b/modules/core/src/main/java/org/apache/ignite/events/EventType.java
@@ -925,6 +925,11 @@ public interface EventType {
 
     /**
      * Built-in event type: query execution.
+     * This event is triggered after a corresponding SQL query validated and before it is executed.
+     * Unlike {@link #EVT_CACHE_QUERY_EXECUTED}, {@code EVT_SQL_QUERY_EXECUTION} is fired only once for a request
+     * and does not relate to a specific cache.
+     * Enet includes the following information: qurey text and its arguments, security subject id.
+     *
      * <p>
      * NOTE: all types in range <b>from 1 to 1000 are reserved</b> for
      * internal Ignite events and should not be used by user-defined events.
diff --git a/modules/core/src/main/java/org/apache/ignite/events/SqlQueryExecutionEvent.java b/modules/core/src/main/java/org/apache/ignite/events/SqlQueryExecutionEvent.java
index 4700d7b..d8feb07 100644
--- a/modules/core/src/main/java/org/apache/ignite/events/SqlQueryExecutionEvent.java
+++ b/modules/core/src/main/java/org/apache/ignite/events/SqlQueryExecutionEvent.java
@@ -28,6 +28,10 @@ import static org.apache.ignite.events.EventType.EVT_SQL_QUERY_EXECUTION;
 
 /**
  * Query execution event.
+ * This event is triggered after a corresponding SQL query validated and before it is executed.
+ * Unlike {@link EventType#EVT_CACHE_QUERY_EXECUTED}, {@link EventType#EVT_SQL_QUERY_EXECUTION} is fired only once for a request
+ * and does not relate to a specific cache.
+ *
  * <p>
  * Grid events are used for notification about what happens within the grid. Note that by
  * design Ignite keeps all events generated on the local node locally and it provides