Data sources

• Follow the instructions for the database vendor.

  • PhpStorm provides complete support for the following database vendors:

    • Amazon Redshift

    • Apache Cassandra

    • Apache Derby

    • Apache Hive

    • Azure SQL Database

    • BigQuery

    • ClickHouse

    • CockroachDB

    • Couchbase Query

    • DocumentDB

    • DynamoDB

    • Exasol

    • Greenplum

    • H2

    • HSQLDB

    • IBM Db2 LUW

    • MariaDB

    • Microsoft SQL Server

    • Microsoft SQL Server LocalDB

    • MongoDB

    • MySQL

    • Oracle

    • PostgreSQL

    • Redis

    • Snowflake

    • SQLite

    • Sybase ASE

    • Vertica

  • For the database vendors listed below, a basic support is provided:

    • AWS Athena

    • Apache Ignite

    • Apache Spark

    • DuckDB

    • Elasticsearch

    • Firebird

    • Google Cloud Spanner

    • Informix

    • InterSystems IRIS

    • Mimer SQL

    • OpenEdge

    • Phoenix

    • Presto

    • SAP HANA

    • SingleStore

    • Tarantool

    • Teradata

    • TiDB

    • Tibero

    • Trino

    • YugabyteDB

  • To create a DDL data source, follow the instructions from the DDL data sources topic.

Customize the view of objects in the Database tool window

• To group, enable, or sort data sources, click the Options icon () on the header of the Database tool window and select the necessary options.

  In the Database tool window (View | Tool Windows | Database) , the view of the data source changes instantly.

  For more information about the database tree view options, refer to View Options.

  

Group data sources in folders

• In the Database tool window (View | Tool Windows | Database) , select the necessary data source and press F6. Alternatively, right-click a data source and select Move to Folder.

  • If you do not have any folders, you will see the New Folder dialog. In the text field, type the folder name. You can use a forward slash (/) to define nesting. For example, the QA/Quick name will create the Quick folder inside the QA folder.

    

  • If you have folders with grouped data sources, you will see the Move to Folder dialog. To create a new folder, select New Folder. To remove a data source from the folder, select Root folder.

    

  Also, you can use Ctrl+C, Ctrl+V, and Ctrl+X to copy, paste, and cut your data sources between folders. If you cut and paste a data source inside one project, it will be moved. No password is required. But the password is required in all the other cases. The cut operation can be undone by using Ctrl+Z.

Assign a color to a data source

To have better differentiation between production and test databases, you can assign a color to a data source.

You can so it either by using data source's settings dialog or its context menu.

• Settings dialog

  1. In Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , select the data source for which you want to assign a color.

  2. Click the circle in the Name field to select a color.

  3. Apply the changes and close the dialog.

  

• Context menu

  1. In Database tool window, right-click the data source and navigate to Tools | Set Color.

  2. In Color, select the color that you want to assign.

  3. Apply the changes and close the dialog.

  

Assign a color to query consoles and grids

The code editor and data editor tabs can use the color of the data source.

1. To apply the data source color for query consoles and grids, right-click a data source and select Tools | Set Color.

2. In the Database Color Settings dialog, select the In console editors and grids checkbox.

3. Apply the changes and close the dialog.

For more information about the dialog and options, refer to Database Color Settings dialog

For more information about about the appearance settings in the dialog, refer to Database Color Settings dialog.

Filter objects from the toolbar

• To select the necessary objects, use the Filter icon on the toolbar .

  

Show comments for data sources and database objects

• To enable comments for databases and tables, click the Options icon () on the header of the Database tool window and select Comments.

  To add comments for tables, select a table and press Ctrl+F6. In the Comment text field, add a table description.

  To add comments for a database, open database settings Ctrl+Alt+S and add a database description in the Comment text field.

  

Use full names of data sources

By default, the Shorten Tab Titles option is enabled. A data source name in the tab title is shortened to 36 characters.

• Right-click a tab of a query console and select Shorten Tab Titles.

View the contents of a node in the Database tool window

• In the Database tool window (View | Tool Windows | Database) , click a node that groups database objects, and press F4.

  

Share data sources between projects

1. In the Database tool window (View | Tool Windows | Database) , click the Data Source Properties button ().

2. In the Data Sources and Drivers window, click the Make Global icon () to make the data source available at the global level. Click the icon again to change the level to project.

   The project level means that you can access a data source only from the project where this data source was created initially. At the global level, a data source is available for other projects. By default, a data source is available at the project level.

   

Share data sources between different IDE instances

You can copy information about a data source to the clipboard in the XML format.

The resulted XML does not include password information, unless it was provided within a JDBC URL for the URL only connection type. For more information about this connection type, refer to Data Source and Drivers dialog reference topic.

You can send the XML snippet to another IDE (in a messenger or by email) and import it.

1. In the Database tool window (View | Tool Windows | Database) , select data sources that you want to copy.

2. Press Ctrl+C. Alternatively, right-click the selection and navigate to Copy/Paste | Copy Data Source.

3. On another workstation, click View | Tool Windows | Database.

4. In the Database tool window, click the New icon (), select Import from Clipboard. Alternatively, right-click the Database tool window and select Copy/Paste | Paste Data Source (or press Ctrl+V).

You can delete a data source in one of the following ways:

• To delete the data source using its context menu, in the Database tool window (View | Tool Windows | Database) , right-click the data source that you want to delete and select Delete Data Source.

• To delete a data source in the Data Sources and Drivers dialog, follow these steps:

  1. Open data source properties. You can open data source properties by using one of the following options:

     • In the Database tool window (View | Tool Windows | Database) , click the Data Source Properties icon .

     • Press Ctrl+Alt+Shift+S.

  2. In the left pane of the dialog, select the data source that you want to delete and click the Remove icon () in the toolbar.

• To delete a data source in the Data Sources and Drivers dialog via its context menu, in the left pane of the dialog, right-click the data source that you want to delete and select Remove.

Export data source settings

1. Click File | Manage IDE Settings | Export Settings.

2. In the Export Settings window, click Select None.

3. In the Export Settings window, select Database: drivers, Database: settings, and Database: global data sources. You must have at least one global data source to have Database: global data sources in the export list. Also, ensure that you downloaded or created at least one driver. Otherwise, the Database: drivers menu item will not appear on the list.

4. In the Export settings to field, type a path to the folder where you want to store the settings.zip file.

Import data source settings

1. Click File | Manage IDE Settings | Import Settings.

2. In the Import File Location window, locate the settings.zip file that you exported, and double-click it.

3. In the Select Components to Import window, select Database: drivers, Database: settings, and Database: global sources.

4. Click OK.

5. In the Restart Needed window, click OK to restart your IDE.

6. Open the Data Sources and Drivers window, enter necessary connection credentials in the data source properties. If the data source is on a local or network drive, ensure that the path to this data source is correct.

7. To ensure that the connection to the data source is successful, click Test Connection.

Share all the connections with passwords

1. Open settings by pressing Ctrl+Alt+S and navigate to Appearance & Behavior | System Settings | Passwords. .

2. Select the In KeePass option.

3. In the Database field, specify a path for the KDBX file in the directory where you store your project.

4. Copy the whole folder with your project to another computer.

5. On another computer, open settings by pressing Ctrl+Alt+S and navigate to Appearance & Behavior | System Settings | Passwords. .

6. In the Database field, type a path to the copied KDBX file.

7. Click File | Open and navigate to the directory with copied project files.