diff --git a/docs/en_US/images/preferences_dashboard_display.png b/docs/en_US/images/preferences_dashboard_display.png index 6d67e23de..e0cc4d28a 100644 Binary files a/docs/en_US/images/preferences_dashboard_display.png and b/docs/en_US/images/preferences_dashboard_display.png differ diff --git a/docs/en_US/images/preferences_dashboard_graphs.png b/docs/en_US/images/preferences_dashboard_graphs.png index df3ea7b2b..219413634 100644 Binary files a/docs/en_US/images/preferences_dashboard_graphs.png and b/docs/en_US/images/preferences_dashboard_graphs.png differ diff --git a/docs/en_US/images/preferences_dashboard_refresh.png b/docs/en_US/images/preferences_dashboard_refresh.png new file mode 100644 index 000000000..a33312ae3 Binary files /dev/null and b/docs/en_US/images/preferences_dashboard_refresh.png differ diff --git a/docs/en_US/images/query_data_editing.png b/docs/en_US/images/query_data_editing.png index 74b65682c..66c1354e3 100644 Binary files a/docs/en_US/images/query_data_editing.png and b/docs/en_US/images/query_data_editing.png differ diff --git a/docs/en_US/images/query_execute_section.png b/docs/en_US/images/query_execute_section.png index f41d9d647..dd596e458 100644 Binary files a/docs/en_US/images/query_execute_section.png and b/docs/en_US/images/query_execute_section.png differ diff --git a/docs/en_US/images/query_graph_toolbar.png b/docs/en_US/images/query_graph_toolbar.png new file mode 100644 index 000000000..e252b5a86 Binary files /dev/null and b/docs/en_US/images/query_graph_toolbar.png differ diff --git a/docs/en_US/images/query_graph_type.png b/docs/en_US/images/query_graph_type.png new file mode 100644 index 000000000..aa62f6025 Binary files /dev/null and b/docs/en_US/images/query_graph_type.png differ diff --git a/docs/en_US/images/query_graph_visualiser_panel.png b/docs/en_US/images/query_graph_visualiser_panel.png new file mode 100644 index 000000000..0e61e7892 Binary files /dev/null and b/docs/en_US/images/query_graph_visualiser_panel.png differ diff --git a/docs/en_US/images/query_graph_xaxis.png b/docs/en_US/images/query_graph_xaxis.png new file mode 100644 index 000000000..0926ca6d9 Binary files /dev/null and b/docs/en_US/images/query_graph_xaxis.png differ diff --git a/docs/en_US/images/query_graph_yaxis.png b/docs/en_US/images/query_graph_yaxis.png new file mode 100644 index 000000000..9d08a7a22 Binary files /dev/null and b/docs/en_US/images/query_graph_yaxis.png differ diff --git a/docs/en_US/images/query_line_chart.png b/docs/en_US/images/query_line_chart.png new file mode 100644 index 000000000..4be3d419b Binary files /dev/null and b/docs/en_US/images/query_line_chart.png differ diff --git a/docs/en_US/images/query_output_data.png b/docs/en_US/images/query_output_data.png index a53546527..fcd809bb5 100644 Binary files a/docs/en_US/images/query_output_data.png and b/docs/en_US/images/query_output_data.png differ diff --git a/docs/en_US/images/query_output_notifications_notify.png b/docs/en_US/images/query_output_notifications_notify.png index 9e0ba1d94..7bc5790d2 100644 Binary files a/docs/en_US/images/query_output_notifications_notify.png and b/docs/en_US/images/query_output_notifications_notify.png differ diff --git a/docs/en_US/images/query_tool.png b/docs/en_US/images/query_tool.png index 6b79205df..f8471e574 100644 Binary files a/docs/en_US/images/query_tool.png and b/docs/en_US/images/query_tool.png differ diff --git a/docs/en_US/images/query_tool_editable_columns.png b/docs/en_US/images/query_tool_editable_columns.png index 3dea445cb..034125da5 100644 Binary files a/docs/en_US/images/query_tool_editable_columns.png and b/docs/en_US/images/query_tool_editable_columns.png differ diff --git a/docs/en_US/images/query_tool_macros_execution.png b/docs/en_US/images/query_tool_macros_execution.png deleted file mode 100644 index 3383a2487..000000000 Binary files a/docs/en_US/images/query_tool_macros_execution.png and /dev/null differ diff --git a/docs/en_US/preferences.rst b/docs/en_US/preferences.rst index 50898d5e9..1cfa8bdb2 100644 --- a/docs/en_US/preferences.rst +++ b/docs/en_US/preferences.rst @@ -131,12 +131,25 @@ The Dashboards Node Expand the *Dashboards* node to specify your dashboard display preferences. -.. image:: images/preferences_dashboard_graphs.png - :alt: Preferences dialog dashboard graph options +.. image:: images/preferences_dashboard_display.png + :alt: Preferences dialog dashboard display options :align: center -Use the fields on the *Graphs* panel to specify your display preferences for -the graphs on the *Dashboard* tab: +* Set the warning and alert threshold value to highlight the long-running + queries on the dashboard. + +* When the *Show activity?* switch is set to *True*, activity tables will be + displayed on dashboards. + +* When the *Show graphs?* switch is set to *True*, graphs will be displayed on + dashboards. + +.. image:: images/preferences_dashboard_refresh.png + :alt: Preferences dialog dashboard refresh options + :align: center + +Use the fields on the *Refresh rates* panel to specify your refersh rates +preferences for the graphs on the *Dashboard* tab: * Use the *Block I/O statistics refresh rate* field to specify the number of seconds between block I/O statistic samples displayed in graphs. @@ -153,24 +166,6 @@ the graphs on the *Dashboard* tab: * Use the *Tuples out refresh rate* field to specify the number of seconds between tuples-out samples displayed in graphs. -.. image:: images/preferences_dashboard_display.png - :alt: Preferences dialog dashboard display options - :align: center - -* Set the warning and alert threshold value to highlight the long-running - queries on the dashboard. - -* When the *Show activity?* switch is set to *True*, activity tables will be - displayed on dashboards. - -* When the *Show graph data points?* switch is set to *True*, data points will - be visible on graph lines. - -* When the *Show graphs?* switch is set to *True*, graphs will be displayed on - dashboards. - -* When the *Show mouse hover tooltip?* switch is set to *True*, a tooltip will - appear on mouse hover on the graph lines giving the data point details. The Debugger Node @@ -197,6 +192,24 @@ ERD Tool window navigation: :alt: Preferences dialog erd keyboard shortcuts section :align: center +The Graphs Node +*************** + +Expand the *Graphs* node to specify your Graphs display preferences. + +.. image:: images/preferences_dashboard_graphs.png + :alt: Preferences dialog dashboard graph options + :align: center + +* When the *Show graph data points?* switch is set to *True*, data points will + be visible on graph lines. + +* When the *Show mouse hover tooltip?* switch is set to *True*, a tooltip will + appear on mouse hover on the graph lines giving the data point details. + +* When the *Use different data point styles?* switch is set to *True*, + data points will be visible in a different style on each graph lines. + The Miscellaneous Node ********************** diff --git a/docs/en_US/query_tool.rst b/docs/en_US/query_tool.rst index af8e7cfa0..ae94dc84c 100644 --- a/docs/en_US/query_tool.rst +++ b/docs/en_US/query_tool.rst @@ -106,6 +106,45 @@ fully qualified with schema. Double quotes will be added if required. For functions and procedures, the function name along with parameter names will be pasted in the Query Tool. +Query History Panel +******************* + +Use the *Query History* tab to review activity for the current session: + +.. image:: images/query_output_history.png + :alt: Query tool history panel + :align: center + +The Query History tab displays information about recent commands: + +* The date and time that a query was invoked. +* The text of the query. +* The number of rows returned by the query. +* The amount of time it took the server to process the query and return a + result set. +* Messages returned by the server (not noted on the *Messages* tab). +* The source of the query (indicated by icons corresponding to the toolbar). + +You can show or hide the queries generated internally by pgAdmin (during +'View/Edit Data' or 'Save Data' operations). + +You can remove a single query by selecting it and clicking on the *Remove* +button. If you would like to remove all of the histories from the +*Query History* tab, then click on the *Remove All* button. + +By using the *Copy* button, you can copy a particular query to the clipboard, +and with the *Copy to Query Editor* button, you can copy a specific query to +the Query Editor tab. During this operation, all existing content in the +Query Editor is erased. + +Query History is maintained across sessions for each database on a per-user +basis when running in Query Tool mode. In View/Edit Data mode, history is not +retained. By default, the last 20 queries are stored for each database. This +can be adjusted in ``config_local.py`` or ``config_system.py`` (see the +:ref:`config.py ` documentation) by overriding the +`MAX_QUERY_HIST_STORED` value. See the :ref:`Deployment ` section +for more information. + The Data Output Panel ********************* @@ -288,44 +327,71 @@ particular channel. :alt: Query tool notifications panel :align: center -Query History Panel -******************* +Graph Visualiser Panel +********************** -Use the *Query History* tab to review activity for the current session: +Click the Graph Visualiser button in the toolbar to generate the *Graphs* of +the query results. The graph visualiser currently supports only Line Charts, +but more charts (Bar, Stacked Bar, Pie...) will be added soon. -.. image:: images/query_output_history.png - :alt: Query tool history panel +.. image:: images/query_graph_visualiser_panel.png + :alt: Query tool graph visualiser panel :align: center -The Query History tab displays information about recent commands: +* X Axis -* The date and time that a query was invoked. -* The text of the query. -* The number of rows returned by the query. -* The amount of time it took the server to process the query and return a - result set. -* Messages returned by the server (not noted on the *Messages* tab). -* The source of the query (indicated by icons corresponding to the toolbar). +Choose the column whose value you wish to display on X-axis from the *X Axis* +dropdown. Select the ** option to use the number of rows as labels +on the X-axis. -You can show or hide the queries generated internally by pgAdmin (during -'View/Edit Data' or 'Save Data' operations). +.. image:: images/query_graph_xaxis.png + :alt: Query tool graph visualiser xaxis + :align: center -You can remove a single query by selecting it and clicking on the *Remove* -button. If you would like to remove all of the histories from the -*Query History* tab, then click on the *Remove All* button. +* Y Axis -By using the *Copy* button, you can copy a particular query to the clipboard, -and with the *Copy to Query Editor* button, you can copy a specific query to -the Query Editor tab. During this operation, all existing content in the -Query Editor is erased. +Choose the columns whose value you wish to display on Y-axis from the *Y Axis* +dropdown. Users can choose multiple columns. Choose the *'))) { selectVal = filteredOptions; } /* If multi select options need to be in some format by UI, use formatter */ @@ -905,7 +905,7 @@ export const InputSelect = forwardRef(({ openMenuOnClick: !readonly, onChange: onChangeOption, isLoading: isLoading, - options: controlProps.allowSelectAll ? [{ label: gettext('Select All'), value: '*' }, ...filteredOptions] : filteredOptions, + options: controlProps.allowSelectAll ? [{ label: gettext('