Data sources and drivers dialog

Create a data source or a driver.

Create a data source or a driver.

Load source code of database objects for the selected category of schemas.

A connection type that you want to use for the database connection.

• URL only This option, generally, is for editing the database connection URL directly.

  When you select this option, only the following fields are available: User, Password and URL.

  You should edit the URL right in the field. Your username and password, if necessary, are specified in the corresponding fields, or within the URL in the format appropriate for the JDBC driver that you are using.

• When using any other of the options (the options are DBMS-specific), WebStorm forms the database connection URL automatically using the info in the fields above the URL field. In all such cases, normally, you don't need to edit the URL (though you can if you want).

The path to the database file.

Use the Open icon () to select an existing database file.

The Save icon () creates a copy of a database file and changes a path to the copy location.

The path to the database file or folder.

Use the Open icon () to select an existing database file or a folder.

The hostname (domain name) or the IP address of the computer where the database is located. If the database is on your local computer, specify localhost or 127.0.0.1.

If you are using SSH, the database host must be accessible by the specified domain name or IP address from the computer on which the SSH proxy runs. See SSH/SSL tab.

Save settings for the password field. You can select the following options for storing your password:

• Never: password is prompted each time you establish a connection with a database.

• Until restart: password is saved only for the current WebStorm run. If you exit WebStorm and open it again, you must provide the password again.

• For session: password is saved only for the current connection session with a database (until you disconnect from it). You can terminate the connection by pressing the Disconnect icon () or Ctrl+F2.

• Forever: password is saved in the WebStorm storage. You do not need to provide the password next time you open WebStorm.

The URL that WebStorm will use to connect to the database. The user interface for specifying the URL is different depending on which option is selected in the Connection type list.

Set the read-only status. Select the checkbox to protect the data source from accidental data modifications.

If the checkbox is selected, you cannot modify the data in the Data editor.

Data modifications might be possible in the query console if the driver does not support the read-only status.

Set the isolation level for database transactions and the mode of how the transactions are committed.

• Auto: the current transaction is committed automatically when you submit your local changes to the database server.

• Manual: changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back.

Define a mode that WebStorm uses to switch schemas.

• Automatic: switch schemas automatically or manually. When this option is enabled, previously-configured search path / current schema are restored automatically between IDE restarts.

• Manual: switch schemas manually only.

• Disable: do not switch schemas.

Enable the single connection mode. Single connection mode means that the data source and all consoles use one and the same connection. This mode allows you to see the temporary objects in the database tree, or use the same transaction in different consoles. For more information about consoles, read Query console.

In the database tree view, show and enable only the database that you specified in the connection settings.

When you connect to a data source, WebStorm can retrieve and display you all the databases that the data source has. But in some cases (for example, with certain settings of PgBouncer), you can or are allowed to work only with a certain database. In the database tree view with the Single database mode enabled, you see only the database that you specified in the connection settings.

Consider using this setting for PostgreSQL, Azure SQL Database, Greenplum, Amazon Redshift.

Run an SQL query each time you establish a connection.

Note: if the Single connection mode checkbox is cleared, each new query console creates a new connection.

Synchronize the actual state of the database automatically. The state of the database means the database tree view that you see in the Database tool window (View | Tool Windows | Database).

If the Auto sync checkbox is selected, the view of the data source is automatically updated:

• When you click OK in the Data Sources and Drivers dialog.

• When you run DDL SQL statements in the database consoles associated with the data source.

If the Auto sync checkbox is cleared, the view of the data source in the Database tool window is synchronized with the actual state of the database only when you click the Refresh button or press Ctrl+F5).

Load source code of views, procedures, packages and other database objects for the selected category of schemas: all schemas (All schemas), all schemas excluding system schemas (All excl. system schemas), or disable the feature (None).

To change this setting for several data sources simultaneously, select the corresponding data sources. Right-click the selection and navigate to Load Sources and select an option.

Display a notification if the cached DDL differs from the actual DDL in the database.

Every time you open source code, WebStorm displays you a version that is loaded during the indexing process. But if someone changes the source code from another workstation, the indexed version becomes outdated.

If your version is older than the one in the database, you see the following notification: Cached object differs from the object in the database.

Switch to the JDBC-based introspector.

To retrieve information about database objects (DB metadata), WebStorm uses the following introspectors:

