.. _query_tool_toolbar: *************************** `Query Tool Toolbar`:index: *************************** The *Query Tool* toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled. .. note:: The :ref:`Query Tool ` and :ref:`View/Edit Data ` tools are actually different operating modes of the same tool. Some controls will be disabled in either mode. .. image:: images/query_toolbar.png :alt: Query tool toolbar :align: center Hover over an icon in pgAdmin to display a tooltip that describes the icon's functionality. File Options ************ .. table:: :class: longtable :widths: 1 4 1 +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Icon | Behavior | Shortcut | +======================+===================================================================================================+================+ | *Open File* | Click the *Open File* icon to display a previously saved query in the SQL Editor. | Accesskey + O | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Save File* | Click the *Save* icon to perform a quick-save of a previously saved query, or to access the | Accesskey + S | | | *Save* menu: | | | | | | | | * Select *Save* to save the selected content of the SQL Editor panel in a file. | | | | | | | | * Select *Save As* to open a new browser dialog and specify a new location to which to save the | | | | selected content of the SQL Editor panel. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ Filter/Limit Options ******************** .. table:: :class: longtable :widths: 1 4 1 +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Icon | Behavior | Shortcut | +======================+===================================================================================================+================+ | *Filter* | Click the *Filter* icon to set filtering and sorting criteria for the data when in *View/Edit data| Accesskey + F | | | mode*. Click the down arrow to access other filtering and sorting options: | | | | | | | | * In the *SQL Filter*, you can enter a SQL query as filtering criteria. | | | | In *Data Sorting*, you can select the column and specify the order for sorting. | | | | | | | | * Click *Filter by Selection* to show only the rows containing the values in the selected cells. | | | | | | | | * Click *Exclude by Selection* to show only the rows that do not contain the values in the | | | | selected cells. | | | | | | | | * Click *Remove Sort/Filter* to remove any previously selected sort or filtering options. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Limit Selector | Select a value in the *Limit Selector* to limit the size of the dataset to a number of rows. | Accesskey + R | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ Query Editing Options ********************* .. image:: images/query_editing.png :alt: Query tool editing options :align: center .. table:: :class: longtable :widths: 1 4 1 +----------------------+---------------------------------------------------------------------------------------------------+-----------------------+ | Icon | Behavior | Shortcut | +======================+===================================================================================================+=======================+ | *Edit* | Use the *Edit* menu to search, replace, or navigate the code displayed in the SQL Editor: | | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Find* to provide a search target, and search the SQL Editor contents. | Cmd+F | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Replace* to locate and replace (with prompting) individual occurrences of the target. | Option+Cmd+F (MAC) | | | | Ctrl+Shift+F (Others) | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Jump* to navigate to the next occurrence of the search target. | Alt+G | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Indent Selection* to indent the currently selected text. | Tab | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Unindent Selection* to remove indentation from the currently selected text. | Shift+Tab | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Toggle Comment* to comment/uncomment any lines that contain the selection in SQL style. | Cmd+/ | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Clear Query* to clear the query editor window. | Cmd+. | | +---------------------------------------------------------------------------------------------------+-----------------------+ | | Select *Format SQL* to format the selected SQL or all the SQL if none is selected | Shift+Cmd+K | +----------------------+---------------------------------------------------------------------------------------------------+-----------------------+ Query Execution *************** .. image:: images/query_execution.png :alt: Query tool execute options :align: center .. table:: :class: longtable :widths: 1 4 1 +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Icon | Behavior | Shortcut | +======================+===================================================================================================+================+ | *Stop* | Click the *Stop* icon to cancel the execution of the currently running query. | Accesskey + Q | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Execute/Refresh* | Click the *Execute/Refresh* icon to either execute or refresh the query highlighted in the SQL | F5 | | | editor panel. Click the down arrow to access other execution options: | | | | | | | | * Add a check next to *Auto rollback on error?* to instruct the server to automatically roll back| | | | a transaction if an error occurs during the transaction. | | | | | | | | * Add a check next to *Auto commit?* to instruct the server to automatically commit each | | | | transaction. Any changes made by the transaction will be visible to others, and | | | | durable in the event of a crash. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Explain* | Click the *Explain* icon to view an explanation plan for the current query. The result of the | F7 | | | EXPLAIN is displayed graphically on the *Explain* tab of the output panel, and in text | | | | form on the *Data Output* tab. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Explain analyze* | Click the *Explain analyze* icon to invoke an EXPLAIN ANALYZE command on the current query. | Shift+F7 | | | | | | | Navigate through the *Explain Options* menu to select options for the EXPLAIN command: | | | | | | | | * Select *Verbose* to display additional information regarding the query plan. | | | | | | | | * Select *Costs* to include information on the estimated startup and total cost of each | | | | plan node, as well as the estimated number of rows and the estimated width of each | | | | row. | | | | | | | | * Select *Buffers* to include information on buffer usage. | | | | | | | | * Select *Timing* to include information about the startup time and the amount of time | | | | spent in each node of the query. | | | | | | | | * Select *Summary* to include the summary information about the query plan. | | | | | | | | * Select *Settings* to include the information on the configuration parameters. | | | | | | | | * Select *Wal* to include the information on WAL record generation. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Commit* | Click the *Commit* icon to commit the transaction. | Shift+CTRL+M | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Rollback* | Click the *Rollback* icon to rollback the transaction. | Shift+CTRL+R | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Macros* | Click the *Macros* icon to manage the macros. You can create, edit or clear the macros through | | | | the *Manage Macros* option. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ Data Editing Options ******************** .. image:: images/query_data_editing.png :alt: Query tool data editing options :align: center .. table:: :class: longtable :widths: 1 4 1 +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Icon | Behavior | Shortcut | +======================+===================================================================================================+================+ | *Add row* | Click the *Add row* icon to add a new row | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Copy* | Click the *Copy* icon to copy the content with or without header: | Accesskey + C | | | | | | | * Click the *Copy* icon to copy the content that is currently highlighted in the Data Output | | | | panel. | | | | | | | | * Click *Copy with headers* to copy the highlighted content along with the header. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Paste* | Click the *Paste* icon to paste a previously copied row with or without serial/identity values: | Accesskey + P | | | | | | | * Click the *Paste* icon to paste a previously copied row into a new row. | | | | | | | | * Click the *Paste with SERIAL/IDENTITY values?* if you want to paste the copied column values | | | | in the serial/identity columns. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Delete* | Click the *Delete* icon to mark the selected rows for deletion. These marked rows get deleted | Accesskey + D | | | when you click the *Save Data Changes* icon. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Save Data Changes* | Click the *Save Data Changes* icon to save data changes (insert, update, or delete) in the Data | F6 | | | Output Panel to the server. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | *Save results to* | Click the Save results to file icon to save the result set of the current query as a delimited | F8 | | *file* | text file (CSV, if the field separator is set to a comma). This button will only be enabled when | | | | a query has been executed and there are results in the data grid. You can specify the CSV/TXT | | | | settings in the Preference Dialogue under SQL Editor -> CSV/TXT output. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ | Graph Visualiser | Use the Graph Visualiser button to generate graphs of the query results. | | +----------------------+---------------------------------------------------------------------------------------------------+----------------+ Status Bar ********** .. image:: images/query_status_bar.png :alt: Query tool status bar :align: center The status bar shows the following information: * **Total rows**: The total number of rows returned by the query. * **Query complete**: The time is taken by the query to complete. * **Rows selected**: The number of rows selected in the data output panel. * **Changes staged**: This information showed the number of rows added, deleted, and updated. * **Ln**: In the Query tab, it is the line number at which the cursor is positioned. * **Col**: In the Query tab, it is the column number at which the cursor is positioned