Refactor C# client documentation #4691
Open
+301
−81
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the C# Driver documentation by combining content from the current docs and the legacy wiki, fixing errors, and adding missing information to provide developers with complete and accurate guidance.
Key improvements:
Fixed Issues
ClickHouse.Client.ADOtoClickHouse.Driver.ADOthroughout all examplesEnhanced Documentation
Connection & Pooling:
HttpClientbehaviorIHttpClientFactoryusage for DI scenariosConnection String Parameters:
Data Types:
Int8→sbyte,UInt64→ulong)Decimal128→decimal,Map(K, V)→Dictionary<K, V>SQL Parameters:
{<name>:<data type>}Bulk Insert:
InitAsync()method call (from legacy wiki)ColumnNamesproperty, and session incompatibilityDateTime Handling:
ToLocalTime()method documentationUseServerTimezoneflag usageMigrated from Legacy Wiki
Related Issue: N/A (documentation improvement)
Checklist
ClickHouse.Client→ClickHouse.Driver)Testing
Migration Path
This update provides a clear migration path for users moving from the old
ClickHouse.Clientpackage:ClickHouse.Client→ClickHouse.Driver)Compression=trueby default)UseServerTimezone,UseCustomDecimals)Documentation Completeness: This PR combines the best of the current documentation and the legacy wiki, ensuring developers have access to comprehensive, accurate, and well-organized information about the ClickHouse C# Driver.
Thank you.