Working with the Database Console
Database consoles let you compose and execute SQL statements for any database defined in PyCharm as a data source. They also let you analyze and modify the retrieved data.
One database console is created for a data source automatically when a data source is created. If necessary, you can create additional consoles.
Database consoles are persistent: they are stored as SQL files.
A database console created in one of your projects can then be accessed from any other project.
The following standardized and DBMS vendor-specific SQL dialects are supported in the consoles: DB2, Derby, H2, HSQLDB, MySQL, Oracle, Oracle SQL*Plus, PostgreSQL, SQL Server, SQL92, SQLite, and Sybase .
General console usage instructions are on this page:
- Opening a database console
- Viewing and modifying the console settings
- Changing the SQL dialect
- Closing the console
More specific subjects are discussed in:
See also, Database Console.
Opening a database console
The Database tool window lets you open only default consoles, i.e. the ones that were created by PyCharm automatically.
To open the consoles that you created yourself, you should use the Scratches view of the Project tool window.
Using the Database tool window
Select the data source of interest or any node within and do one of the following:
- Click on the title bar if the toolbar is hidden.
- Click on the toolbar if the toolbar is shown.
- Select Console from the context menu.
- Press Ctrl+Shift+F10.
Using the Scratches view
For the console of interest, do one of the following:
- Double-click the console.
- Select from the main menu.
- Select Jump to Source from the context menu.
- Press F4.
Viewing and modifying the console settings
Before actually starting to use the console, you may want to take a look at the console settings and adjust them to your needs.
- To access these settings, click on the toolbar of the input pane or on the toolbar of the Database Console tool window (in the lower part of the workspace, if this tool window is currently shown).
As a result, the Database page of the Settings dialog opens. On this page, you can, for example, specify:
- How query results should be shown (the Data View and the Console sections).
- Which characters and their sequences should be treated as SQL parameters and in which places (the Custom SQL parameters section).
- How retrieved table data should be converted into CSV, TSV and other formats (the Data Extractors section).
Changing the SQL dialect
By default, the SQL dialect used in the console is defined by the DBMS associated with the data source for which the console is opened. If for some reason you want to use a different dialect:
- Right-click in the editing area of the input pane to open the context menu.
Point to Change '<current_dialect_name>' dialect to and
select the necessary dialect.
In addition to particular dialects, also the following option is available:
- <Generic>. Basic SQL92-based support is provided including completion and highlighting for SQL keywords, and table and column names. Syntax error highlighting is not available. So all the statements in the input pane are always shown as syntactically correct.
Closing the console
To close the console, do one of the following:
- Click on the toolbar of the Dababase Console tool window.
- Press Ctrl+Shift+F4.