This topic describes how to connect to and use an OceanBase database in MySQL mode by using OceanBase Connector/NET.
Prerequisites
You have an accessible OceanBase database instance.
You have obtained the database account, password, host address, and port number.
You have installed .NET SDK. The following examples are for Linux and macOS.
Notice
Before you install .NET 10.0 on Linux, make sure that the system meets the requirements for the glibc version.
Procedure
Step 1: Install the .NET runtime
On Windows, you can download the installation package from the Microsoft website. On Linux or macOS, run the following command:
Note
This topic uses .NET 10.0 as an example. In practice, you can choose another supported .NET version based on the project compatibility requirements. The installation steps are the same.
wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
chmod +x dotnet-install.sh
./dotnet-install.sh --channel 10.0
echo 'export PATH="$HOME/.dotnet:$HOME/.dotnet/tools:$PATH"' >> ~/.bashrc
source ~/.bashrc
Verify the installation result:
dotnet --version
If the output is 10.0.0 or later, the installation is successful.
Step 2: Create a console project
mkdir dotnet-test
cd dotnet-test
dotnet new console
dotnet run
If the console output is Hello, World!, the project is created successfully.
Step 3: Install OceanBase Connector/NET
After you download the driver to your local computer, run the following command in the project directory to install the driver:
dotnet add <your project.csproj> package Oceanbase.ManagedDataAccess --version 1.0.0 --source "<package repository>" --source "https://api.nuget.org/v3/index.json"
Note
If you use the official NuGet package source, keep --source "https://api.nuget.org/v3/index.json".
You can also modify the nuget.config file. For example:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="local-oceanbase" value="driver download directory" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
</packageSources>
</configuration>
After the driver is installed, you can see the following configuration in the .csproj file:
<ItemGroup>
<PackageReference Include="Oceanbase.ManagedDataAccess" Version="1.0.0" />
</ItemGroup>
Step 4: Write sample connection code
Modify the Program.cs file as follows:
using Oceanbase;
namespace Program
{
class Program
{
static void Main(string[] args)
{
OracleConnection conn = new OracleConnection("Server=xxxxx;Port=5858;Database=test;User Id=test@oracle;Password=test;");
try
{
conn.Open();
OracleCommand cmd = new OracleCommand("select to_char(sysdate, 'yyyy-MM-dd HH24:mi:ss') from dual ", conn);
var reader = cmd.ExecuteReader();
while (reader.Read())
{
Console.WriteLine("sysdate is:" + reader.GetString(0));
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
finally
{
conn.Close();
}
}
}
}
Step 5: Run the connection verification
dotnet run
If the current time is output, the connection and query are successful.
Step 6: Connect to the database
After you install the driver, you can connect to an OceanBase database in MySQL mode by using the same connection string format and parameters as those for MySqlConnector. For example:
Server=host;Port=port;Database=database_name;Uid=username@tenant_name#cluster_name;Pwd=password;
Note
When you connect to an OceanBase database by using ODP, the user identifier is usually in the three-part format: username@tenant name#cluster name (corresponding to the Uid parameter in MySQL mode). In some cloud scenarios, you can also use a one-part format. For more information, see the actual environment. Replace tenant_name and cluster_name with the actual tenant name and cluster name.
The following table describes the parameters.
| Parameter (common) | Type | Default value | Description |
|---|---|---|---|
| Server / Host / Data Source | string | "" |
The server address. Separate multiple hosts with commas. |
| Port | uint | 3306 |
The port number. |
| User ID / UserID / Username / Uid | string | "" |
The user identifier. In multi-tenant scenarios, when you connect to an OceanBase database by using ODP, the user identifier is in the three-part format: username@tenant name#cluster name. In some cloud scenarios, you can also use a one-part format. |
| Password / Pwd | string | "" |
The password. |
References
For more information about the .NET driver, see OceanBase Connector/NET overview.