Sylvan.Data.Excel 0.4.17

The ID prefix of this package has been reserved for one of the owners of this package by Prefix Reserved
.NET 6.0 .NET Standard 2.0
dotnet add package Sylvan.Data.Excel --version 0.4.17
NuGet\Install-Package Sylvan.Data.Excel -Version 0.4.17
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="Sylvan.Data.Excel" Version="0.4.17" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sylvan.Data.Excel --version 0.4.17
#r "nuget: Sylvan.Data.Excel, 0.4.17"
#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 Sylvan.Data.Excel as a Cake Addin
#addin nuget:?package=Sylvan.Data.Excel&version=0.4.17

// Install Sylvan.Data.Excel as a Cake Tool
#tool nuget:?package=Sylvan.Data.Excel&version=0.4.17


A cross-platform .NET library for reading and writing Excel data files. The most commonly used formats: .xlsx, .xlsb and .xls, are supported for reading, while .xlsx and .xlsb formats are supported for writing.

ExcelDataReader provides readonly, row by row, forward-only access to the data. It provides a familiar API via DbDataReader, which is ideal for accessing rectangular, tabular data sets. It exposes a single, unified API for accessing all supported file formats.

ExcelDataWriter supports writing data from a DbDataReader to an Excel worksheet in .xlsx and .xlsb formats. ExcelDataWriter can only write a new Excel, it cannot be used to edit or append to existing files. It does not support custom formatting, charts, or other common features. It is meant only to export raw, flat data to Excel.

The library is a purely managed implementation with no external dependencies.

This library is currently the fastest and lowest allocating library for reading Excel data files in the .NET ecosystem, for all supported formats.

If you encounter any issues while using this library, please report an issue in the github repository. Be aware that I will be unlikely to investigate any issue unless an example file can be provided reproducing the issue.


Sylvan.Data.Excel Nuget Package

Install-Package Sylvan.Data.Excel


ExcelDataReader derives from DbDataReader, so it exposes an API that should be familiar for anyone who has worked with ADO.NET before. The field accessors allow reading data in an efficient, strongly-typed manner: GetString, GetInt32, GetDateTime, GetBoolean, etc.

The GetExcelDataType method allows inspecting the native Excel data type of a cell, which may vary from row to row. FieldCount, returns the number of columns in the header row, and doesn't change while processing each row in a sheet. RowFieldCount returns the number of fields in the current row, which might vary from row to row, and can be used to access cells in a "jagged", non-rectangular file.

Reading Raw Data

The ExcelDataReader provides a forward only, row by row access to the data in a worksheet. It allows iterating over sheets using the NextResult() method, and iterating over rows using the Read() method. Fields are accessed using standard accessors, most commonly GetString(). GetString() is designed to not throw an exception, except in the case that a cell contains a formula error. The TryOpenWorksheet(string name) method can be used to open a specific, known worksheet.

using Sylvan.Data.Excel;

// ExcelDataReader derives from System.Data.DbDataReader
// The Create method can open .xls, .xlsx or .xlsb files.
using ExcelDataReader edr = ExcelDataReader.Create("data.xls");

	var sheetName = edr.WorksheetName;
	// enumerate rows in current sheet.
		// iterate cells in row.
		// can use edr.RowFieldCount when sheet contains jagged, non-rectangular data
		for(int i = 0; i < edr.FieldCount; i++)
			var value = edr.GetString(i);
		// Can use other strongly-typed accessors
		// bool flag = edr.GetBoolean(0);
		// DateTime date = edr.GetDateTime(1);
		// decimal amt = edr.GetDecimal(2);
	// iterates sheets
} while(edr.NextResult());

Bind Excel data to objects using Sylvan.Data

The Sylvan.Data library includes a general-purpose data binder that can bind a DbDataReader to objects. This can be used to easily read an Excel file as a series of strongly typed objects.

using Sylvan.Data;
using Sylvan.Data.Excel;

