Add C# / .NET example (#20571) (#20670)

Author: ti-chi-bot

TOC.md

@@ -47,6 +47,8 @@
     - Ruby
       - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md)
       - [Rails](/develop/dev-guide-sample-application-ruby-rails.md)
+    - C#
+      - [C#](/develop/dev-guide-sample-application-cs.md)
   - 连接到 TiDB
     - GUI 数据库工具
       - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md)

develop/dev-guide-sample-application-cs.md

@@ -0,0 +1,123 @@
+---
+title: 使用 C# 连接 TiDB
+summary: 了解如何使用 C# 连接 TiDB。本教程提供了与 TiDB 交互的 C# 代码示例。
+---
+
+# 使用 C\# 连接 TiDB
+
+C#（发音为 "C-Sharp"）是 .NET 技术体系中的一种编程语言，由微软开发。其他 .NET 语言还包括 VB.NET 和 F#。在本文档中，你将使用 C# 和 MySQL Connector/NET，通过 MySQL 协议将 C# 应用程序连接到 TiDB。这种连接方式可行，是因为 TiDB [与 MySQL 高度兼容](/mysql-compatibility.md)。
+
+虽然 .NET 通常用于 Windows 操作系统，但它同样适用于 macOS 和 Linux 系统。在不同平台上，相关命令和代码基本一致，仅在提示符和文件路径上存在细微差别。
+
+## 前提条件
+
+- 下载并安装 [.NET 9.0 SDK](https://dotnet.microsoft.com/en-us/download)。
+- 本教程使用 `dotnet` 命令行工具，你也可以使用 Visual Studio Code IDE 编写和运行 C# 代码。
+- 你需要有一个可用的 TiDB 实例。可以使用 [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-serverless) 或 [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier/#tidb-cloud-dedicated) 集群，或自托管的 TiDB 集群（如通过 `tiup playground` 启动的集群）。
+
+## 第 1 步：创建控制台项目
+
+使用 `console` 模板创建一个新项目。以下命令会生成一个名为 `tidb_cs` 的新目录。在运行以下命令前，请先切换到希望创建该目录的位置，或指定完整路径。
+
+```
+$ dotnet new console -o tidb_cs
+The template "Console App" was created successfully.
+
+Processing post-creation actions...
+Restoring /home/dvaneeden/tidb_cs/tidb_cs.csproj:
+Restore succeeded.
+```
+
+## 第 2 步：添加 MySql.Data 包
+
+.NET 的包管理器是 NuGet。MySQL Connector/NET 在 NuGet 上的包名为 [MySql.Data](https://www.nuget.org/packages/MySql.Data)，它为 .NET 应用提供对 MySQL 协议的支持。如果你未指定版本，NuGet 会安装最新稳定版（如 9.3.0）。
+
+```shell
+$ cd tidb_cs
+$ dotnet add package MySql.Data
+
+Build succeeded in 1.0s
+info : X.509 certificate chain validation will use the system certificate bundle at '/etc/pki/ca-trust/extracted/pem/objsign-ca-bundle.pem'。
+info : X.509 certificate chain validation will use the fallback certificate bundle at '/usr/lib64/dotnet/sdk/9.0.106/trustedroots/timestampctl.pem'。
+info : Adding PackageReference for package 'MySql.Data' into project '/home/dvaneeden/tidb_cs/tidb_cs.csproj'。
+info :   GET https://api.nuget.org/v3/registration5-gz-semver2/mysql.data/index.json
+info :   OK https://api.nuget.org/v3/registration5-gz-semver2/mysql.data/index.json 133ms
+info : Restoring packages for /home/dvaneeden/tidb_cs/tidb_cs.csproj...
+info :   GET https://api.nuget.org/v3/vulnerabilities/index.json
+info :   OK https://api.nuget.org/v3/vulnerabilities/index.json 98ms
+info :   GET https://api.nuget.org/v3-vulnerabilities/2025.06.18.05.40.02/vulnerability.base.json
+info :   GET https://api.nuget.org/v3-vulnerabilities/2025.06.18.05.40.02/2025.06.19.11.40.05/vulnerability.update.json
+info :   OK https://api.nuget.org/v3-vulnerabilities/2025.06.18.05.40.02/vulnerability.base.json 32ms
+info :   OK https://api.nuget.org/v3-vulnerabilities/2025.06.18.05.40.02/2025.06.19.11.40.05/vulnerability.update.json 64ms
+info : Package 'MySql.Data' is compatible with all the specified frameworks in project '/home/dvaneeden/tidb_cs/tidb_cs.csproj'。
+info : PackageReference for package 'MySql.Data' version '9.3.0' added to file '/home/dvaneeden/tidb_cs/tidb_cs.csproj'。
+info : Generating MSBuild file /home/dvaneeden/tidb_cs/obj/tidb_cs.csproj.nuget.g.targets。
+info : Writing assets file to disk. Path: /home/dvaneeden/tidb_cs/obj/project.assets.json
+log  : Restored /home/dvaneeden/tidb_cs/tidb_cs.csproj (in 551 ms)。
+```
+
+## 第 3 步：更新代码
+
+将 `Program.cs` 中的 "Hello World" 示例替换为以下代码：
+
+```cs
+using System;
+using MySql.Data.MySqlClient;
+public class Tutorial1
+{
+    public static void Main()
+    {
+        // 生产环境请务必使用强密码和唯一密码。
+        string connStr = "server=127.0.0.1;user=root;database=test;port=4000;AllowUserVariables=true";
+        MySqlConnection conn = new MySqlConnection(connStr);
+        try
+        {
+            Console.WriteLine("Connecting to TiDB...\n");
+            conn.Open();
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine(ex.ToString());
+            Environment.Exit(1);
+        }
+
+        Console.WriteLine("Connected to: " + conn.ServerVersion);
+
+        MySqlCommand cmd = new MySqlCommand("SELECT TIDB_VERSION()", conn);
+
+        MySqlDataReader rdr = cmd.ExecuteReader();
+
+        rdr.Read();
+        Console.WriteLine("\nVersion details:\n" + rdr[0]);
+        rdr.Close();
+
+        conn.Close();
+        Console.WriteLine("Done.");
+    }
+}
+```
+
+该代码会连接到指定 IP 和端口的 TiDB 实例。如果你使用的是 TiDB Cloud，请将连接字符串中的参数（如主机名、端口、用户名和密码）替换为 [TiDB Cloud 控制台](https://tidbcloud.com/)提供的信息。
+
+代码首先会连接数据库，并打印其版本信息，然后执行 [`TIDB_VERSION()`](/functions-and-operators/tidb-functions.md#tidb_version) 查询以获取更详细的版本信息，最后输出结果。
+
+## 第 4 步：运行程序
+
+```
+$ dotnet run
+Connecting to TiDB...
+
+Connected to: 8.0.11-TiDB-v8.5.2
+
+Version details:
+Release Version: v8.5.2
+Edition: Community
+Git Commit Hash: f43a13324440f92209e2a9f04c0bbe9cf763978d
+Git Branch: HEAD
+UTC Build Time: 2025-05-29 03:30:55
+GoVersion: go1.23.8
+Race Enabled: false
+Check Table Before Drop: false
+Store: tikv
+Done.
+```