You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en_US/expl_tensor.rst
+35-33Lines changed: 35 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
.. _expl_pgsql:
1
+
.. _expl_tensor:
2
2
3
3
***************************
4
-
`Explain PostgreSQL`:index:
4
+
`Explain Tensor`:index:
5
5
***************************
6
6
7
-
**Explain PostgreSQL** is a powerful module integrated into pgAdmin 4 that enables advanced analysis of query execution plans and beautification of SQL code. This tool helps developers and DBAs understand how PostgreSQL executes queries, identify performance bottlenecks, and optimize database workloads effectively.
7
+
**Explain Tensor** is a powerful module integrated into pgAdmin 4 that enables advanced analysis of query execution plans and beautification of SQL code. This tool helps developers and DBAs understand how PostgreSQL executes queries, identify performance bottlenecks, and optimize database workloads effectively.
8
8
9
9
Key Features:
10
10
@@ -14,32 +14,34 @@ Key Features:
14
14
15
15
**Requirements:**
16
16
17
-
Before using the Explain PostgreSQL module, ensure the following:
17
+
Before using the Explain Tensor module, ensure the following:
18
18
19
19
1. You are connected to a PostgreSQL server with sufficient privileges to execute commands.
20
20
21
-
2. Configure Explain PostgreSQL in :ref:`Preferences → Explain PostgreSQL <the-explain-postgresql-node>`.
21
+
2. Ensure Explain Tensor are enabled in the server configuration (set ``EXPLAIN_TENSOR_ENABLED`` to ``True`` in ``config.py``).
22
+
23
+
3. Configure Explain Tensor in :ref:`Preferences → Explain Tensor <the-explain-tensor-node>`.
22
24
23
25
**Note:**
24
26
25
-
* Using Explain PostgreSQL requires an active internet connection.
27
+
* Using Explain Tensor requires an active internet connection.
26
28
27
-
* When analyzing query plans via Explain PostgreSQL, the plan and query are sent to a third-party service
29
+
* When analyzing query plans via Explain Tensor, the plan and query are sent to a third-party service
28
30
(by default: https://explain.tensor.ru).
29
31
30
32
31
-
Configuring Explain PostgreSQL
33
+
Configuring Explain Tensor
32
34
******************************
33
35
34
-
To configure Explain PostgreSQL, navigate to *File → Preferences → Explain PostgreSQL*.
36
+
To configure Explain Tensor, navigate to *File → Preferences → Explain Tensor*.
35
37
36
-
.. image:: images/preferences_expl_pgsql.png
37
-
:alt:Explain PostgreSQL preferences
38
+
.. image:: images/preferences_expl_tensor.png
39
+
:alt:Explain Tensor preferences
38
40
:align:center
39
41
40
42
1. Set the **Explain Plan** switch to *True*.
41
43
42
-
2. Enter the *Explain PostgreSQL API* URL (default: https://explain.tensor.ru).
44
+
2. Enter the *Explain Tensor API* URL (default: https://explain.tensor.ru).
43
45
44
46
3. Set the **Format SQL** switch to *True* if you want to use the SQL formatting capability.
45
47
@@ -48,7 +50,7 @@ To configure Explain PostgreSQL, navigate to *File → Preferences → Explain P
48
50
After configuring, click *Save* to apply the changes.
49
51
50
52
51
-
Using Explain PostgreSQL
53
+
Using Explain Tensor
52
54
*************************
53
55
54
56
To analyze a query plan:
@@ -61,17 +63,17 @@ To analyze a query plan:
61
63
62
64
4. Click the **Explain Analyze** button in the toolbar (or press ``Shift+F7``) to generate the execution plan.
63
65
64
-
Upon successful generation, the *Explain PostgreSQL* panel will appear.
66
+
Upon successful generation, the *Explain Tensor* panel will appear.
65
67
66
-
.. image:: images/expl_pgsql_analyze.png
67
-
:alt:Example of Explain PostgreSQL output
68
+
.. image:: images/expl_tensor_analyze.png
69
+
:alt:Example of Explain Tensor output
68
70
:align:center
69
71
70
72
71
73
Understanding Execution Plans
72
74
*****************************
73
75
74
-
Each node in the execution plan represents a step in query processing. The Explain PostgreSQL module displays:
76
+
Each node in the execution plan represents a step in query processing. The Explain Tensor module displays:
75
77
76
78
* **Plan Tree** – A simplified view of the execution algorithm. Numeric indicators are displayed separately and highlighted with colors indicating load intensity.
77
79
@@ -81,50 +83,50 @@ Each node in the execution plan represents a step in query processing. The Expla
81
83
* Yellow – Medium cost
82
84
* Red – High cost (potential bottleneck)
83
85
84
-
.. image:: images/expl_pgsql_plantree.png
85
-
:alt:Example of Explain PostgreSQL plan tree
86
+
.. image:: images/expl_tensor_plantree.png
87
+
:alt:Example of Explain Tensor plan tree
86
88
:align:center
87
89
88
90
* **Diagram** – Shows real dependencies between nodes and resource flows.
89
91
90
-
.. image:: images/expl_pgsql_diagram.png
91
-
:alt:Example of Explain PostgreSQL diagram
92
+
.. image:: images/expl_tensor_diagram.png
93
+
:alt:Example of Explain Tensor diagram
92
94
:align:center
93
95
94
96
* **Schema** – Visualizes database tables and their relationships.
95
97
96
-
.. image:: images/expl_pgsql_schema.png
97
-
:alt:Example of Explain PostgreSQL schema
98
+
.. image:: images/expl_tensor_schema.png
99
+
:alt:Example of Explain Tensor schema
98
100
:align:center
99
101
100
102
* **Statistics** – Summary statistics allow you to analyze large plans in aggregated form, sorted by any metric such as execution time, disk reads, cache usage, or filtered rows.
101
103
102
-
.. image:: images/expl_pgsql_stats.png
103
-
:alt:Example of Explain PostgreSQL statistics
104
+
.. image:: images/expl_tensor_stats.png
105
+
:alt:Example of Explain Tensor statistics
104
106
:align:center
105
107
106
108
* **Pie Chart** – Helps quickly identify dominant nodes and their approximate share of resource consumption.
107
109
108
-
.. image:: images/expl_pgsql_piechart.png
109
-
:alt:Example of Explain PostgreSQL pie chart
110
+
.. image:: images/expl_tensor_piechart.png
111
+
:alt:Example of Explain Tensor pie chart
110
112
:align:center
111
113
112
114
* **Tiled Visualization** – Allows compact evaluation of node connections in large plans and highlights problematic sections.
113
115
114
-
.. image:: images/expl_pgsql_tilemap.png
115
-
:alt:Example of Explain PostgreSQL tiled visualization
116
+
.. image:: images/expl_tensor_tilemap.png
117
+
:alt:Example of Explain Tensor tiled visualization
116
118
:align:center
117
119
118
120
* **Smart Recommendations** – Automatically generated based on structural and resource metrics, these provide precise guidance on resolving performance issues.
119
121
120
-
.. image:: images/expl_pgsql_recs.png
121
-
:alt:Example of Explain PostgreSQL recommendations
122
+
.. image:: images/expl_tensor_recs.png
123
+
:alt:Example of Explain Tensor recommendations
122
124
:align:center
123
125
124
126
* **Personal Archive** – Contains all the plans you've analyzed, giving you instant access regardless of whether they were published publicly.
125
127
126
-
.. image:: images/expl_pgsql_personal.png
127
-
:alt:Example of Explain PostgreSQL personal archive
0 commit comments