Oracle Cloud Infrastructure Documentation

Connecting to Oracle HeatWave

The database system endpoint is where clients such as MySQL Shell, MySQL Client, MySQL Workbench, and your applications can connect to Oracle HeatWave.

The virtual network for a Oracle HeatWave deployment includes an Azure VNet, an Oracle Cloud Infrastructure (OCI) VCN, and the connections between the two. OracleDB for Azure automatically opens the default ports for access to the database system, so you do not need to set up ingress rules for the VCN. These ports are open:

  • 22: The SSH port
  • 3306: The default port for MySQL protocol connections to a database system (as used by the MySQL Client, and as a backup by MySQL Shell)
  • 33060: The default port for X Protocol connections to a database system (as used by MySQL Shell)

To view the networking and connection information for the database system's endpoint, on the deployment's details page, select the Connect and Networking tabs on the left menu bar.

  • On the Connect tab, Internal FQDN gives the fully qualified domain name for the database system's endpoint, and Database system IP address gives the private IP address that was assigned to the database system’s endpoint. The MySQL protocol and X Protocol ports are also shown.
  • On the Networking tab, information about the Azure VNet and OCI VCN parts of the virtual network is shown.

Because the database system endpoint has a private IP address, you cannot connect directly to it from a remote IP address. Instead, you need to connect to the endpoint by one of these methods:

  • Connect to the database system endpoint from an Azure VM that is on the same Azure VNet as the database system. With this method, you install the client software (such as MySQL Shell) on the Azure VM, and use SSH or RDP to connect from your local machine to the Azure VM in order to use the client.
    For instructions to create an Azure VM on the same Azure VNet, see Virtual machines in Azure.
  • Connect from an Oracle Cloud Infrastructure compute instance that is on the same OCI VCN as the database system. With this method, you install the client software on the compute instance, and use SSH or RDP to connect from your local machine to the compute instance in order to use the client.
    For instructions to create an OCI compute instance on the same OCI VCN, see Compute.
  • Use a secured access service, such as a VPN connection or Oracle Cloud Infrastructure’s Bastion service, to bridge from your local network to the OCI VCN with access to the database system. With this method, you install the client software on your local machine, and connect directly to the database system endpoint.
    For instructions to connect in this way, see Overview of Connecting to a DB System.

To install MySQL Shell on an Azure VM, OCI compute instance, or your local machine, see the following:

Always use the latest version of OCI Shell available to you so that you have access to all of the features.

To connect to the databas system endpoint using OCI Shell, on the command line, enter a command like this, specifying the private IP address <EndpointIPAddress> or the instance's fully qualified domain name <InstanceFQDN>: 


mysqlsh --mysqlx -u <UserName> -h <EndpointIPAddress>
or
mysqlsh --mysqlx -u <UserName> -h <InstanceFQDN>

<UserName> is the username for the database system administrator account that you set up while provisioning Oracle HeatWave. Enter the password that you chose for the administrator account when prompted. This command starts MySQL Shell (mysqlsh) and sets up an X Protocol connection to the database system endpoint, using port 33060.

To install MySQL Client on an Azure VM, OCI compute instance, or your local machine:

For more details, see Installing and Upgrading MySQL.

To connect to the DB System endpoint using MySQL Client, on the command line, enter a command like this, specifying the private IP address <EndpointIPAddress> or the instance's fully qualified domain name <InstanceFQDN>: 


mysql --host <EndpointIPAddress> -u <UserName> -p
or
mysql -h <InstanceFQDN> -u <UserName> -p

<UserName> is the username for the database system administrator account that you set up while provisioning Oracle HeatWave. Enter the password that you chose for the administrator account when prompted. This command starts MySQL Client (mysql) and sets up a classic MySQL protocol connection to the database system endpoint, using port 3306.

You can use MySQL Shell's dump and dump loading utilities to import data to Oracle HeatWave. For instructions to do that, see Importing Data to Oracle HeatWave.