• A native introspector (might be unavailable for certain DBMS). The native introspector uses DBMS-specific tables and views as a source of metadata. It can retrieve DBMS-specific details and produce a more precise picture of database objects.

• A JDBC-based introspector (available for all the DBMS). The JDBC-based introspector uses the metadata provided by the JDBC driver. It can retrieve only standard information about database objects and their properties.

Consider using the JDBC-based intorspector when the native introspector fails or is not available.

The native introspector can fail, when your database server version is older than the minimum version supported by WebStorm.

You can try to switch to the JDBC-based introspector to fix problems with retrieving the database structure information from your database. For example, when the schemas that exist in your database or database objects below the schema level are not shown in the Database tool window.

Define a pattern to select the necessary databases and schemas. To get the info about the syntax to be used, position the caret into the field and press Ctrl+Q.

• @: the current database or schema.

• *: every database or schema. You can list schemas after *:.

Consider the following examples:

• *:*: all schemas in all databases.

• @:*: all schemas from the current database

• @:@: only the current schema

• *:dbo|@:@|db1:s1,s2,s3: the dbo schema from all databases, the current schema, schemas s1,s2,s3 from the db1 database.

Limit the set of tables and other database objects that are shown in the Database tool window for each data source. For example, if you limit the resolve scope to table:actor.*, then only the actor table will be accessible in the Database tool window (View | Tool Windows | Database).

All other tables will be out of the scope. WebStorm does not resolve objects that are not displayed in the Database tool window.

Use the following pattern when you compose an expression for the Object filter field.

<type>:[-]<pattern>, where:

<type> might be an aggregate, collation, event, fdw, ftable, mview, operator, package, role, routine, sequence, synonym, table, user, view, vtable.

<pattern> is a regular expression. To exclude an item, prepend with - (minus). For more information about regular expressions, see Class Patterns at JavaTM 2 Platform Standard Edition 5.0 API Specification.

JVM options for the database driver.

For certain Oracle Database versions (for example, Oracle version 9), there might be connection problems when you and your database server are in different time zones. You can specify the time offset for your timezone in the VM Option field (for example, -Duser.timezone=UTC+03:00). Alternatively, set the variable oracle.jdbc.timezoneAsRegion to false in the table on the Advanced tab.

Environment variables for the database driver JVM.

For example, encoding-related issues in Oracle database can be solved by setting the NLS_LANG variable (like NLS_LANG=Russian_CIS.CL8MSWIN1251). For more information, see Oracle NLS_LANG FAQ.

The working directory for the process that handles working with data sources. Also, all relative paths are resolved relatively to this directory (for example, paths in driver properties).

For example, if you create a file-based database like SQLite and do not set the path for the SQLITE file, the file will be created in this working directory.

WebStorm uses JDBC drivers to interact with a database. You can download and use a driver from the WebStorm driver repository or specify the driver that you store on your computer.

To download and use the latest driver version, click the Download ver. N link.

You can also specify and use a driver with a particular version number. Click the ver. <version_number> link and select the driver version that you want to use. The selected version is downloaded and applied automatically.

You can use the driver that is already available on your computer. In that case, click the Add button and select the driver files (with the JAR extension).

The templates used to construct the database URL. The text in curly brackets represents variables. Consider the following examples:

• {host}: the domain name or IP address of the database host.

• {port}: the database port number.

• {database}: the name of the database or schema.

Optional fragments are in square brackets, for example, [:{port}].

Template names correspond to the names of the options in the URL options list.

Set the isolation level for database transactions and the mode of how the transactions are committed.

• Auto The current transaction is committed automatically when you submit your local changes to the database server.

• Manual The changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back.

Define a mode that WebStorm uses to switch schemas.

• Automatic: switch schemas automatically or manually.

• Manual: switch schemas manually only.

• Disable: do not switch schemas.

An SQL query that will run each time you establish a connection.

Note: if the Single connection mode checkbox is cleared, each new query console creates a new connection.

Load source code of database objects for the selected category of schemas.

Environment variables for the database driver JVM.

For example, encoding-related issues in Oracle database can be solved by setting the NLS_LANG variable (like NLS_LANG=Russian_CIS.CL8MSWIN1251). For more information, see Oracle NLS_LANG FAQ.