WebStorm
 
2023.2
Shortcuts: Windows
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.
  1. Database Tools and SQL
  2. Connection to a database
  3. Data sources
  4. Oracle
  5. Connect to Oracle with OCI

Connect to Oracle with OCI

Last modified: 06 October 2023

This feature is available with the Database Tools and SQL plugin installed on the Settings | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains Marketplace.

Please note that it is a paid plugin.

Official documentation and software

WebStorm uses JDBC drivers to connect to the Oracle server through the TNS protocol.

In thin mode, the JDBC driver always connects to the TNS listener. In this mode, various versions of the JDBC driver can be used.

In OCI mode, the JDBC driver uses native libraries. In this case, the JDBC driver's version must be the same as the version of these native libraries.

Required files and settings

  • Running Oracle instance with access permissions for your user.

  • Configured tnsnames.ora file. For full information about tnsnames.ora file, refer to the official documentation.

Creating the Oracle OCI connection

Step 1. Prepare a driver for the OCI connection

  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 The Data Source Properties icon.

    • Press CtrlAltShift0S.

    Select File | Data Sources.

  2. In the Data Sources and Drivers dialog, click the Drivers tab.

  3. In the list of drivers, right-click the Oracle driver and select Duplicate.

  4. Change the name of the duplicated Oracle driver (for example, Oracle [OCI]).

  5. In the Driver Files pane, click the Add icon (the Add button) and select Native Library Path.

  6. In the file browser, navigate to the directory of the Instant Client created previously (for example, ~/Oracle/instantclient_19_8) and click Open.

    note

    Versions of the driver and the instant client must be the same. For example, if you use the Oracle driver 19.8.0.0, the instant client must be of the same version. Otherwise, you will receive an error that the native library cannot be loaded.

    Preparing drivers for the OCI connection

Step 2. Create the OCI connection

  1. 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:

    • From the main menu, navigate to File | New | Data Source and select Oracle.

    • In the Database tool window ( View | Tool Windows | Database) , click the New icon (the New icon) in the toolbar. Navigate to Data Source and select Oracle.

    Create a new data source

  2. From the Connection type list, select TNS.

    Select the Connection type

  3. From the Driver list, select OCI.

    Select the OCI driver

  4. Click the Driver link and select the driver entry that you created on Step 1.

    Click the driver link

  5. In the TNSADMIN field, click the browse button and navigate to the directory with the Instant Client (in our case, ~/Oracle/instantclient_19_8/).

  6. In the TNS name field, specify what service name to use (see a value of an alias in the tnsnames.ora file).

  7. Specify credentials for the Oracle user.

  8. 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.

    Test Connection link

    In case of any connection issues, refer to the Cannot connect to a database page.

  9. (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.

    Schemas tab of the Data Sources and Drivers dialog

  10. Click OK to create the data source.

  11. Find your new data source in the Database tool window (Alt01) .

    • For more information about the Database tool window, see the corresponding reference topic.

      tip

      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.

      Select databases and schemas to introspect and display in the Database tool window

    • 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 data of a database object, open Data editor and viewer by double-clicking the object.

Create the OCI connection

See also

Reference

Tool Windows