CockroachDB

Enable the Database Tools and SQL plugin

This functionality relies on the Database Tools and SQL plugin, which is bundled and enabled in PhpStorm by default. If the relevant features are not available, make sure that you did not disable the plugin.

Press Ctrl+Alt+S to open settings and then select Plugins.
Open the Installed tab, find the Database Tools and SQL plugin, and select the checkbox next to the plugin name.

Official documentation and software

For full information about CockroachDB, refer to the official documentation.
To download CockroachDB database software, refer to the official software downloads.

Before you begin

This topic presents a general procedure on how you can create a data source for the connection to your CockroachDB database in PhpStorm, and run a test connection. It is assumed that you already have the necessary connection details and the database is up and running.

For example, if you want to run a database on your machine and connect to that database, the corresponding DBMS software must be installed on the machine first.

To learn about your DBMS software, refer to its official documentation.

Connect to a CockroachDB database

To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:
- In the main menu, go to File | New | Data Source and select CockroachDB.
- In the Database tool window (View | Tool Windows | Database) , click the New icon () in the toolbar. Navigate to Data Source and select CockroachDB.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
1. In the Driver list, leave the default driver option, unless another driver is required for your connection.
2. From the Connection type list, select the connection type depending on the connection details that you have:
  - default: connect by using Host, Port, Database, and URL.
  - URL only: connect by using only the URL.
  For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.
  For the URL only connection type, the JDBC URL is stored in plain text as is, and is also available in IDE log file and data source information.
  For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.
Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.
Location for the downloaded JDBC drivers is the PhpStorm configuration directory.
You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.
If there is no Download missing driver files link, then you already have the required drivers.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
1. In the Host field, type your server address.
2. In the Port field, type the port of CockroachDB. The default port is 26257.
  Real port numbers might be different on your system. Verify that you use a correct port number with your database administrator, server settings, or hosting provider.
3. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.
  - User & Password: by using your login and password.
  - No auth: authentication is not required.
4. In the User and Password fields, type your user credentials.
  To use no password, leave the Password field empty.
  To delete a once entered password, right-click the Password field and select Set Empty.
5. In the Database field, type the database name to which you want to connect.
6. In the URL field, PhpStorm generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - pgpass: by using the pgpass file. You can store this file in the user's home directory. You can read more about the password file and its location in The Password File at postgresql.org.
  - User & Password: by using your login and password.
  - No auth: authentication is not required.
2. In the User and Password fields, type your user credentials.
  To use no password, leave the Password field empty.
  To delete a once entered password, right-click the Password field and select Set Empty.
3. In the URL field, PhpStorm generates the JDBC URL automatically using the values of other connection settings.
  If you need to use a JDBC URL with certain additional settings, paste it in the URL field.
  For the URL only connection type, the URL field contents are stored in plain text, and are also available in the IDE log file.
  Use the designated fields to provide your sensitive connection details instead of putting them into the URL field.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Connection settings and DBMS-specific properties.
Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.
In case of any connection issues, refer to the Cannot connect to a database page.
(Optional) By default, only the default database and schema are introspected and available to work with. If you also want to work with other databases and schemas, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in the Database tool window (⌘ 1) .
- For more information about the Database tool window, see the corresponding reference topic.
  To see more databases and schemas under your new data source node, click the N of M button and select the ones you need. PhpStorm will introspect and show them.
- For more information about working with database objects in PhpStorm, refer to Database objects.
- To write and run queries, open the default query console by clicking the data source and pressing F4.
- To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connecting to CockroachDB Serverless

Step 1. Creating an instance and getting credentials

As soon as you create an instance of CockroachDB Serverless at cockroachlabs.cloud, you will see a connection string with credentials needed for the IDE.
You can call this dialog later again, but it does not contain your password. Be sure to copy it as you create an instance.

Step 2. Create connection in PhpStorm

To connect to the database, create a data source that will store your connection details. You can do this using one of the following ways:
- In the main menu, go to File | New | Data Source and select CockroachDB.
- In the Database tool window (View | Tool Windows | Database) , click the New icon () in the toolbar. Navigate to Data Source and select CockroachDB.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
1. In the Driver list, leave the default driver option, unless another driver is required for your connection.
2. From the Connection type list, select the connection type depending on the connection details that you have:
  - default: connect by using Host, Port, Database, and URL.
  - URL only: connect by using only the URL.
  For the URL only connection type, the JDBC URL that you enter is used and as is, including the database credentials.
  For the URL only connection type, the JDBC URL is stored in plain text as is, and is also available in IDE log file and data source information.
  For the other connection types, the JDBC URL is broken down into connection details. You can either specify them separately and use the automatically generated URL, or you can enter the URL directly in the corresponding field.
Check if there is a Download missing driver files link at the bottom of the connection settings area. Click this link to download drivers that are required to interact with a database. For a direct download link, refer to the JetBrains JDBC drivers page.
Location for the downloaded JDBC drivers is the PhpStorm configuration directory.
You can also use your drivers for the database instead of the provided ones. For more information about connecting to a database with your driver, refer to Add a user driver to an existing connection.
If there is no Download missing driver files link, then you already have the required drivers.
Specify the database connection details. Alternatively, paste the JDBC URL in the URL field.
1. In the Host field, type the name of your host. The host name goes after the at sign (@) before the port number. In our case, it is free-tier5.gcp-europe-west1.cockroachlabs.cloud.
2. From the Authentication list, select User & Password.
3. In the User field, type the name of your user (for example, user).
4. In the Password field, type your password. You receive it as you create a new instance of CockroachDB Serverless.
For the reference information about connection settings and properties on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Connection settings and DBMS-specific properties.
In the Advanced tab, do the following:
1. Click the table with parameters and start typing options.
2. Double-click the Value cell of the options parameter and type the name of your cluster. For example, wan-tapir-2723.
Ensure that the connection to the database can be established using the provided details. To do that, click the Test Connection link at the bottom of the connection details area.
In case of any connection issues, refer to the Cannot connect to a database page.
(Optional) By default, only the default database and schema are introspected and available to work with. If you also want to work with other databases and schemas, in the Schemas tab, select them for the introspection.
Click OK to create the data source.
Find your new data source in the Database tool window (⌘ 1) .
- For more information about the Database tool window, see the corresponding reference topic.
  To see more databases and schemas under your new data source node, click the N of M button and select the ones you need. PhpStorm will introspect and show them.
- For more information about working with database objects in PhpStorm, refer to Database objects.
- To write and run queries, open the default query console by clicking the data source and pressing F4.
- To view and edit data of a database object, open Data editor and viewer by double-clicking the object.

Connection settings and DBMS-specific properties

Connection settings

For the reference information about connection settings (for example, Host, Port, and so on) on the General and other tabs of Data Sources and Drivers dialog (Ctrl+Alt+Shift+S) , see Data Sources.

DBMS-specific properties

Schemas tab

Item	Description
Show internal system schemas	Show internal system schemas like pg_temp or p_toast.
Show template databases	Show template databases.

Last modified: 15 November 2024