Parquet.Net 4.6.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package Parquet.Net --version 4.6.2
NuGet\Install-Package Parquet.Net -Version 4.6.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="Parquet.Net" Version="4.6.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Parquet.Net --version 4.6.2
#r "nuget: Parquet.Net, 4.6.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 Parquet.Net as a Cake Addin
#addin nuget:?package=Parquet.Net&version=4.6.2

// Install Parquet.Net as a Cake Tool
#tool nuget:?package=Parquet.Net&version=4.6.2

Apache Parquet for .NET NuGet Nuget

Icon

Fully managed, safe, extremely fast .NET library to 📖read and ✍️write Apache Parquet files designed for .NET world (not a wrapper). Targets .NET 7, .NET 6.0, .NET Core 3.1, .NET Standard 2.1 and .NET Standard 2.0.

Whether you want to build apps for Linux, MacOS, Windows, iOS, Android, Tizen, Xbox, PS4, Raspberry Pi, Samsung TVs or much more, Parquet.NET has you covered.

Make sure to check out Apache Parquet Viewer built with this library:

alternate text is missing from this package README image

Why

Parquet is a great format for storing and processing large amounts of data, but it can be tricky to use with .NET. That's why this library is here to help. It's a pure library that doesn't need any external dependencies, and it's super fast - faster than Python and Java, and other C# solutions. It's also native to .NET, so you don't have to deal with any wrappers or adapters that might slow you down or limit your options.

This library is the best option for parquet files in .NET. It has a simple and intuitive API, supports all the parquet features you need, and handles complex scenarios with ease.

Also it:

  • Has zero dependencies - pure library that just works.
  • Really fast. Faster than Python and Java, and alternative C# implementations out there. It's often even faster than native C++ implementations.
  • .NET native. Designed to utilise .NET and made for .NET developers, not the other way around.
  • Not a "wrapper" that forces you to fit in. It's the other way around - forces parquet to fit into .NET.

Quick Start

Parquet is designed to handle complex data in bulk. It's column-oriented meaning that data is physically stored in columns rather than rows. This is very important for big data systems if you want to process only a subset of columns - reading just the right columns is extremely efficient.

As a quick start, suppose we have the following data records we'd like to save to parquet:

  1. Timestamp.
  2. Event name.
  3. Meter value.

Or, to translate it to C# terms, this can be expressed as the following class:

class Record {
    public DateTime Timestamp { get; set; }
    public string EventName { get; set; }
    public double MeterValue { get; set; }
}

✍️Writing Data

Let's say you have around a million of events like that to save to a .parquet file. There are three ways to do that with this library, starting from easiest to hardest.

🚤Class Serialisation

The first one is the easiest to work with, and the most straightforward. Let's generate those million fake records:

var data = Enumerable.Range(0, 1_000_000).Select(i => new Record {
    Timestamp = DateTime.UtcNow.AddSeconds(i),
    EventName = i % 2 == 0 ? "on" : "off",
    MeterValue = i 
}).ToList();

Now, to write these to a file in say /mnt/storage/data.parquet you can use the following line of code:

await ParquetSerializer.SerializeAsync(data, "/mnt/storage/data.parquet");

That's pretty much it! You can customise many things in addition to the magical magic process, but if you are a really lazy person that will do just fine for today.

🌛Row Based API

Another way to serialise data is to use row-based API. They look at your data as a Table, which consists of a set of Rows. Basically looking at the data backwards from the point of view of how Parquet format sees it. However, that's how most people think about data. This is also useful when converting data from row-based formats to parquet and vice versa. Anyway, use it, I won't judge you (very often).

Let's generate a million of rows for our table, which is slightly more complicated. First, we need to declare table and it's schema:

var table = new Table(
    new DataField<DateTime>("Timestamp"),
    new DataField<string>("EventName"),
    new DataField<double>("MeterName"));

The code above says we are creating a new empty table with 3 fields, identical to example above with class serialisation. We are essentially declaring table's schema here. Parquet format is strongly typed and all the rows will have to have identical amount of values and their types.

Now that empty table is ready, add a million rows to it:

for(int i = 0; i < 1_000_000; i++) {
    table.Add(
        DateTime.UtcNow.AddSeconds(1),
        i % 2 == 0 ? "on" : "off",
        (double)i);
}

The data will be identical to example above. And to write the table to a file:

