Skip to content

Commit ada074a

Browse files
Update CSV library documentation and links
Revised README to clarify CSV library features, emphasize SQL Server optimization, and update links to the landing page and documentation. Added migration guide reference and improved feature descriptions for better developer understanding.
1 parent 58a738d commit ada074a

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ dbatools.library is a .NET library that provides the core functionality for the
1414
- Microsoft.Data.SqlClient for SQL Server connectivity
1515
- DacFx for database deployment operations
1616
- Extended Events (XEvent) processing capabilities
17-
- **High-performance CSV reader** for bulk data import (also available as standalone NuGet package)
17+
- **High-performance CSV library** built for database workflows (also available as [standalone NuGet package](https://dataplat.dbatools.io/csv))
1818
- Multi-framework support (.NET Framework 4.7.2 and .NET 8.0)
1919

2020
This library enables dbatools to work seamlessly across Windows PowerShell 5.1 and PowerShell 7+ on Windows, macOS, and Linux.
@@ -25,19 +25,22 @@ This library enables dbatools to work seamlessly across Windows PowerShell 5.1 a
2525

2626
[![NuGet](https://img.shields.io/nuget/v/Dataplat.Dbatools.Csv.svg)](https://www.nuget.org/packages/Dataplat.Dbatools.Csv)
2727

28-
High-performance CSV reader and writer for .NET. **20%+ faster than LumenWorks CsvReader** with modern features:
28+
**The CSV library built for SQL Server.** High-performance CSV reader and writer optimized for database import workflows:
2929

30-
- Streaming `IDataReader` for SqlBulkCopy (~25,000 rows/sec)
31-
- Automatic compression support (GZip, Deflate, Brotli, ZLib)
32-
- Parallel processing for large files
33-
- Multi-character delimiters, smart quote handling
34-
- Robust error handling and security protections
30+
- **Native IDataReader** - Stream directly to SqlBulkCopy with zero intermediate allocations
31+
- **6x faster than LumenWorks** for typical SqlBulkCopy patterns
32+
- **Built-in compression** - GZip, Deflate, Brotli, ZLib with decompression bomb protection
33+
- **Progress & cancellation** - Monitor large imports with callbacks, cancel with CancellationToken
34+
- **Real-world data handling** - Lenient parsing, smart quotes, duplicate headers, field mismatches
3535

3636
```bash
3737
dotnet add package Dataplat.Dbatools.Csv
3838
```
3939

40-
See the [CSV package documentation](project/Dataplat.Dbatools.Csv/README.md) for full details.
40+
**Resources:**
41+
- [Landing page](https://dataplat.dbatools.io/csv) - Quick overview and benchmarks
42+
- [Full documentation](project/Dataplat.Dbatools.Csv/README.md) - Complete API reference
43+
- [Migration guide](project/Dataplat.Dbatools.Csv/MIGRATING-FROM-LUMENWORKS.md) - For LumenWorks users
4144

4245
## Installation
4346

@@ -205,7 +208,7 @@ This library includes several major SQL Server components:
205208

206209
| Package | Purpose |
207210
|---------|---------|
208-
| [Dataplat.Dbatools.Csv](https://www.nuget.org/packages/Dataplat.Dbatools.Csv) | High-performance CSV reader/writer for .NET |
211+
| [Dataplat.Dbatools.Csv](https://dataplat.dbatools.io/csv) | High-performance CSV library for database workflows |
209212

210213
## Contributing
211214

0 commit comments

Comments
 (0)