This is an automated email from the ASF dual-hosted git repository.
sk0x50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new 1ae86075f3a IGNITE-26831 Update system views list (#6848)
1ae86075f3a is described below
commit 1ae86075f3ac3734954293dc0e799d9024308e7b
Author: jinxxxoid <[email protected]>
AuthorDate: Mon Nov 10 16:21:07 2025 +0400
IGNITE-26831 Update system views list (#6848)
---
docs/_docs/developers-guide/sql/system-views.adoc | 105 ++++++++++++++++++++++
1 file changed, 105 insertions(+)
diff --git a/docs/_docs/developers-guide/sql/system-views.adoc
b/docs/_docs/developers-guide/sql/system-views.adoc
new file mode 100644
index 00000000000..65c20e8e1b3
--- /dev/null
+++ b/docs/_docs/developers-guide/sql/system-views.adoc
@@ -0,0 +1,105 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You under the Apache License, Version 2.0
+// (the "License"); you may not use this file except in compliance with
+// the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+= System Views
+
+Ignite provides a number of built-in SQL views that provide information on the
cluster's state and provide real-time insight into the status of its
components. These views are available in the SYSTEM schema.
+
+== Getting Data
+
+You access system views in Ignite by using SQL and selecting data from the
system view like you would from any other table. For example, you can get a
list of all available system views in the following way:
+
+[source, sql]
+----
+SELECT id, schema, name FROM system.system_views WHERE type = 'NODE'
+----
+
+You can also use joins to combine data from multiple views. The example below
returns all columns of a view that was found in the `SYSTEM_VIEWS` view:
+
+[source, sql]
+----
+SELECT svc.*
+ FROM system.system_view_columns svc
+ JOIN system.system_views sv ON svc.view_id = sv.id
+ WHERE sv.name = 'SYSTEM_VIEWS'
+----
+
+== Available Views
+
+=== SYSTEM_VIEWS
+
+Describes available system views.
+
+[width="100%", cols="15%a, 15%a, 60%a",opts="header"]
+|=======
+|Column |Data Type| Description
+
+| ID | INT32 | System view ID.
+| SCHEMA | STRING | Name of the schema used. Default is `SYSTEM`.
+| NAME | STRING | System view name.
+| TYPE | STRING | System view type. Possible values:
+
+* NODE - The view provides node-specific information. Data will be collected
from all nodes, and represented in the view.
+* CLUSTER - The view provides cluster-wide information. Data will be collected
from one node, chosen to represent the cluster.
+
+|=======
+
+=== SYSTEM_VIEW_COLUMNS
+
+Describes available system view columns.
+
+[width="100%", cols="15%a, 15%a, 60%a",opts="header"]
+|=======
+|Column |Data Type| Description
+
+| VIEW_ID | INT32 | System view ID.
+| NAME | STRING | Column name.
+| TYPE | STRING | Column type. Can by any of the
link:sql-reference/data-types[supported types].
+| NULLABLE | BOOLEAN |Defines if the column can be empty.
+| PRECISION | INT32 |Maximum number of digits.
+| SCALE | INT32 |Maximum number of decimal places.
+| LENGTH | INT32 |Maximum length of the value. Symbols for string values or
bytes for binary values.
+
+|=======
+
+=== SYSTEM.ZONES
+
+[width="100%", cols="15%a, 15%a, 60%a",opts="header"]
+|=======
+|Column |Data Type| Description
+
+| NAME | STRING | The name of the distribution zone.
+| PARTITIONS | INT32 | The number of partitions in the distribution zone.
+| REPLICAS | STRING |The number of copies of each partition in the
distribution zone.
+| DATA_NODES_AUTO_ADJUST_SCALE_UP | INT32 | The delay in seconds between the
new node joining and the start of data zone adjustment.
+| DATA_NODES_AUTO_ADJUST_SCALE_DOWN | INT32 | The delay in seconds between the
node leaving the cluster and the start of data zone adjustment.
+| DATA_NODES_FILTER | STRING | The filter that specifies what nodes will be
used by the distribution zone.
+| IS_DEFAULT_ZONE | BOOLEAN | Defines if the data zone is used by default.
+
+|=======
+
+=== SQL_CACHED_QUERY_PLANS
+
+[width="100%", cols="15%a,15%a,60%a", opts="header"]
+|=======
+|Column |Data Type |Description
+| NODE_ID | STRING | ID of the node where the plan is cached.
+| PLAN_ID | STRING | Internal identifier of the prepared plan.
+| CATALOG_VERSION | INT32 | Catalog version used when the query was prepared.
+| QUERY_DEFAULT_SCHEMA | STRING | Default schema applied during query
preparation.
+| SQL | STRING | Normalized SQL text of the query.
+| QUERY_TYPE | STRING | Query type.
+| QUERY_PLAN | STRING | Serialized or explain representation of the chosen
query plan.
+| QUERY_PREPARE_TIME | TIMESTAMP WITH LOCAL TIME ZONE | Time the plan was
prepared on the node.
+|=======
