Skip to content

Commit 27dcf15

Browse files
Nuget readme fix (#82)
* add nuget-specific readme file * release notes
1 parent da36f0f commit 27dcf15

File tree

3 files changed

+40
-33
lines changed

3 files changed

+40
-33
lines changed

ClickHouse.Driver/ClickHouse.Driver.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<Authors>ClickHouse</Authors>
1212
<Description>Fast binary-over-HTTP ADO.NET provider for ClickHouse</Description>
1313
<PackageLicenseExpression>MIT</PackageLicenseExpression>
14-
<PackageReadmeFile>README.md</PackageReadmeFile>
14+
<PackageReadmeFile>README.nuget.md</PackageReadmeFile>
1515
<PublishRepositoryUrl>true</PublishRepositoryUrl>
1616
<IncludeSymbols>true</IncludeSymbols>
1717
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
@@ -29,7 +29,7 @@
2929
</Target>
3030

3131
<ItemGroup>
32-
<None Include="..\README.md" Link="README.md" Pack="true" PackagePath="" />
32+
<None Include="..\README.nuget.md" Link="README.nuget.md" Pack="true" PackagePath="" />
3333
</ItemGroup>
3434

3535
<ItemGroup>

README.nuget.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# ClickHouse C# client
2+
3+
## About
4+
5+
Official C#/ADO.NET client for [ClickHouse](https://clickhouse.com/).
6+
7+
* High performance
8+
* Supports bulk insertion
9+
* Uses compressed binary protocol over HTTP(S)
10+
* Available for .NET Core/Framework/Standard
11+
12+
## Documentation
13+
14+
See the [ClickHouse website](https://clickhouse.com/docs/integrations/csharp) for full documentation.
15+
16+
## Usage examples
17+
18+
We have a wide range of [examples](https://github.com/ClickHouse/clickhouse-cs/tree/main/examples), aiming to cover typical scenarios of client usage.
19+
20+
## ClickHouse Versions
21+
22+
The supported versions ofthe ClickHouse database server coincide with the versions currently receiving security updates.
23+
24+
For the list of currently supported versions, see [here](https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support).
25+
26+
## Contact us
27+
28+
If you have any questions or need help, feel free to reach out to us in the [Community Slack](https://clickhouse.com/slack) or via [GitHub issues](https://github.com/ClickHouse/clickhouse-cs/issues).
29+
30+
## Contributing
31+
32+
Contributions are welcome and highly appreciated! Check out our [contributing guide](https://github.com/ClickHouse/clickhouse-cs/blob/main/CONTRIBUTING.md).
33+
34+
## Acknowledgements
35+
Originally created by [Oleg V. Kozlyuk](https://github.com/DarkWanderer)

RELEASENOTES.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,5 @@
1-
v0.8.0
1+
v0.8.1
22
---
33

4-
**Breaking Changes:**
5-
* Trying to set ClickHouseConnection.ConnectionString will now throw a NotSupportedException. Create a new connection with the desired settings instead.
6-
* When a default database is not provided, the client no longer uses "default" (now uses empty string). This allows default user database settings to function as expected.
7-
* ClickHouseDataSource.Logger (ILogger) property changed to LoggerFactory (ILoggerFactory).
8-
* Removed support for loading configuration from environment variables (CLICKHOUSE_DB, CLICKHOUSE_USER, CLICKHOUSE_PASSWORD). Use connection strings or ClickHouseClientSettings instead.
9-
* The default PooledConnectionIdleTimeout has been changed to 5 seconds, to prevent issues with half-open connections when using ClickHouse Cloud (where the default server-side idle timetout is 10s).
10-
11-
**New Features:**
12-
* Added .NET 10 as a target.
13-
* The NuGet package is now signed.
14-
* Enabled strong naming for the library.
15-
* Added a new way to configure ClickHouseConnection: the ClickHouseClientSettings class. You can initialize it from a connection string by calling ClickHouseClientSettings.FromConnectionString(), or simply by setting its properties.
16-
* Added settings validation to prevent incorrect configurations.
17-
* Added logging in the library, enable it by passing a LoggerFactory through the settings. Logging level configuration is configured through the factory. For more info, see the documentation: https://clickhouse.com/docs/integrations/csharp#logging-and-diagnostics
18-
* Added EnableDebugMode setting to ClickHouseClientSettings for low-level .NET network tracing (.NET 5+). When enabled, traces System.Net events (HTTP, Sockets, DNS, TLS) to help diagnose network issues. Requires ILoggerFactory with Trace-level logging enabled. WARNING: Significant performance impact - not recommended for production use.
19-
* AddClickHouseDataSource now automatically injects ILoggerFactory from the service provider when not explicitly provided.
20-
* Improvements to ActivitySource for tracing: stopped adding tags when it was not necessary, and made it configurable through ClickHouseDiagnosticsOptions.
21-
* Added new AddClickHouseDataSource extension methods that accept ClickHouseClientSettings for strongly-typed configuration in DI scenarios.
22-
* Added new AddClickHouseDataSource extension method that accepts IHttpClientFactory for better DI integration.
23-
* Optimized response header parsing.
24-
* Added list type conversion, so List<T> can now be passed to the library (converts to Array() in ClickHouse). Thanks to @jorgeparavicini.
25-
* Optimized EnumType value lookups.
26-
* Avoid unnecessarily parsing the X-ClickHouse-Summary headers twice. Thanks to @verdie-g.
27-
* Added the ability to pass a query id to ClickHouseConnection.PostStreamAsync(). Thanks to @dorki.
28-
* The user agent string now also contains information on the host operating system, .NET version, and processor architecture.
29-
30-
**Bug fixes:**
31-
* Fixed a crash when processing a tuple with an enum in it.
32-
* Fixed a potential sync-over-async issue in the connection. Thanks to @verdie-g.
33-
* Fixed a bug with parsing table definitions with parametrized json fields. Thanks to @dorki.
4+
**Improvements:**
5+
* Fixed NuGet readme file.

0 commit comments

Comments
 (0)