ApsaraDB for OceanBase:Connect to OceanBase Database by using the Go client

Prerequisites

• You have downloaded the Go client of the latest version from the GitHub Go client repository.

• You have imported the obkv-table-client-go dependency. You can run the following command in the local Go client repository to obtain the obkv-table-client-go dependency of the latest or specified version:

  go get github.com/oceanbase/obkv-table-client-go

Connection methods

ApsaraDB for OceanBase allows you to connect to a database in proxy mode. Specifically, you can call a function or use a TOML file to connect to the database.

Method 1: Call a function

Call the following function in your Go code and modify parameters based on description in the following tables:

func NewOdpClient(
	fullUserName string,
	passWord string,
	odpIP string,
	odpRpcPort int,
	database string,
	cliConfig *config.ClientConfig) (Client, error)

• Parameters

  Parameter	Description
  fullUserName	The full username in the format of <account name>@<tenant name>#<cluster name>.
  passWord	The password of the account in fullUserName.
  odpIP	The domain name of the OceanBase database to be connected.
  odpRpcPort	The service port for the wide table engine (or Key-Value mode) of OceanBase Database. Default value: 3307.
  database	The name of the database.
  cliConfig	The client configuration. For more information, see ClientConfig.

• Return values

  Return value	Description
  Client	The client APIs, including insert, get, and update. For more information, see Examples of connecting to and using OceanBase Database in the Go client.
  error	The error message.

Method 2: Use a TOML file

1. Customize your TOML configuration file based on the template file configurations/obkv-table-default.toml. Set the mode to proxy, modify OdpClientConfig, and configure other parameters based on the actual business needs. For more information, see ClientConfig.

2. Call the following function in your Go code and enter the address or location of your TOML file:

   func NewClientWithTomlConfig(configFilePath string) (Client, error)

   • Parameters

     Parameter	Description
     configFilePath	The path of the TOML file, which is configurations/obkv-table-default.toml by default.

   • Return values

     Return value	Description
     Client	The client APIs, including insert, get, and update. For more information, see Examples of connecting to and using OceanBase Database in the Go client.
     error	The error message.

ClientConfig

Here is the sample code:

type ClientConfig struct {
        ConnPoolMaxConnSize int
        ConnConnectTimeOut  time.Duration
        ConnLoginTimeout    time.Duration
        OperationTimeOut    time.Duration
        LogLevel            log.Level

        TableEntryRefreshLockTimeout     time.Duration
        TableEntryRefreshTryTimes        int
        TableEntryRefreshIntervalBase    time.Duration
        TableEntryRefreshIntervalCeiling time.Duration

        MetadataRefreshInterval    time.Duration
        MetadataRefreshLockTimeout time.Duration

        RsListLocalFileLocation    string
        RsListHttpGetTimeout       time.Duration
        RsListHttpGetRetryTimes    int
        RsListHttpGetRetryInterval time.Duration

        EnableRerouting bool
}

The following table describes the key parameters.