WebStorm 2024.3 Help

Create an Oracle data source using Wallet and OCI

WebStorm uses JDBC drivers to connect to the Oracle server through the TNS protocol. The following driver modes are available:

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

Oracle Wallet is a set of files that stores all the user credentials such as certificates, certificate requests, and private keys. You can create a wallet by using the Oracle tooling or ask your Oracle server administrator to generate the wallet. For more information about wallets, refer to Creating and Managing Oracle Wallet.

Requirements

  • Running Oracle Cloud instance with access permissions for your user.

  • Oracle Wallet.

Creating the Oracle Cloud data source

As an example of directories, for this tutorial we will use the following ones:

  • Downloaded packages are extracted at ~/Oracle/instantclient_19_8/.

  • oraclepki.jar is stored at ~/Oracle/instantclient_19_8/.

  • Wallet files are stored at ~/Oracle/instantclient_19_8/network/wallet and include the configured tnsnames.ora and sqlnet.ora ones.

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.

  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 [Cloud, 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 files (in this tutorial, ~/Oracle/instantclient_19_8) and click Open.

  7. You can use the WebStorm provided driver or the ones provided with Instant Client.

    Change the file version so that it is the same with the Instant Client version.

    Driver file versions list for the IDE provided driver

    1. In the Driver Files pane, click the Add icon (the Add button) and select Custom JARs.

    2. In the file browser, navigate to the directory with the Instant Client files (in this tutorial, ~/Oracle/instantclient_19_8).

    3. In the directory, select the following files: ojdbc8.jar, orai18n.jar, and oraclepki.jar.

    4. Click Open.

    Driver files provided with the Instant CLient

Step 2. Create the Oracle Cloud data source

  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:

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

  3. From the Driver list, select OCI.

  4. Click the Driver link and select the driver entry that you created on Step 1 (in our case, Oracle [Cloud, OCI]).

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

  6. In the TNS name field, use the automatic completion (Ctrl+Space) to select which service name to use (see a value of an alias in the tnsnames.ora wallet 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 (⌘ 1) .

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

    • 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 Oracle Cloud data source
Last modified: 04 November 2024
Create an Oracle data source using OCIPostgreSQL