Connecting to a database
To issue a query to a database, you must connect to a data source. The data source is a location of your data (it can be a server, CSV, or a DDL file). The data source connection includes a name and connection settings that are dependent on the data source type.
Amazon Redshift
In your Redshift dashboard, create a Redshift cluster.
In settings of the Redshift cluster, copy the JDBC URL.
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Amazon Redshift.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
From the Connection type list, select URL only.
Paste the JDBC URL from the Redshift cluster settings to the URL field in PhpStorm.
In User and Password fields, specify your Redshift credentials.
To ensure that the connection to the data source is successful, click Test Connection.
Apache Derby
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Apache Derby.
From the Driver list, select the type of the JDBC driver that you want to use. For remote connections, select Apache Derby (Remote). For embedded databases, select Apache Derby (Embedded).
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Apache Cassandra
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Apache Cassandra.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Apache Hive
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Apache Hive.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Azure SQL Database
In your Microsoft Azure account, create an SQL data source.
In PhpStorm, navigate to
Ctrl+Shift+Alt+S.In the Data Sources and Drivers dialog, click the Add icon () and select Azure SQL Database.
At the bottom of the data source settings area, click the Download missing driver files link.
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To use Azure Active Directory Authentication, select Use Windows domain authentication. To use SQL Authentication, clear the checkbox, and specify your Microsoft Azure credentials in User and Password fields.
To ensure that the connection to the data source is successful, click Test Connection.
ClickHouse
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select ClickHouse.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
DDL data source
SQL files that contain data definition language statements (DDL statements) can be used as data sources. As a result, you can reference all tables, columns and other objects defined in such files in the editor.
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select DDL Data Source.
In the DDL Files pane, click the Add button .
In the file browser, navigate to the SQL file or files with DDL statements and click Open.
Click Apply.
In the SQL Dialects dialog, select a dialect that you want to use for the added SQL file.
Apply settings and click OK.
Exasol
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Exasol.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Greenplum
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Greenplum.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
H2
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select H2.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
HSQLDB
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select HSQLDB.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
IBM Db2
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select IBM Db2.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
MariaDB
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select MariaDB.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Microsoft SQL Server
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Microsoft SQL Server.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
The Instance field is optional.
To ensure that the connection to the data source is successful, click Test Connection.
MySQL
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select MySQL.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Oracle
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Oracle.
At the bottom of the data source settings area, click the Download missing driver files link.
From the Connection Type list, select a connection type:
SID: to use a unique name of an Oracle instance (a process that runs on the workstation).
Service name: to use an alias to an Oracle instance (or many instances).
TNS: to use tnsnames.ora configuration file. In TNSADMIN field, specify a path to the tnsnames.ora file. In TNS name, specify what service name to use (see a value of
net_service_name
in tnsnames.ora) if you have more than one service.URL only: to use the JDBC URL.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
From the Driver list, specify the driver type. For more information about driver types, see Oracle JDBC FAQ.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
To ensure that the connection to the data source is successful, click Test Connection.
PostgreSQL
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select PostgreSQL.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Snowflake
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Snowflake.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
SQLite
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select SQLite.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
To connect to an existing SQLite database, specify a file path to the database file in the File field.
To ensure that the connection to the data source is successful, click Test Connection.
Sybase ASE
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Sybase ASE.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.
Vertica
In the Database tool window ( ), click the Data Source Properties icon .
In the Data Sources and Drivers dialog, click the Add icon () and select Vertica.
At the bottom of the data source settings area, click the Download missing driver files link. Alternatively, you can specify user drivers for the data source. For more information about user drivers, see Add a user driver to an existing connection.
-
Specify database connection details. Alternatively, paste the JDBC URL in the URL field.
To set an empty password, right-click the Password field and select Set empty.
To ensure that the connection to the data source is successful, click Test Connection.