await table.WriteAsync("/mnt/storage/data.parquet");

Of course this is a trivial example, and you can customise it further.

⚙️Low Level API

And finally, the lowest level API is the third method. This is the most performant, most Parquet-resembling way to work with data, but least intuitive and involves some knowledge of Parquet data structures.

First of all, you need schema. Always. Just like in row-based example, schema can be declared in the following way:

var schema = new ParquetSchema(
    new DataField<DateTime>("Timestamp"),
    new DataField<string>("EventName"),
    new DataField<double>("MeterName"));

Then, data columns need to be prepared for writing. As parquet is column-based format, low level APIs expect that low level column slice of data. I'll just shut up and show you the code:

var column1 = new DataColumn(
    (DataField)schema[0],
    Enumerable.Range(0, 1_000_000).Select(i => DateTime.UtcNow.AddSeconds(i)).ToArray());

var column2 = new DataColumn(
    (DataField)schema[1],
    Enumerable.Range(0, 1_000_000).Select(i => i % 2 == 0 ? "on" : "off").ToArray());

var column3 = new DataColumn(
    (DataField)schema[2],
    Enumerable.Range(0, 1_000_000).Select(i => (double)i).ToArray());

Important thing to note here - columnX variables represent data in an entire column, all the values in that column independently from other columns. Values in other columns have the same order as well. So we have created three columns with data identical to the two examples above.

Time to write it down:

using(Stream fs = System.IO.File.OpenWrite("/mnt/storage/data.parquet")) {
    using(ParquetWriter writer = await ParquetWriter.CreateAsync(schema, fs)) {
        using(ParquetRowGroupWriter groupWriter = writer.CreateRowGroup()) {
            
            await groupWriter.WriteColumnAsync(column1);
            await groupWriter.WriteColumnAsync(column2);
            await groupWriter.WriteColumnAsync(column3);
        }
    }
}

What's going on?:?:

  1. We are creating output file stream. You can probably use one of the overloads in the next line though. This will be the receiver of parquet data. The stream needs to be writeable and seekable.
  2. ParquetWriter is low-level class and is a root object to start writing from. It mostly performs coordination, check summing and enveloping of other data.
  3. Row group is like a data partition inside the file. In this example we have just one, but you can create more if there are too many values that are hard to fit in computer memory.
  4. Three calls to row group writer write out the columns. Note that those are performed sequentially, and in the same order as schema defines them.

Read more on writing here which also includes guides on writing nested types such as lists, maps, and structs.

📖Reading Data

Reading data also has three different approaches, so I'm going to unwrap them here in the same order as above.

🚤Class Serialisation

Provided that you have written the data, or just have some external data with the same structure as above, you can read those by simply doing the following:

IList<Record> data = await ParquetSerializer.DeserializeAsync<Record>("/mnt/storage/data.parquet");

This will give us an array with one million class instances similar to this:

alternate text is missing from this package README image

Of course class serialisation has more to it, and you can customise it further than that.

🌛Row Based API

A read counterpart to the write example above is also a simple one-liner:

Table tbl = await Table.ReadAsync("/mnt/storage/data.parquet");

This will do the magic behind the scenes, give you table schema and rows, similar to this:

alternate text is missing from this package README image

As always, there's more to it.

⚙️Low Level API

And with low level API the reading is even more flexible:

using(Stream fs = System.IO.File.OpenRead("/mnt/storage/data.parquet")) {
    using(ParquetReader reader = await ParquetReader.CreateAsync(fs)) {
        for(int i = 0; i < reader.RowGroupCount; i++) { 
            using(ParquetRowGroupReader rowGroupReader = reader.OpenRowGroupReader(i)) {

                foreach(DataField df in reader.Schema.GetDataFields()) {
                    DataColumn columnData = await rowGroupReader.ReadColumnAsync(df);

                    // do something to the column...
                }
            }
        }
    }
}

This is what's happening:

  1. Create read stream fs.
  2. Create ParquetReader - root class for read operations.
  3. The reader has RowGroupCount property which indicates how many row groups (like partitions) the file contains.
  4. Explicitly open row group for reading.
  5. Read each DataField from the row group, in the same order as it's declared in the schema.

Hint: you can also use web based reader app to test your files, which was created using this library!

Choosing the API

If you have a choice, then the choice is easy - use Low Level API. They are the fastest and the most flexible. But what if you for some reason don't have a choice? Then think about this:

