Oracle Cloud Infrastructure Documentation

Using the Oracle Cloud Infrastructure Console

  1. Open the navigation menu and select Developer Services. Under Database Tools, select Connections.

    The Connections list page opens. All connections in the selected compartment are displayed in a table.

  2. To view the connections in a different compartment, use the Compartment filter to switch compartments.

    You must have permissions to work in a compartment to see the resources in it. If you are not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.

  3. Use filters to limit the connections in the list. Perform one of the following actions depending on the options that you see:

    • From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that are not shown in the table. The Compartment filter is always displayed next to Applied filters.

    • On the left side of the list page, select a value from one of the available filters, such as compartment, state, or tags.

    Change the order of the items in the list table by using the sort icons next to the column names.

    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

  4. In the list table, select the name of a connection to open its details page, where you can view its status and perform other tasks.

    To perform an action on a connection directly from the list table, select any of the following options from the Actions menu in the row for that connection:

    • View details: Open the details page for the connection.
    • SQL Worksheet: Open the SQL Worksheet page.
    • Validate: Validate the connection.
    • Copy OCID: Copy the OCID of the connection to the clipboard.
    • Move resource: Move the connection to a different compartment.
    • Manage tags: Add one or more tags, or change the value of an existing tag. See Resource Tags.
    • Delete: Delete the connection.

    To create a connection, select Create connection.

Using the 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 for Oracle Cloud Databases
  • Validate the connection
  • Move the connection to another compartment
  • Add resource tags to the connection
  • Delete the connection
  1. On the Connections list page, find the connection that you want to work with. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the name of the connection. The Connection Details page for the connection is displayed.
  3. You can also view and edit the connection properties, work requests and tags for this specific Database Connection.
  4. Select SQL Worksheet to open an SQL Worksheet. See Using SQL Worksheet for instructions.
  5. From the Actions menu, you can do the following:

    • Select >_Launch SQLcl to open an SQL Cloud Shell session. The session then uses SQLcl and the database connection to directly log into the database.This option is only available for Oracle Cloud Databases.

      Note

      By default, Cloud Shell limits network access to OCI internal resources in your tenancy home region unless you have enabled the Cloud Shell managed Public Network. Your administrator must configure an Identity policy to enable Cloud Shell Public Network. For more information, see Cloud Shell Networking.

      1. When using a database with a private endpoint, you can connect over a Bastion Service. In the Launch SQLcl panel, select the Bastion menu to choose an existing Bastion. Optionally, select 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, select Create Bastion to create one. Enter the bastion name and compartment you want to create it in, then select Create.

        Once a bastion is selected, select 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.

    • Select Edit to update the connection name, database user name and password, password secret, connection string, wallet format, and wallet secret.
    • Select 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.
    • Select Move Resource to move the connection to a different compartment. In the Move Resource dialog, use the Destination compartment menu to select another compartment, then select Move Resource to move the connection to the selected compartment.
    • Select Add tags to add one or more tags to the private endpoint. See Resource Tags for 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.
    • Select Delete to delete the connection. In the Delete Connection confirmation dialog box, select Delete to remove the connection.
  1. On the Connections list page, find the connection that you want to work with. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the name of the connection. The Connection Details page for the connection is displayed.
  3. Expand the Actions menu and select Edit. The Edit Connection dialog with the current connection settings is displayed.
  4. 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.
  5. Select Update.

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.

Note that you can also add connection properties while Using the Oracle Cloud Infrastructure Console, in the Advanced Options section of the Create Connection dialog.

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

Table 3-1 Connection Properties for Oracle Database Connections

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

Specifies the timeout when negotiating a session with the database listener
oracle.jdbc.ReadTimeout Specifies the timeout while reading from the socket
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
internal_logon Specifies the administrative user for authentication, such as SYSDBA
oracle.jdbc.proxyClientName Specifies the user name for proxy authentication

Table 3-2 Connection Properties for MySQL Database Connections

Name Function
sslMode

Used to create an encrypted connection to a MySQL Database. The three option values are:

  • REQUIRED: Establish an encrypted connection if the server supports encrypted connections. The connection attempt fails if an encrypted connection cannot be established.
  • VERIFY_CA: Like REQUIRED, but additionally verify the server Certificate Authority (CA) certificate against the configured CA certificates. The connection attempt fails if no valid matching CA certificates are found.
  • VERIFY_IDENTITY: Like VERIFY_CA, but additionally perform host name identity verification by checking the host name the client uses for connecting to the server against the identity in the certificate that the server sends to the client.

To add connection properties

  1. On the Connections list page, find the connection that you want to work with. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the name of the connection. The Connection Details page for the connection is displayed.
  3. Select the Connection properties tab. Select Add to add one or more properties to the connection.
  4. 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.
  5. Select + Another Connection Property to enter additional connection properties.
  6. Select Add Connection Properties to add the new properties to the connection.

To remove connection properties

  1. On the Connections list page, find the connection that you want to work with. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the name of the connection. The Connection Details page for the connection is displayed.
  3. In the list of Connection Properties on the Connection Details page, select the checkbox at the beginning of the row for each connection property you want to remove.
  4. Select Remove, then confirm that you want to remove the selected connection properties.

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. On the Connections list page, find the connection that you want to work with. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the name of the connection. The Connection Details page for the connection is displayed.
  3. Select the Work requests tab.
  4. In the list of work requests, select the name of the Operation to display the Work Request Details page.
  5. On the Work Request Details page, under Resources:
    • Select Log Messages to display any logs for the work requests.
    • Select Error Messages to display any error messages for the work requests.
    • Select Associated Resources to show the name of the connection associated with the work request.

To delete a database connection:

  1. On the Connections list page, find the connection that you want to delete. If you need help finding the list page or the connection, see To list Database Connections.
  2. Select the Actions icon (three dots) at the end of the row listing the connection.
  3. Select Delete to delete the connection.