using var edr = ExcelDataReader.Create("data.xlsx");
foreach (MyRecord item in edr.GetRecords<MyRecord>())
    Console.WriteLine($"{item.Name} {item.Quantity}");

class MyRecord
    public int Id { get; set; }
    public string Name { get; set; }
    public int? Quantity { get; set; }
    public DateTime Date { get; set; }

Converting Excel data to CSV(s)

The Sylvan.Data.Csv library can be used to convert Excel worksheet data to CSV.

using Sylvan.Data.Excel;
using Sylvan.Data.Csv;

using var edr = ExcelDataReader.Create("data.xlsx");

	var sheetName = edr.WorksheetName;
	using CsvDataWriter cdw = CsvDataWriter.Create("data-" + sheetName + ".csv")
} while(edr.NextResult());


The ExcelDataWriter type is used to create Excel workbooks and write DbDataReader data as worksheets.

// *critical* to dispose (using) ExcelDataWriter.
using var edw = ExcelDataWriter.Create("data.xlsx");
DbDataReader dr;
dr = GetQueryResults("UserReport");
edw.Write(dr, "UserReport");
dr = GetQueryResults("SecurityAudit");
edw.Write(dr, "SecurityAudit");
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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. 
.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 is compatible. 
.NET Framework 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)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.
  • net6.0

    • No dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Sylvan.Data.Excel:

Package Downloads

一个超高性能的Excel强类型读写映射库。(支持.xls .xlsx .csv)

Sylvan.AspNetCore.Mvc.Excel The ID prefix of this package has been reserved for one of the owners of this package by

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.17 72 9/26/2023
0.4.17-b0004 53 9/22/2023
0.4.17-b0003 60 9/15/2023
0.4.17-b0002 120 9/12/2023
0.4.17-b0001 63 9/11/2023
0.4.16 1,062 9/8/2023
0.4.15 288 9/5/2023
0.4.14 2,214 8/17/2023
0.4.13 2,056 7/19/2023
0.4.13-b0001 95 7/12/2023
0.4.12 5,272 5/18/2023
0.4.11 4,196 4/25/2023
0.4.10 2,390 3/28/2023
0.4.9 1,913 3/3/2023
0.4.8 4,719 2/23/2023
0.4.7 1,058 2/22/2023
0.4.6 628 2/16/2023
0.4.6-b0001 79 2/10/2023
0.4.5 2,580 1/28/2023
0.4.4 1,285 1/18/2023
0.4.3 9,252 12/7/2022
0.4.2 711 11/25/2022
0.4.1 554 11/17/2022
0.4.0 4,026 11/2/2022
0.3.4 347 11/2/2022
0.3.3 3,281 9/12/2022
0.3.2 775 9/2/2022
0.3.1 594 9/1/2022
0.3.0 1,064 8/12/2022
0.2.3 470 8/10/2022
0.2.2 434 8/9/2022
0.2.1 706 7/18/2022
0.2.0 818 6/24/2022
0.2.0-b0004 124 6/23/2022
0.2.0-b0003 128 6/22/2022
0.2.0-b0002 126 6/21/2022
0.2.0-b0001 136 6/18/2022
0.1.12 469 6/16/2022
0.1.11 476 6/15/2022
0.1.11-b0006 154 6/6/2022
0.1.11-b0005 2,042 5/10/2022
0.1.11-b0004 126 5/2/2022
0.1.11-b0003 143 3/8/2022
0.1.11-b0002 118 2/28/2022
0.1.11-b0001 116 2/23/2022
0.1.10 4,394 2/22/2022
0.1.9 455 2/21/2022
0.1.8 451 2/20/2022
0.1.7 552 1/22/2022
0.1.6 1,263 1/13/2022
0.1.4 1,606 11/28/2021
0.1.3 333 10/18/2021
0.1.2 407 10/8/2021
0.1.1 354 10/5/2021
0.1.0 412 10/4/2021