Oracle

Official documentation and software

For full information about Oracle, refer to the official documentation.
To download Oracle database software, refer to the official software downloads.
For more versions of Oracle JDBC driver, refer to the official JDBC driver downloads.

This topic presents a general procedure on how you can create a data source for the connection to your Oracle database in WebStorm, and run a test connection. It is assumed that you already have the necessary prerequisites 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.

Connect to an Oracle 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 Oracle.
- In the Database tool window ( View | Tool Windows | Database) , click the New icon () in the toolbar. Navigate to Data Source and select Oracle.
In the General tab of Data Sources and Drivers dialog right pane, specify the driver and connection type.
1. From the Driver list, select the JDBC driver for your connection.
  For Oracle, the supported drivers are Oracle and Oracle for 9.X, 10.X, 11.1. For more information about driver types, refer to Oracle JDBC FAQ.
2. From the Connection type list, select the connection type depending on the connection details that you have:
  - 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.
  - Long: to use an extended JDBC URL format with advanced parameters.
  - 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 WebStorm 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 Oracle. The default port is 1521.
  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. In the SID field, specify a unique name of Oracle instance (a process that runs on the workstation).
  For more information, refer to the DBMS-specific General tab reference.
4. From the Driver list, select the Oracle JDBC driver mode to use with your connection:
  - Thin: the driver connects to the server directly.
  - OCI and OCI8: the driver uses native libraries to connect to the server.
5. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with kinit.
  - No auth: authentication is not required.
6. 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.
7. In the URL field, WebStorm 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. The general URL to use is as follows:
  - Format: jdbc:oracle:thin:@<host_address>:<port_number>:<instance_name>
  - Example: jdbc:oracle:thin:@127.0.0.1:1521:XE
  For more information about the URL format, refer to the Oracle official documentation.
1. In the Host field, type your server address.
2. In the Port field, type the port of Oracle. The default port is 1521.
  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. In the Service field, enter the alias to an Oracle instance that you want to use.
4. From the Driver list, select the Oracle JDBC driver mode to use with your connection:
  - Thin: the driver connects to the server directly.
  - OCI and OCI8: the driver uses native libraries to connect to the server.
5. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with kinit.
  - No auth: authentication is not required.
6. 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.
7. In the URL field, WebStorm 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. The general URL to use is as follows:
  - Format: jdbc:oracle:thin:@//<host_address>:<port_number>/<instance_alias>
  - Example: jdbc:oracle:thin:@//127.0.0.1:1521/XE
  For more information about the URL format, refer to the Oracle official documentation.
1. In the TNSADMIN field, specify a path to the folder with tnsnames.ora. Alternatively, click the Open icon () and navigate to it.
  For more information, refer to the Connection settings and DBMS-specific properties.
2. In the TNS name field, specify what service name to use if you have more than one service.
  For more information, refer to the DBMS-specific General tab reference.
3. From the Driver list, select the Oracle JDBC driver mode to use with your connection:
  - Thin: the driver connects to the server directly.
  - OCI and OCI8: the driver uses native libraries to connect to the server.
4. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with kinit.
  - No auth: authentication is not required.
5. 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.
6. In the URL field, WebStorm 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. The general URL to use is as follows:
  - Format: jdbc:oracle:thin:@<service_name>
  - Example: jdbc:oracle:thin:@myServiceName
  For more information about the URL format, refer to the Oracle official documentation.
1. In the Host field, type your server address.
2. In the Port field, type the port of Oracle. The default port is 1521.
  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. In the Service field, enter the alias to an Oracle instance that you want to use.
4. From the Driver list, select the Oracle JDBC driver mode to use with your connection:
  - Thin: the driver connects to the server directly.
  - OCI and OCI8: the driver uses native libraries to connect to the server.
5. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with kinit.
  - No auth: authentication is not required.
6. 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.
7. In the URL field, paste the JDBC URL of an extended format with the parameters required for your connection.
  For more information about the URL format, refer to the Oracle official documentation.
1. From the Authentication list, select the authentication method that you want to use to authenticate the connection. The following options are available:
  - User & Password: by using your login and password.
  - Kerberos: use Kerberos for authentication. Requires a Kerberos server and authentication with kinit.
  - 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, WebStorm 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 more information about the URL format, refer to the Oracle official documentation.
  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, 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 schema is introspected and available to work with. If you also want to work with other 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 schemas under your new data source node, click the N of M button and select the ones you need. WebStorm will introspect and show them.
- For more information about working with database objects in WebStorm, 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, see Data Sources.

DBMS-specific properties

General tab

Item	Description	Connection type
Driver	List of the Oracle JDBC driver modes.	SID Service name TNS Long
SID	A unique name of an Oracle instance (a process that runs on the workstation). For the correct value, check the environment variable `ORACLE_SID` on the server host, or contact your database administrator. Commonly-used values are `XE` or `ORCL`.	SID
Service	An alias to an Oracle instance (or many instances).	Service name
TNSADMIN	Path to the folder with tnsnames.ora configuration file. For more information about tnsnames.ora, refer to Local Naming Parameters in the tnsnames.ora file.	TNS
TNS name	The service name to use with your connection if you have more than one service. To find the service name, see a value of `net_service_name` in tnsnames.ora.	TNS

Options tab

Item	Description
Enable DBMS_OUTPUT	Enable DBMS_OUTPUT for the database.

Last modified: 28 June 2024