C# 连接ClickHouse 数据库

Favor_Yang2024-12-21 22:00

在 C# 中连接 ClickHouse 数据库，您可以使用 ClickHouse.Client 库。这个库提供了对 ClickHouse 数据库的高效访问。以下是详细的步骤指南，帮助您在 C# 项目中连接和操作 ClickHouse 数据库。

  1. 安装 ClickHouse.Client 包

首先，您需要在您的项目中安装 ClickHouse.Client 包。您可以使用 NuGet 包管理器来完成此操作。

使用 NuGet 包管理器控制台

cs 复制代码 
Install-Package ClickHouse.Client -Version 1.4.1

使用 .NET CLI

cs 复制代码 
dotnet add package ClickHouse.Client --version 1.4.1
  1. 配置 ClickHouse 客户端

接下来，您需要配置 ClickHouse 客户端以连接到您的 ClickHouse 实例。以下是一个基本的配置示例。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;
using System.Data;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            // 配置 ClickHouse 连接字符串
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 执行查询
                    using (var command = new ClickHouseCommand("SELECT * FROM system.numbers LIMIT 10", connection))
                    {
                        using (var reader = command.ExecuteReader())
                        {
                            while (reader.Read())
                            {
                                Console.WriteLine(reader[0]);
                            }
                        }
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}
  1. 创建表

如果您还没有创建表，可以使用 ClickHouse.Client 创建一个新的表。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 创建表
                    string createTableQuery = @"
                        CREATE TABLE IF NOT EXISTS my_table
                        (
                            id UInt32,
                            name String,
                            description String
                        ) ENGINE = MergeTree() ORDER BY id;
                    ";

                    using (var command = new ClickHouseCommand(createTableQuery, connection))
                    {
                        command.ExecuteNonQuery();
                        Console.WriteLine("Table created successfully.");
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}
  1. 插入数据

您可以使用 ClickHouse.Client 将数据插入到 ClickHouse 中。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 插入数据
                    string insertQuery = @"
                        INSERT INTO my_table (id, name, description) VALUES
                        (1, 'Sample Document', 'This is a sample document.'),
                        (2, 'Another Document', 'This is another sample document.');
                    ";

                    using (var command = new ClickHouseCommand(insertQuery, connection))
                    {
                        command.ExecuteNonQuery();
                        Console.WriteLine("Data inserted successfully.");
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}
  1. 查询数据

您可以使用 ClickHouse.Client 执行查询以检索数据。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;
using System.Data;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 查询数据
                    string selectQuery = "SELECT * FROM my_table";

                    using (var command = new ClickHouseCommand(selectQuery, connection))
                    {
                        using (var reader = command.ExecuteReader())
                        {
                            while (reader.Read())
                            {
                                Console.WriteLine($"Id: {reader["id"]}, Name: {reader["name"]}, Description: {reader["description"]}");
                            }
                        }
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}
  1. 更新数据

ClickHouse 不直接支持 UPDATE 操作，但您可以使用 ALTER TABLE ... UPDATE 语句来更新数据。不过，这种操作相对复杂且性能较低，通常建议使用 INSERT 和 DELETE 组合来实现类似的效果。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 更新数据
                    string updateQuery = @"
                        ALTER TABLE my_table UPDATE name = 'Updated Document' WHERE id = 1;
                    ";

                    using (var command = new ClickHouseCommand(updateQuery, connection))
                    {
                        command.ExecuteNonQuery();
                        Console.WriteLine("Data updated successfully.");
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}
  1. 删除数据

您可以使用 ClickHouse.Client 删除数据。

cs 复制代码 
using ClickHouse.Client;
using ClickHouse.Client.ADO;
using System;

namespace ClickHouseExample
{
    class Program
    {
        static void Main(string[] args)
        {
            string connectionString = "Host=127.0.0.1;Port=9000;Username=default;Password=;Database=default";

            using (var connection = new ClickHouseConnection(connectionString))
            {
                try
                {
                    connection.Open();
                    Console.WriteLine("Connected to ClickHouse!");

                    // 删除数据
                    string deleteQuery = @"
                        ALTER TABLE my_table DELETE WHERE id = 2;
                    ";

                    using (var command = new ClickHouseCommand(deleteQuery, connection))
                    {
                        command.ExecuteNonQuery();
                        Console.WriteLine("Data deleted successfully.");
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"Error connecting to ClickHouse: {ex.Message}");
                }
            }
        }
    }
}

总结

通过以上步骤，您可以在 C# 项目中成功连接和操作 ClickHouse 数据库。ClickHouse.Client 提供了丰富的 API 来执行各种操作，如创建表、插入数据、查询数据、更新数据和删除数据。确保您的 ClickHouse 实例正在运行，并且客户端配置正确，以便顺利进行这些操作。如果遇到任何问题，可以参考 ClickHouse.Client 的官方文档或社区资源以获取更多帮助。

参考资料：

• ClickHouse 官方文档 https://clickhouse.com/docs/zh/getting-started/install

• ClickHouse.Client https://github.com/yandex/ClickHouse.Client

相关推荐
NineData4 小时前
NineData 迁移评估功能正式上线
数据库·dba
NineData10 小时前
数据库迁移总踩坑？用 NineData 迁移评估，提前识别所有兼容性风险
数据库·程序员·云计算
赵渝强老师12 小时前
【赵渝强老师】PostgreSQL中表的碎片
数据库·postgresql
Ray Liang14 小时前
用六边形架构与整洁架构对比是伪命题？
java·python·c#·架构设计
全栈老石16 小时前
拆解低代码引擎核心：元数据驱动的"万能表"架构
数据库·低代码
倔强的石头_1 天前
kingbase备份与恢复实战（二）—— sys_dump库级逻辑备份与恢复（Windows详细步骤）
数据库
jiayou643 天前
KingbaseES 实战：深度解析数据库对象访问权限管理
数据库
李广坤4 天前
MySQL 大表字段变更实践（改名 + 改类型 + 改长度）
数据库
Scout-leaf4 天前
WPF新手村教程（三）—— 路由事件
c#·wpf
用户298698530144 天前
程序员效率工具：Spire.Doc如何助你一键搞定Word表格排版
后端·c#·.net
热门推荐
01GitHub 镜像站点02OpenClaw 使用和管理 MCP 完全指南03OpenClaw + 飞书（Feishu）环境搭建指南04Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services05小黑课堂计算机二级WPSoffice题库软件下载安装教程（2026年3月最新版）06Clawdbot部署教程：解决‘gateway token missing’授权问题的完整步骤07OpenClaw优化飞书API 额度已耗尽问题08Window 10部署openclaw报错node.exe : npm error code 12809【OpenClaw 本地实战 Ep.3】突破瓶颈：强制修改 openclaw.json 解锁 32k 上下文记忆10OpenClaw大龙虾机器人完整安装教程