Feature 🚤Class Serialisation 🌛Table API ⚙️Low Level API
Performance high very low very high
Developer Convenience C# native feels like Excel close to Parquet internals
Row based access easy easy hard
Column based access C# native hard easy

Contributing

Any contributions are welcome, in any form. Documentation, code, tests, donations or anything else. I don't like processes so anything goes. If you happen to get interested in parquet development, there are some interesting links. The first important thing you can do is simply star ⭐ this project.

Special Thanks

Without these tools development would be really painful.

  • Visual Studio Community - free IDE from Microsoft. The best in class C# and C++ development tool. It's worth using Windows just because Visual Studio exists there.
  • JetBrains Rider - for their cross-platform C# IDE, which has some great features.
  • IntelliJ IDEA - the best Python, Scala and Java IDE.
  • LINQPad - extremely powerful C# REPL with unique visualisation features, IL decompiler, expression tree visualiser, benchmarking, charting and so on. Again it's worth having Windows just for this tool. Please support the author and purchase it.
  • Benchmarkdotnet - the best cross-platform tool that can microbenchmark C# code. This library is faster than native ones only thanks for this.
  • You starring ⭐ this project!
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 is compatible.  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 is compatible. 
.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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (20)

Showing the top 5 NuGet packages that depend on Parquet.Net:

Package Downloads
ChoETL.Parquet The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Parquet extension to Cinchoo ETL framework

Microsoft.DataPrep The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Microsoft Azure Machine Learning Data Preparation SDK.

Komodo.Core

Komodo core libraries for crawling (file, object, web, database), parsing (JSON, XML, SQL, Sqlite, HTML, text), postings (inverted index, token extraction), indexing (search), metadata generation, and integrating within your application. Komodo is an information search, metadata, storage, and retrieval platform.

DataFrame.Math

A suite of libraries to provide stats functionality in dotnet for parquet and other formats

Microsoft.ML.Parquet The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

ML.NET components for Apache Parquet support.

GitHub repositories (6)

Showing the top 5 popular GitHub repositories that depend on Parquet.Net:

