Skip to content

Commit 63a062c

Browse files
committed
change Explain PostgreSQL to Explain Tensor
1 parent e4f886a commit 63a062c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+371
-284
lines changed

docs/en_US/developer_tools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ PL/SQL code.
1818
erd_tool
1919
psql_tool
2020
ai_tools
21-
expl_pgsql
21+
expl_tensor
Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.. _expl_pgsql:
1+
.. _expl_tensor:
22

33
***************************
4-
`Explain PostgreSQL`:index:
4+
`Explain Tensor`:index:
55
***************************
66

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.
88

99
Key Features:
1010

@@ -14,32 +14,34 @@ Key Features:
1414

1515
**Requirements:**
1616

17-
Before using the Explain PostgreSQL module, ensure the following:
17+
Before using the Explain Tensor module, ensure the following:
1818

1919
1. You are connected to a PostgreSQL server with sufficient privileges to execute commands.
2020

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>`.
2224

2325
**Note:**
2426

25-
* Using Explain PostgreSQL requires an active internet connection.
27+
* Using Explain Tensor requires an active internet connection.
2628

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
2830
(by default: https://explain.tensor.ru).
2931

3032

31-
Configuring Explain PostgreSQL
33+
Configuring Explain Tensor
3234
******************************
3335

34-
To configure Explain PostgreSQL, navigate to *File → Preferences → Explain PostgreSQL*.
36+
To configure Explain Tensor, navigate to *File → Preferences → Explain Tensor*.
3537

36-
.. image:: images/preferences_expl_pgsql.png
37-
:alt: Explain PostgreSQL preferences
38+
.. image:: images/preferences_expl_tensor.png
39+
:alt: Explain Tensor preferences
3840
:align: center
3941

4042
1. Set the **Explain Plan** switch to *True*.
4143

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).
4345

4446
3. Set the **Format SQL** switch to *True* if you want to use the SQL formatting capability.
4547

@@ -48,7 +50,7 @@ To configure Explain PostgreSQL, navigate to *File → Preferences → Explain P
4850
After configuring, click *Save* to apply the changes.
4951

5052

51-
Using Explain PostgreSQL
53+
Using Explain Tensor
5254
*************************
5355

5456
To analyze a query plan:
@@ -61,17 +63,17 @@ To analyze a query plan:
6163

6264
4. Click the **Explain Analyze** button in the toolbar (or press ``Shift+F7``) to generate the execution plan.
6365

64-
Upon successful generation, the *Explain PostgreSQL* panel will appear.
66+
Upon successful generation, the *Explain Tensor* panel will appear.
6567

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
6870
:align: center
6971

7072

7173
Understanding Execution Plans
7274
*****************************
7375

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:
7577

7678
* **Plan Tree** – A simplified view of the execution algorithm. Numeric indicators are displayed separately and highlighted with colors indicating load intensity.
7779

@@ -81,50 +83,50 @@ Each node in the execution plan represents a step in query processing. The Expla
8183
* Yellow – Medium cost
8284
* Red – High cost (potential bottleneck)
8385

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
8688
:align: center
8789

8890
* **Diagram** – Shows real dependencies between nodes and resource flows.
8991

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
9294
:align: center
9395

9496
* **Schema** – Visualizes database tables and their relationships.
9597

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
98100
:align: center
99101

100102
* **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.
101103

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
104106
:align: center
105107

106108
* **Pie Chart** – Helps quickly identify dominant nodes and their approximate share of resource consumption.
107109

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
110112
:align: center
111113

112114
* **Tiled Visualization** – Allows compact evaluation of node connections in large plans and highlights problematic sections.
113115

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
116118
:align: center
117119

118120
* **Smart Recommendations** – Automatically generated based on structural and resource metrics, these provide precise guidance on resolving performance issues.
119121

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
122124
:align: center
123125

124126
* **Personal Archive** – Contains all the plans you've analyzed, giving you instant access regardless of whether they were published publicly.
125127

126-
.. image:: images/expl_pgsql_personal.png
127-
:alt: Example of Explain PostgreSQL personal archive
128+
.. image:: images/expl_tensor_personal.png
129+
:alt: Example of Explain Tensor personal archive
128130
:align: center
129131

130132

-143 KB
Binary file not shown.
-242 KB
Binary file not shown.
-41.2 KB
Binary file not shown.
-130 KB
Binary file not shown.
-302 KB
Binary file not shown.
-415 KB
Binary file not shown.
-184 KB
Binary file not shown.
-185 KB
Binary file not shown.

0 commit comments

Comments
 (0)