Connect to OceanBase Cloud using Go-SQL-Driver/MySQL

This topic introduces how to connect to OceanBase Cloud using the Go-SQL-Driver/MySQL driver.

Prerequisites

• You have registered an OceanBase Cloud account, and have created a cluster instance and a MySQL-compatible tenant. For details, refer to Create a cluster instance and Create a tenant.

• You have downloaded the sample project used in this topic.

  Click to download the go-oceanbase sample project

Procedure

Step 1: (Optional) Install the Go language and driver

If you have already installed the Go language and Go-SQL-Driver/MySQL driver, you can skip this step. Otherwise, follow the steps below to install.

1. Install the Go language.

   1. Download the Go language installer package from the Go official website and install it.

      Note

      The Go package used in this topic is go1.22.2.darwin-amd64.pkg.

   2. Configure the environment variable by adding the installation path of the Go language to the system's PATH environment variable.

      • In Linux or macOS environment, you can edit the ~/.bashrc or ~/.bash_profile file and add the following content:

        export PATH=$PATH:/usr/local/go/bin
        

      • In Windows environment, you can add the value of Path to C:\usr\local\go\bin in Control Panel > System and Security > System > Advanced system settings > Environment Variables > System variables.

      Note

      Replace \usr\local\go\bin with the actual installation directory if you modified it during Go language installation.

   3. Enter the following command in the command line tool to view the Go language version information to verify that the installation was successful:

      go version
      

      Sample output:

      
      go version go1.22.2 darwin/amd64
      

2. Install the Go-SQL-Driver/MySQL driver.

   Depending on the version of the Go language, you can choose different installation methods. To install the Go-SQL-Driver/MySQL driver, you need to enter the corresponding project directory first. In this example, you need to install the driver under the go-oceanbase folder. For more details about Go-SQL-Driver/MySQL, refer to Github.

   Use the following command to install:

   cd go-oceanbase
   go get -u github.com/go-sql-driver/mysql
   

   If you cannot install it using the go get command due to version or network reasons, you can install go-sql-driver/mysql using the go install command.

   1. Clone the go-sql-driver/mysql repository from GitHub into the go/src directory.

      cd /usr/local/go/src   
      git clone https://github.com/go-sql-driver/mysql.git 
      

      Note

      Replace /usr/local/go/src with the actual Go installation directory operation.

   2. Install it using go install.

      go install mysql
      

      Note

      For some versions, the default execution directory of go install may not be /src. You can determine the actual directory by checking the error message after executing go install. For example, if the error message is cannot find package "mysql" in: /usr/local/go/src/vendor/mysql, then you should put the mysql folder under the /src/vendor directory and then execute the installation command.

   3. Check if the Go-SQL-Driver/MySQL driver has been installed. If the installation fails, please make modifications according to the error message.

      go list -m github.com/go-sql-driver/mysql
      

Step 2: Obtain an OceanBase Cloud connection string

1. Log in to the OceanBase Cloud console. On the Instances page, expand the target instance and click Create under the target tenant.

   

2. In the pop-up window, click Connect with Public IP.

3. In the Connect with Public IP window, complete the following settings to generate the connection string:

   1. Under 1. Add an IP address to the allowlist, click Add to add your exit IP address(es) used for the connection to the allowlist.
   2. (Optional) Under 2. Download the CA certificate to connect securely to the tenant, download the CA certificate and complete the verification.
   3. Under 3. Connect to your instance, click the drop-down list for Database and Account to create a database and an account for the connection. Select MySQL CLI as the connection method.

   Notice

   Please keep your password in a secure place after creating your account.

   

Step 3: Modify the database connection information in the go-oceanbase sample project

Based on the connection string obtained in Step 2: Obtain an OceanBase Cloud connection string, modify the following content in the test.go file of the sample project go-oceanbase and save it:

conn := "user_name:password@tcp(host:port)/schema_name"
// Database connection parameters

• user_name: Taken from the -u parameter in the connection string, which is the account name, for example, test.
• password: Taken from the -p parameter in the connection string, which is the account password.
• host: Taken from the -h parameter in the connection string, which is the hostname of OceanBase Cloud database, for example, t5******.aws-ap-southeast-1.oceanbase.cloud.
• port: Taken from the -P parameter in the connection string, which is the OceanBase Cloud database connection port.
• schema_name: Modify it to test, the name of the schema to be accessed is test.

Here's an example:

conn := "testaccount:111****QW@tcp(t5******.aws-ap-southeast-1.oceanbase.cloud:3306)/test"

Step 4: Run the go-oceanbase sample project

After editing the code, navigate to the go-oceanbase folder and run the sample project using the following command:

go run test.go

If the following content is returned after running, it indicates that the database connection is successful and the sample project is executed correctly:

success to connect OceanBase with go_mysql driver
Hello OceanBase

More information

For more information about Go-SQL-Driver/MySQL, you can refer to the OceanBase Database open source community, please visit Go-SQL-Driver/MySQL.