Managing a Connection

This section explains how to perform various management tasks for database connections. Tasks include:

  • Listing and viewing the details of a database connection
  • Updating the details of a database connection
  • Deleting a database connection
  • Adding connection properties to a database connection
  • Using work requests created for a database connection

Using the Oracle Cloud Infrastructure Console

To list Database Connections
  1. Open the navigation menu and click Developer Services.
  2. Under Database Tools, click Connections. The Connections window displays a list of existing connections.
  3. In the List Scope section, select the Compartment containing the database for which you want to view a connection.
  4. To display only database connections in a specific state, use the State menu in the Filters section. The choices are:

    • Any state (default)
    • Creating
    • Active
    • Updating
    • Failed
    • Deleting
    • Deleted
  5. In the Tag filters section, use the add and clear controls to filter your list of connections by defined or free-form tags. See Resource Tags for an information about using tags to manage your OCI resources, and To filter a list of resources by a tag for instructions on filtering resources by tags.

  6. Optionally, you can use the Actions menu (three dots) at the end of each row to perform the following tasks:
    • View Details
    • SQL Worksheet
    • Validate
    • Move Resource
    • Copy OCID
    • Add Tags
    • View Tags
    • Delete
To view Database Connection details

Using the Database Connections Details page, you can make updates to an existing connection. You can also do the following:

  • Use this connection in a SQL Worksheet
  • Use SQLcl in an Oracle Cloud Infrastructure Cloud Shell session
  • Validate the connection
  • Move the connection to another compartment
  • Add resource tags to the connection
  • Delete the connection
  1. In the Console, open the navigation menu and click Developer Services.
  2. Under Database Tools, click Connections. The Connections window displays a list of existing connections.
  3. In the List Scope section, click the Compartment drop-down menu to select the compartment containing the database for which you want to view a connection. Alternately, click on the field displaying the name of the currently selected compartment. The field text changes to Search compartments, and you can type the name of your desired compartment into the field.
  4. To display only database connections in a specific state, use the State menu in the Filters section. The choices are:

    • Any state (default)
    • Creating
    • Active
    • Updating
    • Failed
    • Deleting
    • Deleted
  5. In the Tag filters section, use the add and clear controls to filter your list of connections by defined or free-form tags. See Resource Tags for an information about using tags to manage your OCI resources, and To filter a list of resources by a tag for instructions on filtering resources by tags.

  6. To view the details of a Database Tools connection, click the name of the listed connection. The Connection Details page for the connection is displayed.
  7. Click SQL Worksheet to open an SQL Worksheet. See Using the SQL Worksheet for instructions.
  8. Click >_Launch SQLcl to open an SQL cloud shell session. The session then uses SQLcl and the database connection to directly log into the database.

    1. When using a database with a private endpoint, you can connect over a Bastion Service. In the Launch SQLcl panel, click the Bastion menu to choose an existing Bastion. Optionally, click Change Compartment link to find a bastion in a different compartment. See the Bastion Serivce documentation for information about using bastions.
    2. If no bastions are available, click Create Bastion to create one. Enter the bastion name and compartment you want to create it in, then click Create.

      Once a bastion is selected, click Launch at the bottom of the Launch SQLcl panel. SQLcl creates a tunnel to access the database service and opens the OCI Cloud Shell interface in the browser.

  9. Click Edit to update the connection name, database user name and password, password secret, connection string, wallet format, and wallet secret.
  10. Click Validate to validate the connection. Validating a connection uses the connection details to attempt to log into the database and run a simple SQL query. After the validation is attempted, the Validate Connection message box is displayed, showing the results of the validation.
  11. Click More Actions and select an item from the menu to move the connection to another compartment, add tags, or delete the connection.
    • Click Move Resource to move the connection to a different compartment. In the Move Resource to a Different Compartment dialog, use the Choose New Compartment menu to select another compartment, then click Move Resource to move the connection to the selected compartment.
    • Click Add tags to add one or more tags to the private endpoint. See Resource Tags for an information about using tags to manage your OCI resources, and To add defined tags to one existing resource and To add a free-form tag to an existing resource for instructions on tagging OCI resources.
    • Click Delete to delete the connection. In the Delete Connection confirmation dialog box, click Delete to remove the connection.
  12. You can also view and edit the connection properties and work requests for this specific Database Connection.
