pgadmin4/docs/en_US
Ashesh Vashi 6e4923d762 Fixes # 4778 - Implement the query plan analyzer
Look 'n' Feel and implementation logic are inspired from
'http://explain.depsez.com'.

It now creates three tabs under the 'Explain' panel when executing a
query using the Explain Analyze/Explain button from the toolbar of the
Query tool.

Graphical
---------
-> Graphical Explain Plan

Analysis
--------
-> Table to show details of the explain plan analyse.
-> Each row represents the statistics per Explain Plan Node
-> It may contains columns like node information, exclusive timing
   (time spent for this explain node excluding the child nodes),
   inclusive timing, actual rows, plan rows,
   rowsx (misestimation between planned vs actual rows), loop.
-> Background color of exclusive, inclusive, rows changes based on
   their values.
i.e.
If Percentage of exclusive, and inclusive timings of total query time
is:
> 90 - Red Color
> 50 - Orange (Between Red & Yellow Color)
> 10 - Yellow color

If planner misestimation for the rows is
> 1000 times - Red Color
> 100 times - Orange (Between Red & Yellow Color)
> 10 times - Yellow Color
Also - if actual rows <= planned rows then it shows up arrow, else it
shows down arrow.

Statistics
----------
-> It contains a HTML table for the statistics per Node Type, and
   a HTML table for the statistics per table.

