Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved readme code examples readability #64

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 37 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
##C# project for reading and writing CSVs
## DataTable

Fast streaming CSV parser. Libraries for easy reading, writing, and manipulation of CSV files. Is able to handle:

Expand All @@ -12,52 +12,60 @@ Fast streaming CSV parser. Libraries for easy reading, writing, and manipulation

It's an easier data table than `System.Data.DataTable`.

<hr>

The following nuget packages are available:

* [CsvTools](https://www.nuget.org/packages/CsvTools) - the base library
* [CsvTools.Excel](https://www.nuget.org/packages/CsvTools.Excel) - dependency on CsvTools and the OpenXml SDK

<hr>

A few quick examples:

> **Download as CsvTools from Nuget to include in your C# project**:

using DataAccess;
// See methods on DataTable.New for loading a DataTable.
var dt = DataTable.New.ReadLazy(filename); // Fast streaming load a CSV from disk.
```cs
using DataAccess; // See methods on DataTable.New for loading a DataTable.
var dt = DataTable.New.ReadLazy(filename); // Fast streaming load a CSV from disk.
```

> **Get a mutable datatable**:
```cs
MutableDataTable dt = DataTable.New.ReadCsv(filename); // load entire CSV into memory for mutation
int totalRows = dt.NumRows;

MutableDataTable dt = DataTable.New.ReadCsv(filename); // load entire CSV into memory for mutation
int totalRows = dt.NumRows;
// Includes mutation methods like:
// CreateColumn, ReorderColumn, KeepColumns, RenameColumn,
// GetRow(int rowIndex), KeepRows(Func<T, bool> predicate)

// Includes mutation methods like:
// CreateColumn, ReorderColumn, KeepColumns, RenameColumn,
// GetRow(int rowIndex), KeepRows(Func<T, bool> predicate)

dt.SaveCsv(filename); // write back out
dt.SaveCsv(filename); // write back out
```

> **Linq against the rows**:

var y = from row in dt.Rows where row["N"] == "3" select row["NSquared"];
```cs
var y = from row in dt.Rows where row["N"] == "3" select row["NSquared"];
```

> **Linq with strongly-typed parsing, using `RowAs<T>()` method**:

class Entry
{
public int N { get; set; }
public int NSquared { get; set; }
}
int y = (from row in dt.RowsAs<Entry>() where row.N == 3 select row.NSquared).First();
```
class Entry
{
public int N { get; set; }
public int NSquared { get; set; }
}
int y = (from row in dt.RowsAs<Entry>() where row.N == 3 select row.NSquared).First();
```

> **Create a table around an `IEnumerable` and then save back as a CSV**:

var x = from i in Enumerable.Range(1, 5) select new { N = i, NSquared = i * i };
DataTable dt = DataTable.New.FromEnumerable(x);
dt.SaveToStream(Console.Out); // write back out as a CSV
```cs
var x = from i in Enumerable.Range(1, 5) select new { N = i, NSquared = i * i };
DataTable dt = DataTable.New.FromEnumerable(x);
dt.SaveToStream(Console.Out); // write back out as a CSV
```

> **Also includes support for reading an excel file (.xlsx)**:

var dt = DataTable.New.ReadExcel(@"c:\temp\foo.xlsx");
var names = from row in dt.Rows where int.Parse(row["age"]) > 10 select row["Name"];
```cs
var dt = DataTable.New.ReadExcel(@"c:\temp\foo.xlsx");
var names = from row in dt.Rows where int.Parse(row["age"]) > 10 select row["Name"];
```
[See here](http://blogs.msdn.com/b/jmstall/archive/2012/04/24/excel-on-azure.aspx) for more about reading excel.