To update Database Connection details
  1. Navigate to the Connection Details page. See To view Database Connection details for instructions.
  2. Click Edit. The Edit Connection dialog with the current connection settings is displayed.
  3. Change the following, as needed:
    • Enter a new name for the database connection.
    • Enter a new database user name.
    • Select a different user password secret.
    • Create a password secret.
    • Select a different compartment for the password secret.
    • Enter a different connection string.
    • Select a new key store (wallet) format.
  4. Click Save Changes.
To add or remove Connection Properties

The Connection Details page includes a Connection Properties section that shows any additional properties of the connection. This section displays by default when you navigate to the details page, or whenever you click Connection Properties in the Resources section.

Note that you can also add connection properties while creating a new Database Tools connection, in the Advanced Options section of the Create Connection dialog..

The following table includes the valid connection properties available in Database Tools.

Connection Properties
Name Function
oracle.jdbc.loginTimeout Specifies the timeout for opening a JDBC connection 0
oracle.net.CONNECT_TIMEOUT Specifies the timeout when connecting a socket to the database listener 0
oracle.net.OUTBOUND_CONNECT_TIMEOUT

Specifies the timeout when negotiating a session with the database listener 0

oracle.jdbc.ReadTimeout Specifies the timeout while reading from the socket null
oracle.net.ssl_server_dn_match Disables authentication of the Distinguished Name (DN) given by the database server's certificate
oracle.net.ssl_server_cert_dn Specifies the Distinguished Name (DN) used to authenticate the database server's certificate

To add connection properties

  1. Navigate to the Connection details page. See To view Database Connection details for instructions.
  2. Click Add Connection Properties to add one or more properties to the connection.
  3. In the Add Connection Properties window, enter a valid property name and a value for the connection. See the list of valid properties in this topic.
  4. Click + Another Connection Property to enter additional connection properties.
  5. Click Add Connection Properties to add the new properties to the connection.

To remove connection properties

  1. Navigate to the Connection details page. See To view Database Connection details for instructions.
  2. In the list of Connection Properties on the Connection Details page, click the checkbox at the beginning of the row for each connection property you want to remove.
  3. Click Remove, then confirm that you want to remove the selected connection properties.
To view Database Connection work requests

The Connection Details page includes a section that shows any work requests generated for the connection in the last 72 hours. See Work Requests for more information on using work requests in Oracle Cloud Infrastructure.

  1. Click Work Requests under Resources on the Connection Details page. See To view Database Connection details for instructions on navigating to a Connection Details page.
  2. In the list of work requests, click the name of the Operation to display the Work Request Details page.
  3. On the Work Request Details page, under Resources:
    • Click Log Messages to display any logs for the work requests.
    • Click Error Messages to display any error messages for the work requests.
    • Click Associated Resources to show the name of the connection associated with the work request.
To delete a Database Connection

You can delete a database connection in the two following locations.

  1. On the Database Connections list view page:
    1. Navigate to the Database Connections list view. See To list database connections for instructions.
    2. In the list of connections, find the connection you want to delete.
    3. Click the Actions icon (three dots) at the end of the row listing the connection.
    4. Click Delete to delete the connection.
  2. On the Database Connection Details page:
    1. Navigate to the Connection Details page. See To view Database Connection details for instructions.
    2. Click More Actions.
    3. Click Delete to delete the connection.

Using the APIs

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use the following APIs for Database Tools connections and work requests:

Database Tools connections

Database Tools work requests

Note

See Database Tools API Reference for a complete list of the Database Tools APIs.