Reviewed by: Akshay Joshi
2019-10-08 16:44:24 +05:30
..
images Fixes # 4778 - Implement the query plan analyzer 2019-10-08 16:44:24 +05:30
theme/pgadmin4 Minor doc styling tweaks. 2019-08-22 15:11:59 +01:00
.gitignore More doc updates. 2016-06-07 09:04:58 +01:00
add_restore_point_dialog.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
backup_and_restore.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
backup_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
backup_globals_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
backup_server_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
build_code_snippet.py Apply codestyle checks to all Python code. 2019-03-20 11:17:51 +00:00
cast_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
change_password_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
change_user_password.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
check_dialog.rst Clarify wording for the NO INHERIT option on constraints, per Michel Feinstein. Fixes #4275 2019-05-21 11:51:19 +01:00
clear_saved_passwords.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
code_overview.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
code_review.rst Update copyright notices for 2019 2019-01-02 15:54:12 +05:30
coding_standards.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
collation_dialog.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
column_dialog.rst Add support for generated columns in Postgres 12+. Fixes #4334 2019-07-25 16:38:26 +01:00
compound_trigger_dialog.rst 1) Ensure compound triggers should be displayed under Views. Fixes #4638. 2019-08-20 09:39:31 +05:30
conf.py Use our own doc theme. 2019-07-04 14:10:01 +01:00
config_py.rst Allow configuration options to be set from the environment in the container distribution. Fixes #4651 2019-08-22 15:24:04 +01:00
connect_error.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
connect_to_server.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
connecting.rst 1. Added Master Password to increase the security of saved passwords. Fixes #4184 2019-05-28 12:00:18 +05:30
container_deployment.rst Tidy up formatting and wording. 2019-09-27 10:51:18 +01:00
contributions.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
database_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
debugger.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
deployment.rst Allow configuration options to be set from the environment in the container distribution. Fixes #4651 2019-08-22 15:24:04 +01:00
desktop_deployment.rst Allow configuration options to be set from the environment in the container distribution. Fixes #4651 2019-08-22 15:24:04 +01:00
developer_tools.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
domain_constraint_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
domain_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
editgrid.rst Ensure that 'ENTER' key in the data filter should not run the query. Fixes #4199 2019-09-20 18:13:44 +05:30
event_trigger_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
exclusion_constraint_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
extension_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
foreign_data_wrapper_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
foreign_key_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
foreign_server_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
foreign_table_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
fts_configuration_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
fts_dictionary_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
fts_parser_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
fts_template_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
function_dialog.rst Use the full tab space for CodeMirror instances on dialogues where appropriate. Fixes #4540 2019-08-02 10:25:21 +01:00
getting_started.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
grant_wizard.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
import_export_data.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
import_export_servers.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
index_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
index.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
keyboard_shortcuts.rst Add support for editing of resultsets in the Query Tool, if the data can be identified as updatable. Fixes #1760 2019-07-17 11:45:20 +01:00
language_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
licence.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
login.rst 1. Added Master Password to increase the security of saved passwords. Fixes #4184 2019-05-28 12:00:18 +05:30
maintenance_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
Makefile.sphinx Treat doc build warnings as errors for CI purposes and correctness. 2017-03-27 22:10:39 -04:00
management_basics.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
managing_cluster_objects.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
managing_database_objects.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
master_password.rst Clarify warnings about disabling the master password. 2019-06-05 15:32:47 +01:00
materialized_view_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
menu_bar.rst Allow the UI layout to be fully locked or to prevent docking changes. Fixes #2653 2019-05-31 11:51:30 -04:00
modifying_tables.rst 1) Add support of Compound Triggers for EPAS 12+. Fixes #4144. 2019-08-08 16:59:11 +05:30
move_objects.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
package_dialog.rst Use the full tab space for CodeMirror instances on dialogues where appropriate. Fixes #4540 2019-08-02 10:25:21 +01:00
pgagent_install.rst Fix indent. 2019-03-21 14:05:40 +00:00
pgagent_jobs.rst Update the documentation for pgAgent to clarify Batch jobs won't run on remote servers. Fix minor css issue in docs. 2019-08-12 11:45:54 +05:30
pgagent.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
preferences.rst Add editor options for plain text mode and to disable block folding to 2019-09-04 15:46:08 +01:00
primary_key_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
procedure_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
query_tool_toolbar.rst Add support for editing of resultsets in the Query Tool, if the data can be identified as updatable. Fixes #1760 2019-07-17 11:45:20 +01:00
query_tool.rst Fixes # 4778 - Implement the query plan analyzer 2019-10-08 16:44:24 +05:30
release_notes_1_0.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
release_notes_1_1.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_1_2.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_1_3.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_1_4.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_1_5.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_1_6.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_2_0.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_2_1.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_0.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_1.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_2.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_3.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_4.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_5.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_3_6.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_0.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_1.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_2.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_3.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_4.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_5.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_6.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_7.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_8.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_9.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_10.rst Don't distinguish between issue types in their URL text. 2019-07-05 11:38:12 +01:00
release_notes_4_11.rst 1) Fix an error while retrieving json data from the table. Fixes #4427 2019-07-22 18:42:48 +05:30
release_notes_4_12.rst 1) Ensure compound triggers should be displayed under Views. Fixes #4638. 2019-08-20 09:39:31 +05:30
release_notes_4_13.rst Fix query history exception for Python 3.6. Fixes #4750. 2019-09-16 19:09:22 +05:30
release_notes_4_14.rst Fixes # 4778 - Implement the query plan analyzer 2019-10-08 16:44:24 +05:30
release_notes.rst Add Reverse Engineered and Modified SQL tests for Unique Constraints. Fixes #4628 2019-09-20 12:12:01 +05:30
resource_group_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
restore_dialog.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
role_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
rule_dialog.rst Fix generation of reverse engineered SQL for Rules. Fixes #4586 2019-08-12 14:27:02 +05:30
schema_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
sequence_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
server_deployment.rst Allow configuration options to be set from the environment in the container distribution. Fixes #4651 2019-08-22 15:24:04 +01:00
server_dialog.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
server_group_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
submitting_patches.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
synonym_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
tabbed_browser.rst Tidy up table formatting in the docs. Thanks to Susan Douglas for the tips! 2019-03-21 11:38:34 +00:00
table_dialog.rst Clarify wording for the NO INHERIT option on constraints, per Michel Feinstein. Fixes #4275 2019-05-21 11:51:19 +01:00
tablespace_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
toolbar.rst Ensure that 'ENTER' key in the data filter should not run the query. Fixes #4199 2019-09-20 18:13:44 +05:30
translations.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
tree_control.rst Allow some objects to be dragged/dropped into the Query Tool to insert their signature into the query text. Fixes #4139 2019-06-27 10:30:05 -04:00
trigger_dialog.rst Use the full tab space for CodeMirror instances on dialogues where appropriate. Fixes #4540 2019-08-02 10:25:21 +01:00
trigger_function_dialog.rst Use the full tab space for CodeMirror instances on dialogues where appropriate. Fixes #4540 2019-08-02 10:25:21 +01:00
type_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
unique_constraint_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
user_interface.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
user_management.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
user_mapping_dialog.rst Major doc cleanup: 2019-03-08 15:29:05 +00:00
using_pgagent.rst Update links in docs to https where possible, and fix a couple of broken/out of date ones. 2019-03-12 14:24:46 +00:00
view_dialog.rst Use the full tab space for CodeMirror instances on dialogues where appropriate. Fixes #4540 2019-08-02 10:25:21 +01:00
viewdata_filter.rst Ensure that 'ENTER' key in the data filter should not run the query. Fixes #4199 2019-09-20 18:13:44 +05:30