Database Tool Window
On this page:
- Overview of the tool window
- Toolbar icons, context menu commands and shortcuts
- View options
- Icons for data sources and their elements
See also, Working with the Database tool window.
Overview of the tool window
The Database tool window provides access to functions for working with databases and DDL data sources. It lets you view and modify data structures in your databases, and perform other associated tasks.
The available data sources are shown as a tree of data sources, schemas, tables and columns. If no data sources are currently defined, use the New command (Alt+Insert) to create a data source.
Most of the functions in this window are accessed by means of the toolbar icons or context menu commands. (If the toolbar is not currently shown, click on the title bar and select Show Toolbar.) Many of the commands have keyboard shortcuts. If the toolbar is hidden, the Synchronize and Open Console commands can be access by means of the title bar icons ( and respectively).
on the title bar provides access to view options.
Toolbar icons, context menu commands and shortcuts
|Collapse all the nodes.||All node types|
|New||Alt+Insert||Create a new data source, database, schema, database console, table, column, index, or a primary or foreign key.
The list of options depends on which element is currently selected.
See also, Creating a data source, Creating a database or schema, Creating and opening a new database console, Creating a table, a column, an index, or a primary or foreign key and Data Sources and Drivers Dialog.
|DB data sources and their elements. If a DDL data source is selected, you can only choose to create another data source.|
|Duplicate||Ctrl+D||Create a copy of the selected data source. Specify the properties of the data source in the Data Sources and Drivers dialog that opens.||DB and DDL data source nodes|
|Synchronize||Ctrl+Alt+Y||Update the view of the selected element
(i.e. synchronize the view of the element with its actual state in the database).
See also, Auto sync.
|DB data sources and their elements|
|Properties||Open the Data Sources and Drivers dialog to manage your data sources and their settings.||All node types|
|Disconnect||Ctrl+F2||Close the database connection for the selected DB data source or data sources. (The names of the data sources with active database connections are shown in bold.)||DB data sources with active connections and their elements|
|Table Editor||F4||Open the selected database table in the Table Editor.
See also, Working with the Table Editor.
|Tables and table columns in DB data sources|
|F4||Open the definition of the selected view, function, procedure or package in the editor.||Corresponding elements in DB data sources|
|Edit Source||F4||Open the associated DDL file in the editor.||Tables and table columns in DDL data sources|
|Open Console||Ctrl+Shift+F10||Open the default database console for the corresponding DB data source.||DB data sources and their elements (tables and table columns)|
Rename the selected data source, table or column.
Specify the new name in the dialog that opens.
See also, Renaming items.
|All node types|
Modify Foreign Key
|Ctrl+F6||Edit the definition of the selected table, column, index, or primary or foreign key.||Corresponding elements in DB data sources|
|Copy Reference||Ctrl+Shift+Alt+C||Copy the fully qualified name of the selected data source, table or column to the clipboard.||All node types|
|Find Usages||Alt+F7||Find the usages of (references to) the selected item (data source, table or column) in your source files and libraries.||All node types|
|Database Tools | Hide Schemas||Hide the selected schemas. See Showing and hiding schemas.||Schemas in DB data sources|
|Database Tools | Manage Shown Schemas||Open the Schemas popup for the current DB data source. See Showing and hiding schemas.||DB data sources and their elements|
|Database Tools | Forget Cached Schema||
Use this command in problematic cases such as
when your data structures start to display incorrectly, fail to synchronize, etc.
As a result, PhpStorm deletes the information it has accumulated about your database.
To check if this has eliminated the problem, use the Synchronize command.
|DB data sources|
|Database Tools | Copy Settings||Copy the settings for the selected data source onto the clipboard.||DB data sources|
|Database Tools | Drop Primary Key||Remove the primary key constraint for the current table.||Tables and columns in DB data sources|
|Database Tools | Drop Foreign Key||Remove the foreign key constraint.||Columns with the foreign key constraint in DB data sources|
|Database Tools | Truncate||Remove all the rows in the selected table.||Tables in DB data sources|
|Drop or Remove||Delete||Remove the selected item.||All node types|
|Open New Console||Create and open a new database console for the corresponding DB data source.||DB data sources and their elements|
|Generate and Copy DDL||Ctrl+Shift+C||Generate DDL definitions for the selected data source, schema, table, view, stored procedure or function, and copy those definitions onto the clipboard.||All node types except columns|
|Open DDL in Console||Shift+F4||Open a DDL definition of the selected table or view in a database console.||Tables and views in DB data sources|
|Compare||Ctrl+D||Select two data sources, schemas or tables and then use this command to compare table structures for the selected items. The comparison results are shown in the differences viewer.||DB and DDL data sources and tables|
|Dump Data to File(s)||Save data for the selected tables and views in files. Select the output format (e.g. SQL Inserts, Tab-separated (TSV), JSON-Clojure.json.clj).||DB data sources, and schemas, tables and views within them|
|Dump Data with "mysqldump" or Dump with "pg_dump"||Run mysqldump or pg_dump for the selected items. See Creating database backups with mysqldump or pg_dump.||MySQL and PostgreSQL data sources, and schemas, tables and views within them|
|Import Data from File||
Import a text file containing delimiter-separated values (CSV, TSV, etc.)
into your database.
If a schema is currently selected, PhpStorm will create a new table for the data that you are importing. If a table is selected, PhpStorm will try to add the data to the selected table.
|Schemas, tables and columns in DB data sources. For columns, the result will be the same as for schemas|
|Color Settings||Set or change the color for the selected element or elements. (The Database Color Settings dialog will open.)||All node types|
|Scripted Extensions / Generate POJOs.clj||
Generate a Java entity class for the selected table.
In the dialog that opens,
specify the directory in which the ||Tables|
|Scripted Extensions / Go to Scripts Directory||Switch to the directory
where the ||All node types|
|View a UML class diagram for the selected data source or table. Select:||DB and DDL data sources and tables|
|View | Quick Documentation (in the main menu)||Ctrl+Q||
View basic information about the selected element.
For example, the info about a table includes
the names of the data source, database, schema and the table itself,
the table definition (|
To close the documentation pop-up, press Escape.
|All node types|
The view options, generally, define what is shown in the tool window and how. To view or change these options, click on the title bar.
This option defines how schema elements are shown.
When on, there are separate nodes for tables, views and stored routines (shown as folders). Tables, views and routines (procedures and functions) are shown as elements of the corresponding groups.
When off, there is no explicit grouping for tables, views, and routines. Tables and views are followed by procedures and functions.
This option defines how table elements are shown.
When on, there are separate nodes for columns, indexes, primary and foreign key constraints, and triggers (shown as folders). The elements appear in the corresponding groups.
When off, there is no such grouping and, generally, only columns are shown for tables.
|Show Keys and etc.||
When this option is on, the primary and foreign key constraints, and indexes are
shown as separate elements.
Otherwise, there are no separate elements for the keys and indexes.
The option is unavailable when the Group Contents option is on.
|Show Empty Groups||If the Group Schema or the Group Contents option is on, you can select to show or hide empty groups, i.e. the categories that contain no elements.|
When this option is off, columns, generally, are unsorted.
When this option is on, the columns are ordered alphabetically.
|Show Toolbar||Select or deselect this option to show or hide the toolbar.|
The rest of the options are common for all the tool windows, see Viewing Modes.