https://github.com/Octonica/ClickHouseClient

ClickHouse .NET Core driver
https://github.com/Octonica/ClickHouseClient

adonet clickhouse dotnetcore

Last synced: about 1 month ago
JSON representation

ClickHouse .NET Core driver

• Host: GitHub
• URL: https://github.com/Octonica/ClickHouseClient
• Owner: Octonica
• License: apache-2.0
• Created: 2020-04-09T06:42:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-10T07:30:40.000Z (3 months ago)
• Last Synced: 2024-11-06T06:43:26.137Z (about 1 month ago)
• Topics: adonet, clickhouse, dotnetcore
• Language: C#
• Size: 1.12 MB
• Stars: 140
• Watchers: 8
• Forks: 23
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-clickhouse - Octonica/ClickHouseClient - ClickHouse .NET Core driver that implements the ADO.NET DbProvider API for database interactions. (Language bindings / .Net)

README

        
ClickHouse .NET Core driver

===============

This is an implementation of .NET Core driver for ClickHouse in a form of ADO.NET DbProvider API. This driver supports all ADO.NET features (with some exclusions like transaction support).

### Features

* supports binary protocol

* compression (send and recieve)

* timezones

* most clickhouse [column types](docs/TypeMapping.md) are supported ([aggregating ones](https://clickhouse.tech/docs/en/sql_reference/data_types/aggregatefunction/) are under development)

* full support for .net async ADO.NET API

* no unsafe code

* ~~tested~~- used in production

* c# named tuple and record support

* [Dapper](https://dapperlib.github.io/Dapper/) support (example in [#19](https://github.com/Octonica/ClickHouseClient/issues/19))

* [Linq To DB](https://github.com/linq2db/linq2db) support

### Usage

Install from [NuGet](https://www.nuget.org/packages/Octonica.ClickHouseClient/):

```

dotnet add package Octonica.ClickHouseClient

```

ConnectionString syntax: 

`Host=;Port=;Database=;Password=`, e.g. `"Host=127.0.0.1;Password=P@ssw0rd; Database=db` additionally, if you want to build a connection string via code you can use `ClickHouseConnectionStringBuilder`.

Entry point for API is ADO .NET DbConnection Class: `Octonica.ClickHouse.ClickHouseConnection`.

### Extended API

In order to provide non-ADO.NET complaint data manipulation functionality, proprietary [ClickHouseColumnWriter](docs/ClickHouseColumnWriter.md) API exists.

Entry point for API is `ClickHouseConnection.CreateColumnWriter()` method.

#### Simple SELECT async verison

```csharp

var sb = new ClickHouseConnectionStringBuilder();

sb.Host = "127.0.0.1";

using var conn = new ClickHouseConnection(sb);

await conn.OpenAsync();

var currentUser = await conn.CreateCommand("select currentUser()").ExecuteScalarAsync();

```

#### Insert data with parameters

```csharp

var sb = new ClickHouseConnectionStringBuilder();

sb.Host = "127.0.0.1";

using var conn = new ClickHouseConnection(sb);

conn.Open();

using var cmd = conn.CreateCommand("INSERT INTO table_you_just_created SELECT {id}, {dt}");

cmd.Parameters.AddWithValue("id", Guid.NewGuid());

cmd.Parameters.AddWithValue("dt", DateTime.Now, System.Data.DbType.DateTime);

var _ = cmd.ExecuteNonQuery();

```

For more information see [Parameters](docs/Parameters.md).

#### Bulk insert

```csharp

using var conn = new ClickHouseConnection("Host=127.0.0.1");

conn.Open();

using var cmd = conn.CreateCommand("CREATE TABLE IF NOT EXISTS table_with_two_fields(id Int32, name String) engine Memory");

await cmd.ExecuteNonQueryAsync();

//generate values

List ids = Enumerable.Range(1, 10_000).ToList();

List names = ids.Select(i => $"Name #{i}").ToList();

//insert data

await using (var writer = await conn.CreateColumnWriterAsync("insert into table_with_two_fields(id, name) values", default))

{

	await writer.WriteTableAsync(new object[] { ids, names }, ids.Count, default);

}

```

### Build requirements

In order to build the driver you need to have .NET SDK 5.0 or higher.