CSVFile 3.1.0

.NET 5.0 .NET Standard 2.0 .NET Framework 2.0
Install-Package CSVFile -Version 3.1.0
dotnet add package CSVFile --version 3.1.0
<PackageReference Include="CSVFile" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add CSVFile --version 3.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CSVFile, 3.1.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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.0

// Install CSVFile as a Cake Tool
#tool nuget:?package=CSVFile&version=3.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

NuGet Travis (.com)

csharp-csv-reader

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 CSharp CSV Reader?

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.

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 Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net20 net35 net40 net403 net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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.0 1,245 4/4/2022
3.0.9 319 3/23/2022
3.0.8 96 3/23/2022
3.0.7 318 3/16/2022
3.0.6 1,831 3/7/2022
3.0.5 75 3/2/2022
3.0.4 543 2/15/2022
3.0.3 105 2/11/2022
3.0.2 6,360 4/9/2021
3.0.1 222 4/9/2021
2.0.3 10,757 10/30/2018
1.2.2.2 16,255 11/18/2016
1.2.2 1,212 11/4/2016
1.2.2-beta 1,080 11/4/2016
1.2.1 1,115 8/1/2016

April 4, 2022

* Improve handling for read-only properties with more errors and options
* Added support for excluding columns from serialization
* Added support for forcing columns to have text qualifiers
* Support for fully async serialization
* Unified all serialization code