Repository Stars
dotnet/machinelearning
ML.NET is an open source and cross-platform machine learning framework for .NET.
ravendb/ravendb
ACID Document Database
Cinchoo/ChoETL
ETL framework for .NET (Parser / Writer for CSV, Flat, Xml, JSON, Key-Value, Parquet, Yaml, Avro formatted files)
mukunku/ParquetViewer
Simple windows desktop application for viewing & querying Apache Parquet files
compomics/ThermoRawFileParser
Thermo RAW file parser that runs on Linux/Mac and all other platforms that support Mono
Version Downloads Last updated
4.23.4 81,008 2/2/2024
4.23.3 8,462 1/25/2024
4.23.2 3,757 1/22/2024
4.23.1 4,037 1/19/2024
4.23.0 1,980 1/18/2024
4.22.1 3,677 1/17/2024
4.22.0 21,715 1/11/2024
4.20.1 2,239 1/10/2024
4.20.0 7,255 1/8/2024
4.19.0 6,740 1/5/2024
4.18.1 4,258 12/31/2023
4.18.0 8,546 12/22/2023
4.17.0 112,774 11/14/2023
4.16.4 204,843 9/11/2023
4.16.3 24,150 9/4/2023
4.16.2 55,293 8/22/2023
4.16.1 3,994 8/21/2023
4.16.0 2,455 8/17/2023
4.15.0 100,140 6/30/2023
4.14.0 15,760 6/28/2023
4.13.0 78,659 6/20/2023
4.12.0 116,527 5/22/2023
4.11.3 7,695 5/18/2023
4.11.2 32,921 5/16/2023
4.11.1 22,383 5/10/2023
4.11.0 4,106 5/9/2023
4.10.1 26,300 5/2/2023
4.10.0 24,466 4/26/2023
4.9.2 2,372 4/25/2023
4.9.1 3,181 4/21/2023
4.9.0 1,790 4/21/2023
4.8.1 8,294 4/19/2023
4.8.0 2,297 4/18/2023
4.8.0-alpha-00 1,396 4/17/2023
4.7.1 4,635 4/14/2023
4.7.0 7,132 4/13/2023
4.6.2 51,719 3/28/2023
4.6.1 4,614 3/23/2023
4.6.0 11,735 3/21/2023
4.5.4 251,111 2/23/2023
4.5.3 11,963 2/22/2023
4.5.2 8,909 2/20/2023
4.5.1 6,640 2/14/2023
4.5.0 4,313 2/13/2023
4.4.7 10,615 2/8/2023
4.4.6 43,048 1/31/2023
4.4.5 2,619 1/30/2023
4.4.4 2,148 1/27/2023
4.4.3 2,905 1/26/2023
4.4.2 1,601 1/26/2023
4.4.1 1,833 1/25/2023
4.4.0 2,703 1/24/2023
4.3.4 1,808 1/23/2023
4.3.3 1,987 1/20/2023
4.3.2 1,857 1/19/2023
4.3.1 1,562 1/19/2023
4.3.0 2,340 1/18/2023
4.2.3 5,282 1/16/2023
4.2.2 8,432 1/11/2023
4.2.1 6,276 1/10/2023
4.2.0 1,798 1/10/2023
4.1.3 59,746 12/21/2022
4.1.2 21,060 12/1/2022
4.1.1 95,360 11/10/2022
4.1.0 135,397 10/13/2022
4.0.2 9,408 10/12/2022
4.0.1 15,789 10/11/2022
4.0.0 48,641 9/22/2022
3.10.0 192,264 9/20/2022
3.9.1 1,294,959 10/14/2021
3.9.0 331,917 6/25/2021
3.8.6 379,242 3/5/2021
3.8.5 24,097 2/23/2021
3.8.4 229,863 12/13/2020
3.8.3 2,272 12/10/2020
3.8.2 1,799 12/10/2020
3.8.1 30,207 11/6/2020
3.8.0 3,775 11/6/2020
3.7.7 308,428 6/25/2020
3.7.6 23,052 6/16/2020
3.7.5 13,988 6/8/2020
3.7.4 156,738 5/19/2020
3.7.2 3,611 5/18/2020
3.7.1 48,415 4/21/2020
3.7.0 45,901 4/19/2020
3.6.0 4,830,556 1/23/2020
3.5.3 12,248 1/8/2020
3.5.2 3,386 1/3/2020
3.5.1 2,064 12/31/2019
3.5.0 7,756 12/18/2019
3.4.3 6,923 12/16/2019
3.4.2 3,552 12/13/2019
3.4.1 2,019 12/11/2019
3.4.0 2,613 12/11/2019
3.3.11 6,693 12/1/2019
3.3.10 37,819 11/6/2019
3.3.9 183,506 8/15/2019
3.3.8 8,610 8/1/2019
3.3.7 2,035 8/1/2019
3.3.6 2,130 7/31/2019
3.3.5 29,824 7/5/2019
3.3.4 163,600 3/11/2019
3.3.3 20,032 2/1/2019
3.3.2 25,327 1/21/2019
3.3.1 4,407 1/14/2019
3.3.0 3,527 1/11/2019
3.2.6 2,706 1/11/2019
3.2.5 4,415 1/3/2019
3.2.4 8,668 11/21/2018
3.2.3 38,372 11/7/2018
3.2.2 5,219 10/30/2018
3.2.1 2,319 10/30/2018
3.2.0 2,966 10/24/2018
3.1.4 2,344 10/15/2018
3.1.3 2,231 10/15/2018
3.1.2 37,244 10/11/2018
3.1.1 2,696 10/4/2018
3.1.0 2,577 10/3/2018
3.1.0-preview-390 1,934 10/3/2018
3.1.0-preview-373 2,214 10/2/2018
3.0.5 8,771 8/13/2018
3.0.4 2,393 7/25/2018
3.0.3 2,219 7/25/2018
3.0.2 2,678 7/24/2018
3.0.1 2,218 7/24/2018
3.0.0 3,123 7/19/2018
2.1.4 85,055 6/7/2018
2.1.3 256,617 3/30/2018
2.1.2 363,620 1/10/2018
2.1.1 89,667 12/1/2017
2.1.0 2,558 11/29/2017
2.0.1 2,370 11/27/2017
2.0.0 3,218 11/27/2017
1.5.1 3,112 11/14/2017
1.4.0 6,453 10/23/2017
1.3.0 5,176 9/12/2017
1.2.139 3,303 9/6/2017
1.1.128 3,116 8/15/2017
1.0.114 2,532 7/31/2017