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

相关推荐
KellenKellenHao15 分钟前
MySQL数据库主从复制
数据库·mysql
@ chen39 分钟前
Redis事务机制
数据库·redis
KaiwuDB1 小时前
使用Docker实现KWDB数据库的快速部署与配置
数据库·docker
一只fish1 小时前
MySQL 8.0 OCP 1Z0-908 题目解析(16)
数据库·mysql
泊浮目2 小时前
未来数据库硬件-网络篇
数据库·架构·云计算
静若繁花_jingjing2 小时前
Redis线程模型
java·数据库·redis
一名用户2 小时前
unity实现梦日记式传送组件
后端·c#·unity3d
Edingbrugh.南空3 小时前
Flink ClickHouse 连接器维表源码深度解析
java·clickhouse·flink
飞翔的佩奇3 小时前
Java项目：基于SSM框架实现的忘忧小区物业管理系统【ssm+B/S架构+源码+数据库+毕业论文+开题报告】
java·数据库·mysql·vue·毕业设计·ssm框架·小区物业管理系统
阿蒙Amon3 小时前
C#扩展方法全解析：给现有类型插上翅膀的魔法
开发语言·c#
热门推荐
01集群聊天服务器---MySQL数据库的建立02GPU 进阶笔记（二）：华为昇腾 910B GPU03Coze扣子平台完整体验和实践（附国内和国际版对比）04使用Ruby接入实时行情API教程05Word粘贴时出现“运行时错误53,文件未找到：MathPage.WLL“的解决方案06扣子（coze）实战|我用扣子搭建了一个自动分析小红薯笔记内容的AI应用|详细步骤拆解07基于odoo17的设计模式详解---装饰模式08扣子空间的使用教程与大模型技术思考09DeepSeek各版本说明与优缺点分析10Everything文件检索工具 几秒检索几百G的文件