Query console
Overview
Query consoles are SQL files that are associated with a data source and connected to it via a connection session. In query console you can compose and execute your SQL statements.
For example, if you open a query console for PostgreSQL, a connection session to the PostgreSQL data source is automatically created. When you open an SQL file from your hard drive, you need to specify the connection session first.
Database connection session
For each console, a data source connection session is created automatically. You can create new connection sessions and attach your console to existing ones in the console toolbar.
In the following example, the PostgreSQL console is associated with the guest.public
schema of a data source and connected to it via the console
connection session. You can change the console
session to actor
or create a new session and attach the console to it.
Read more about managing sessions in Managing connection sessions.
Code editor
The code editor is where you compose your SQL statements using the resolve modes and coding assistance features, and execute them against the associated data source.
Find the code editor toolbar controls in Code editor controls. Read more about the editor in Editor basics.
Resolve modes
In order to run SQL scripts, treat the usages of the database objects as links, and provide you with correct code completion, GoLand must resolve the database objects in your code to a certain context. By default, IDE uses one of the following as a starting point to resolve the database objects to: <schema> selector, or the default database (if none of the above is set).
For more information about resolve modes, refer to Resolve modes.
User parameters
Before execution of a parametrized statement, you see the Parameters window where you can specify values for the parameters.
SQL statement execution
When you execute a statement, the Services tool window opens. The Services tool window displays available connection sessions, Output and Result tabs. For more information about the Services tool windows, see Services tool window.
If the executed statement retrieves data (for example,
SELECT
), results are displayed in the Result tab that has a title of a qualified table name. For more information about creating custom titles for result tabs, see Use custom titles for tabs with results.If the executed statement does not retrieve data, results are displayed in the Output tab.
Services tool window.
Services tool window.
Right toolbar of the Output tab.
Code editor controls
Use the code editor to compose and execute your SQL statements as well as to perform other associated tasks.
Read more about the editor in Editor basics.
Toolbar controls
Item | Tooltip and shortcut | Description |
---|---|---|
Execute Ctrl+Enter | Execute selected SQL statement or statements. If nothing is selected, the current statement is executed. | |
Browse Query History Ctrl+Alt+E | Open a dialog that shows all the statements that you have run for the corresponding data source. See also, Using the History dialog. | |
View Parameters | Open or close the Parameters dialog. | |
Open Query Execution Settings… | Open the Settings dialog to view or edit the query execution settings. section of theFor more information on these settings, refer to Query Execution. | |
Transaction Mode and Transaction Isolation | Select the isolation level for database transactions and the way the transactions are committed.
For more information about database transaction modes and isolation, refer to Submit changes to a database. | |
Commit Ctrl+Alt+Shift+Enter | Commit the current transaction. See also, transaction modes and isolation. | |
Roll Back | Roll back changes. This button is available only for the manual transaction mode. See also, transaction modes and isolation. | |
Cancel Running Statements Ctrl+F2 | Terminate execution of the current statement or statements. | |
File Resolve Mode | Select the resolve mode to manage the context that database objects in your code are resolved to.
For more information about the resolve modes, refer to Resolve modes. | |
In-Editor Results | Toggle the display of query result within the code editor of query console. For more information about the in-editor results, refer to Display query results in a query console and Disable in-editor results. | |
<schema> | Switch current schema | Select the default schema or database. For PostgreSQL, Amazon Redshift, and Greenplum use the <schema> list to form the schema search path. For more information about schemas, refer to Schemas. |
<session> | Switch attached session | Select the database connection session. For more information on the database connection sessions, refer to Managing connection sessions |
Productivity tips
In the code editor context menu, use the following actions to increase your productivity:
Item | Shortcut | Description |
---|---|---|
Edit as Table | In INSERT statements, opens the editor for working with the data in a table format. | |
Change Dialect (<CurrentDialect>) | Change the SQL dialect. Select a dialect from the list. | |
Explain Plan |
| |
Execute | Ctrl+Enter | Execute the current statement or the sequence of selected statements. |
Execute to File | Execute the current statement and save results in a text file. Select the output format and specify the file location and name. | |
Run 'console [data_source]' | Ctrl+Shift+F10 | Execute all the statements in the query console. |
Services tool window controls
For the SQL statements execution, Services tool window displays information about statement or the retrieved data.
For full information about Services tool window, refer to Services tool window.
Output tab
Use the Output tab of Services tool window to view information about SQL statements and other operations that you performed in a query console. Also, the Output tab displays information about errors, timestamps, affected rows, query duration, the autocommit mode, and other operations.
Right toolbar
Item | Tooltip | Description |
---|---|---|
Soft-Wrap | Wrap long lines of text. | |
Scroll to End | Scroll the output log to the end. | |
Print a query console file, a selected text, or all the files in a directory. | ||
Clear All | Clear the Output tab. |
Context menu
Item | Description |
---|---|
Copy | Copy the selected text. |
Copy as Plain Text | Copy the selected text as plain text (without formatting). |
Copy Reference | Copy a reference link to a file or a line. |
Compare with Clipboard | Open the Clipboard vs Editor dialog where you can see the diff between the selected text and the text that you copied to a clipboard. |
Search with Google | Open a browser and run a search on Google for the selected text. |
Fold Lines Like This | Fold the lines that include the selected text. |
Pause Output | Pause the output logging. |
Clear All | Clear the output log. |
Result tab
Use the Result tab of Services tool window to see the data that was retrieved from the database in a table format. You can sort, add, edit, and remove data as well as perform other associated table tasks. For more information about working with tables, rows, columns, and cells, see Tables.
Main functions
Most of the functions in the Result tab are accessed by using controls on the toolbar, context menu commands for the data cells, and associated keyboard shortcuts. You can see what other actions with tables you can perform in Tables.
Toolbar controls
Item | Tooltip and shortcut | Description |
---|---|---|
, , , , | First Page, Previous Page Ctrl+Alt+Up, Change page size, Next Page Ctrl+Alt+Down, Last Page | Use navigation icons and corresponding commands for switching between pages that show the retrieved data and change the page size. A number of rows that you see on the Result tab are referred to as a result set page. If this number is less than the number of rows that satisfy the query, only a subset of all the rows is shown at a time. If all the rows are currently shown, navigation icons and the corresponding commands are inactive. You can see the limit between the navigation buttons. You can change it here by clicking and selecting the necessary limit or in settings.
To change the size of a result set page, click the Change page size button and select the size. Alternatively, open settings (Ctrl+Alt+S) and navigate to . In the Limit page size to field, type a new size of a result set page. Alternatively, to disable the page size restriction, clear the Limit page size to checkbox. |
Reload Page Ctrl+F5 | Reload data for the table view to synchronize the data that you see in the editor with the contents of the database. Also, use the Reload Page button when you want to apply a new page size limit setting after its change. | |
Add Row Alt+Insert | Add a row to the table. To save a new row, click Submit . The Add Row button is disabled in the inappropriate context. For example, if the current table does not permit adding rows. For more information about working with rows, see Rows. | |
Delete Row Ctrl+Y | Delete the selected row or rows. To select multiple rows, click numbers in the gutter. Also, you can press Ctrl and click the necessary rows. The Delete Row button is disabled in the inappropriate context. For example, if the current table does not permit removing rows. | |
Transaction Mode and Transaction Isolation | Select the isolation level for database transactions and the way the transactions are committed.
For more information about database transaction modes and isolation, refer to Submit changes to a database. | |
Submit Ctrl+Enter | Submit local changes to the database server. For more information about submitting and reverting changes, see Submit changes to a database. | |
Commit Ctrl+Alt+Shift+Enter | Commit the current transaction. See also, transaction modes and isolation. | |
Roll Back | Roll back changes. This button is available only for the manual transaction mode. See also, transaction modes and isolation. | |
Cancel Running Statements Ctrl+F2 | Terminate execution of the current statement or statements. | |
Compare Data | Compare the current table with a table from the list. For more information about comparing tables, see Compare table data. | |
Pin Tab | Pin the tab to the tool window to keep the query result. For more information about pinning tabs, see Pin the tab with query results. | |
Data Extractors | Select an output format for your data. Also, you can configure the following options:
| |
Export Data | Export the table data to the clipboard or save to a file. | |
Export to Database | Export the data to another table, schema, or database. In the Choose Target dialog, select the target schema (a new table is created) or table (the data is added to the selected table). In the Import Table dialog, customize mappings. | |
Show Options Menu | The Show Options Menu list includes the following options:
|
Context menu
Action | Shortcut | Description |
---|---|---|
Edit | F2 | Edit a value in the selected cell or cells. Alternatively, you can double-click the cell and start typing a value. The Edit command is unavailable for read-only values.
For more information about editing cells, see Cells. |
Open in Value Editor | Shift+Enter | Open in a separate value editor where you can edit data that is stored in the cell. For more information about the editor, refer to Value editor. |
Show Aggregate View | Open the aggregate view where you can select values of multiple cells and get a single summary value. For more information about the view, refer to Aggregate view. | |
Revert Selected | Ctrl+Alt+Z | Revert changes that you made to a cell value. You can select a scope of different cells and revert values in this scope. For more information about reverting changes, see Submit changes to a database. |
Set Highlighting Language | Select a language that the IDE should use to highlight data in a cell. | |
Change Display Type | Select how the IDE should display binary data in the column. 16-byte data is displayed as UUID by default. | |
Set DEFAULT | Ctrl+Alt+D | Set the current cell value to the default value or the value that you specified for the column. For more information about how to view or set a default value, see Manage default and NULL values for a cell. |
Set NULL | Ctrl+Alt+N | Set the current cell value to NULL. For more information about how to allow a NULL value, see Manage default and NULL values for a cell. |
Load File… | Load a file into the field. | |
Save LOB… | For the cells that contain a binary large object (LOB). Save content of a cell into a file. | |
Copy | Ctrl+C | Copy selection to the clipboard. |
Copy Aggregation Result (SUM) | Copy a summary value for a range of cells. By default, GoLand copies the | |
Paste | Ctrl+V | Paste the contents of clipboard into the table. |
Add Row | Add a row to the end of a table. | |
Delete Row | Alt+Delete | Delete selected rows. |
Clone Row | Create a duplicate of the selected row and adds the duplicate to the end of a table. | |
Quick Documentation | Ctrl+Q | Show information about selected objects. For different database objects, Quick Documentation shows corresponding information. For example, for a group of cells, you will see a summary for the selection. You can preview it in a regular or in a transposed view and also see the related records by their foreign keys. |
Go To | Navigation Bar | Jump to a navigation bar. | |
Go To | Database | Open the selected object in the Database tool window. | |
Go To | Related Symbol | Navigate to one of the related objects. | |
Go To | DDL | Open an object definition (DDL). | |
Go To | Row… | Ctrl+G | Jump to a specified row. In the Go to Row dialog, specify the column and row number (use the |
Go To | All Related Rows | F4 | Jump to a related record. The command options are a combination of those for Navigate between related data. and . Read more about related data inThe command is not available if there are no related records. |
Go To | Referenced Rows | Ctrl+B | Switch to a record that the current record references. If more than one record is referenced, select the target record in the popup that appears. Read more about related data in Navigate between related data. The command is not available if there are no referenced records. |
Go To | Referencing Rows | Alt+F7 | Use this command or shortcut to see the records that reference the current record. Read more about related data in Navigate between related data. In the popup that appears there are two categories for the target records:
The command is not available if there are no records that reference the current one. |
Filter by | Select a filter that you want to a column. | |
Full-Text Search… | Ctrl+Alt+Shift+F | Open a search window where you can search for data in your database or a group of databases. For more information about full-text search, see Full-text search in databases. |
Export Table to Clipboard | Copy the whole table to the clipboard. This action does not depend on Limit page size to setting. | |
Switch Session (your_current_session_name) | Open a window to select another session or create a new one. For more information about sessions, see Managing connection sessions. |
Value editor
Value editor is a separate editor where you can edit data that is stored in the cell. To open Value editor, in the cell context menu select Open in Value Editor.
To edit the value in Value editor, do the following:
To start a new line, press Enter.
To enter the value, press Ctrl+Enter.
To restore an initial value and quit the editing mode, press Escape.
To enable soft wrap in the editor by clicking the Toggle Soft-Wrap button .
If you store one-line JSON in a cell, you can click the Toggle Formatting icon. This action formats one-line XML and JSON strings.
Also, you can preview images in the value editor.
Note that to leverage the performance issues, the default LOB size is limited to 1024 bytes. It means that only 1024 bytes are loaded to the table editor. To increase this size and view larger images, open settings by pressing Ctrl+Alt+S, navigate to Maximum number of bytes loaded per value option.
, and change the value of theAggregate view
In the Aggregate view, you can select values of multiple cells and get a single summary value. To open Value editor, in the cell context menu select Show Aggregate View.
Click the gear icon on the toolbar of the Aggregates tab to view, enable, and disable aggregates. Also, you can create your own aggregate scripts. Bundled scripts are located in Scratches and Consoles | Extensions | Database Tools and SQL | data | aggregators. To add your own aggregator, place your script to the aggregators directory.