This is an automated email from the ASF dual-hosted git repository. dmagda pushed a commit to branch IGNITE-7595 in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/IGNITE-7595 by this push: new 8dfa540 altering the description of the new two features - JOBs system view and the set of KILL commands 8dfa540 is described below commit 8dfa5404f346977be3e8c15adff4831391c78e3b Author: Denis Magda <dma...@gridgain.com> AuthorDate: Wed Sep 30 13:51:47 2020 -0700 altering the description of the new two features - JOBs system view and the set of KILL commands --- docs/_docs/monitoring-metrics/system-views.adoc | 34 +++++++------- docs/_docs/sql-reference/operational-commands.adoc | 52 ++++++++++++---------- 2 files changed, 47 insertions(+), 39 deletions(-) diff --git a/docs/_docs/monitoring-metrics/system-views.adoc b/docs/_docs/monitoring-metrics/system-views.adoc index e9af526..b450194 100644 --- a/docs/_docs/monitoring-metrics/system-views.adoc +++ b/docs/_docs/monitoring-metrics/system-views.adoc @@ -171,33 +171,35 @@ be updating the thick client with task-related execution details. |USER_VERSION | string | Task user version |=== -== JOBS - compute jobs +== JOBS This system view shows a list of compute jobs started by a node as part of a compute task. -To view the status of the compute task refer to the TASKS system view. +To view the status of the compute task refer to the `TASKS` system view. [{table_opts}] |=== |NAME | TYPE | DESCRIPTION |ID | UUID | Job ID -|SESSION_ID | UUID | Session ID. Note, `SESSION_ID` equal to `TASKS.SESSION_ID` for the jobs that belong to the specific task +|SESSION_ID | UUID | Job's session ID. Note, `SESSION_ID` is equal to `TASKS.SESSION_ID` for the jobs belonging to a specific task. |ORIGIN_NODE_ID | UUID | The id of the node that started the job -|TASK_NAME | string | Name of the task +|TASK_NAME | string | The name of the task |TASK_CLASSNAME | string | Class name of the task -|AFFINITY_CACHE_IDS | string | Affinity cache ids -|AFFINITY_PARTITION_ID | int | Partition id -|CREATE_TIME | long | Create time -|START_TIME | long | Start time -|FINISH_TIME | long | Finish time -|EXECUTOR_NAME | string | Name of the executor for task -|IS_FINISHING | boolean | True if job finishing -|IS_INTERNAL | boolean | True if job internal -|IS_STARTED | boolean | True if job started -|IS_TIMEDOUT | boolean | True if job timed out +|AFFINITY_CACHE_IDS | string | IDs of one or more caches if the job is executed against one of the `IgniteCompute.affinity..` +methods. The parameter is empty, if you use `IgniteCompute` APIs that don't target specific caches. +|AFFINITY_PARTITION_ID | int | IDs of one or more partitions if the job is executed via one of the `IgniteCompute.affinity..` +methods. The parameter is empty, if you use `IgniteCompute` APIs that don't target specific partitions. +|CREATE_TIME | long | Job's creation time +|START_TIME | long | Job's start time +|FINISH_TIME | long | Job's finish time +|EXECUTOR_NAME | string | The name of the task's executor +|IS_FINISHING | boolean | `True` if the job is finishing +|IS_INTERNAL | boolean | `True` if the job is internal +|IS_STARTED | boolean | `True` if the job has been started +|IS_TIMEDOUT | boolean | `True` if the job timed out before completing |STATE | string | Possible values: + -`ACTIVE` - Job executing. + +`ACTIVE` - Job is being executed. + `PASSIVE` - Job is added to the execution queue. Please, see `CollisionSPI` for more details. + -`CANCELED` - Job canceled. +`CANCELED` - Job is canceled. |=== == SERVICES diff --git a/docs/_docs/sql-reference/operational-commands.adoc b/docs/_docs/sql-reference/operational-commands.adoc index 02f3761..a68d713 100644 --- a/docs/_docs/sql-reference/operational-commands.adoc +++ b/docs/_docs/sql-reference/operational-commands.adoc @@ -115,7 +115,8 @@ image::images/set-streaming.png[] == KILL QUERY -The `KILL QUERY` command allows you to cancel a running query. +The `KILL QUERY` command allows you to cancel a running query. When a query is cancelled with the `KILL` command, all +parts of the query running on all other nodes are terminated as well. [tabs] -- @@ -142,16 +143,15 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill SQL query_id +control.bat --kill SQL query_id ---- -- -=== Description -`query_id` can be retrived via the `SQL_QUERIES` view. -`ASYNC` is an optional parameter which returns control immediately without waiting for the cancellation to finish, and `query_id` can be retrieved via the `SQL_QUERIES` view. +=== Parameters -When a query cancelled via the `KILL` command, all parts of the query running on all other nodes are cancelled. +* `query_id` - can be retrived via the link:monitoring-metrics/system-views#sql_queries[SQL_QUERIES] view. +* `ASYNC` - is an optional parameter that returns control immediately without waiting for the cancellation to finish. == KILL TRANSACTION @@ -159,7 +159,6 @@ The `KILL TRANSACTION` command allows you to cancel a running transaction. [tabs] -- - tab:SQL[] [source,sql] ---- @@ -182,13 +181,14 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill TRANSACTION xid +control.bat --kill TRANSACTION xid ---- - -- -=== Description -`xid` of the transaction can be retrived via the `TRANSACTIONS` view. +=== Parameters + +* `xid` - the transaction id that can be retrived via the link:monitoring-metrics/system-views#transactions[TRANSACTIONS] view. + == KILL SCAN @@ -219,13 +219,14 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill SCAN origin_node_id cache_name query_id +control.bat --kill SCAN origin_node_id cache_name query_id ---- -- -=== Description -`origin_node_id`, `cache_name`, `query_id` parameters can be retrived via the `SCAN_QUERIES`. +=== Parameters + +* `origin_node_id`, `cache_name`, `query_id` - can be retrived via the link:monitoring-metrics/system-views#scan_queries[SCAN_QUERIES] view. === Example @@ -262,13 +263,15 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill COMPUTE session_id +control.bat --kill COMPUTE session_id ---- -- -=== Description -`session_id` parameter can be retrived via the `TASKS` or `JOBS` view. +=== Parameters + +* `session_id` - can be retrived via the link:monitoring-metrics/system-views#tasks[TASKS] or +link:monitoring-metrics/system-views#jobs[JOBS] views. == KILL CONTINUOUS @@ -299,13 +302,14 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill CONTINUOUS origin_node_id routine_id +control.bat --kill CONTINUOUS origin_node_id routine_id ---- -- -=== Description -`origin_node_id` and `routine_id` can be retrived via `CONTINUOUS_QUERIES` view. +=== Parameters + +* `origin_node_id` and `routine_id` - can be retrived via the link:monitoring-metrics/system-views#continuous_queries[CONTINUOUS_QUERIES] view. === Example @@ -343,10 +347,12 @@ tab:Unix[] tab:Windows[] [source,bash] ---- -.\control.bat --kill SERVICE name +control.bat --kill SERVICE name ---- -- -=== Description -`name` of the service user specifies on deployment. It can be retrieved via `SERVICES` view, also. \ No newline at end of file +=== Parameters + +* `name` - corresponds to the name you selected for the service upon the deployment time. +You can always find it with the link:monitoring-metrics/system-views#services[SERVICES] view.