CSVFile 3.1.2

dotnet add package CSVFile --version 3.1.2
NuGet\Install-Package CSVFile -Version 3.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CSVFile" Version="3.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CSVFile --version 3.1.2
#r "nuget: CSVFile, 3.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install CSVFile as a Cake Addin
#addin nuget:?package=CSVFile&version=3.1.2

// Install CSVFile as a Cake Tool
#tool nuget:?package=CSVFile&version=3.1.2

NuGet GitHub Workflow Status SonarCloud Coverage SonarCloud Bugs SonarCloud Vulnerabilities

CSVFile

This library is a series of unit tested, thoroughly commented CSV parsing functions which I have developed off and on since 2006. Extremely small and easy to implement; includes unit tests for the majority of odd CSV edge cases. Library supports different delimiters, qualifiers, and embedded newlines. Can read and write from data tables.

Why use CSVFile?

A few reasons:

  • Compatible with DotNet Framework / C# 2.0 and later. Makes it easy to integrate this library into extremely old legacy projects.
  • Between 16-32 kilobytes in size, depending on framework.
  • No dependencies.
  • Handles all the horrible edge cases from poorly written CSV generating software: custom delimiters, embedded newlines, and doubled-up text qualifiers.
  • Reads via streams, optionally using asynchronous I/O. You can parse CSV files larger than you can hold in memory without thrashing.
  • Ability to pipe data tables directly into SQL Server using Table Parameter Inserts
  • Fastest with direct string parsing or async I/O, but good enough performance when reading from MemoryStreams

CSV edge cases

This library was designed to handle edge cases I experienced when working with partner files.

Case Example
CSV files larger than can fit into memory streamed off disk 10TB files
Pipe delimited files field1\|field2
Hand written CSV with spaces after deliminters "field1", "field2", "field3"
Embedded newlines within a text qualifier "field1\r\nanother line","field2"
Text qualifiers as regular characters within a field "field1",field2 "field2" field2,"field3"
Doubled up text qualifiers within a qualified field "field1","field2 ""field2"" field2","field3"
Different line separators CR, LF, something else
Different text encoding UTF-8, UTF-16, ASCII
SEP= lines for European CSV files sep=;\\r\\n

Tutorial

Want to get started? Here are a few walkthroughs.

Custom CSV Settings

Do you have files that use the pipe symbol as a delimiter, or does your application need double quotes around all fields? No problem!

var settings = new CSVSettings()
{
    FieldDelimiter = '|',
    TextQualifier = '\'',
    ForceQualifiers = true
};
s = array.ToCSVString(settings);

Streaming asynchronous CSV

The latest asynchronous I/O frameworks allow you to stream CSV data off disk without blocking. Here's how to use the asynchronous I/O features of Dot Net 5.0:

using (var cr = CSVReader.FromFile(filename, settings)) {
    await foreach (string[] line in cr) {
        // Do whatever you want with this one line - the buffer will
        // only hold a small amount of memory at once, so you can 
        // iterate at your own pace!
    }
}

Streaming CSV without async

Don't worry if your project isn't yet able to use asynchronous foreach loops. You can still use the existing reader logic:

using (CSVReader cr = new CSVReader(sr, settings)) {
    foreach (string[] line in cr) {
        // Process this one line
    }
}

Serialize and Deserialize

You can serialize and deserialize between List<T> and CSV arrays. Serialization supports all basic value types, and it can even optionally support storing null values in CSV cells.

var list = new List<MyClass>();

// Serialize an array of objects to a CSV string
string csv = CSV.Serialize<MyClass>(list);

// Deserialize a CSV back into an array of objects
foreach (var myObject in CSV.Deserialize<MyClass>(csv)) {
    // Use the objects
}

Data Table Support (for older DotNet frameworks)

For those of you who work in older frameworks that still use DataTables, this feature is still available:

// This code assumes the file is on disk, and the first row of the file
// has the names of the columns on it
DataTable dt = CSV.LoadDataTable(myfilename);

// Save a datatable to a file
dt.SaveAsCSV(myfilename, true);

Hand Roll Your Own

The class CSV contains a lot of useful functions for hand rolling your own CSV related code. You can use any of the functions in the CSV class directly.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net20 is compatible.  net35 was computed.  net40 is compatible.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 2.0

    • No dependencies.
  • .NETFramework 4.0

    • No dependencies.
  • .NETFramework 4.5

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.
  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.1.2 23,057 7/19/2023
3.1.1 22,487 3/18/2023
3.1.0 15,597 4/4/2022
3.0.9 884 3/23/2022
3.0.8 526 3/23/2022
3.0.7 2,655 3/16/2022
3.0.6 16,147 3/7/2022
3.0.5 450 3/2/2022
3.0.4 940 2/15/2022
3.0.3 509 2/11/2022
3.0.2 9,512 4/9/2021
3.0.1 418 4/9/2021
2.0.3 33,690 10/30/2018
1.2.2.2 22,177 11/18/2016
1.2.2 1,532 11/4/2016
1.2.2-beta 1,209 11/4/2016
1.2.1 1,460 8/1/2016

July 18, 2023

* Fix issue with inconsistent handling of embedded newlines in the streaming version of the reader