C#

Writing CSV files using CSVHelper package (C#, IEnumerable)

January 9, 2014 by Carlos Ferreira 19 Comments

This is a follow-up on my post on how to read a CSV file using Josh Close’s CsvHelper. CsvHelper is a fast and flexible .NET library for reading and writing CSV files.

Below I will now show how to write CSV files using CsvHelper. The example will actually be reading a CSV file and then writing the contents of that CSV into another but doing it three times. Each time we do this we will use another method (WriteRecords for all records at once, WriteRecord for writing one record, and WriteField for writing one field).

Our sample input CSV file will look like the following.

CommonName,FormalName,TelephoneCode,CountryCode

Argentina,Argentine Republic,54,ARG
Armenia,Republic of Armenia,374,ARM
Australia,Commonwealth of Australia,61,AUS
Austria,Republic of Austria,43,AUT
“Bahamas, The”,Commonwealth of The Bahamas,-241,BHS
Bangladesh,People’s Republic of Bangladesh,880,BGD

Note this CSV file is a simpler file based on the file which is located here.

The first thing to do is to Install CsvHelper. To do this run the following command in the Package Manager Console:

Install-Package CsvHelper

1	Install-Package CsvHelper

Now add CsvHelper to the program by adding:

using CsvHelper;

1	using CsvHelper;

The next step is to create a class which has properties with the same name of the column headings found in the csv file. Below you will find an example of a class which does this:

 class DataRecord
    {
        //Should have properties which correspond to the Column Names in the file
        //i.e. CommonName,FormalName,TelephoneCode,CountryCode
        public String CommonName { get; set; }
        public String FormalName { get; set; }
        public String TelephoneCode { get; set; }
        public String CountryCode { get; set; }
    }

class DataRecord

{

//Should have properties which correspond to the Column Names in the file

//i.e. CommonName,FormalName,TelephoneCode,CountryCode

public String CommonName { get; set; }

public String FormalName { get; set; }

public String TelephoneCode { get; set; }

public String CountryCode { get; set; }

}

Finally create an instance of CSVReader and CSVWriter and invoke the GetRecords method using the DataRecord class to read the CSV file.

var reader = new CsvReader(sr); 
var writer = new CsvWriter(sw);

IEnumerable records = reader.GetRecords<DataRecord>().ToList();

var reader = new CsvReader(sr);

var writer = new CsvWriter(sw);

IEnumerable records = reader.GetRecords().ToList();

Once we have the completed we are now ready to write the file out. We first will write the entire file out by using the WriteRecords method. Note this method will also normally write the header out automatically.

writer.WriteRecords(records);

1	writer.WriteRecords(records);

We then write the records out again but this time we will do so by iterating thru the records collection and writing the entire record using the WriteRecord method and also by writing the fields of the record using the WriteField method.

  foreach (DataRecord record in records)
                    { 
                       //Write entire current record
                       writer.WriteRecord(record);

                       //write record field by field
                       writer.WriteField(record.CommonName);
                       writer.WriteField(record.FormalName);
                       writer.WriteField(record.TelephoneCode);
                       writer.WriteField(record.CountryCode);
                       //ensure you write end of record when you are using WriteField method
                       writer.NextRecord();
                    }

foreach (DataRecord record in records)

{

//Write entire current record

writer.WriteRecord(record);

//write record field by field

writer.WriteField(record.CommonName);

writer.WriteField(record.FormalName);

writer.WriteField(record.TelephoneCode);

writer.WriteField(record.CountryCode);

//ensure you write end of record when you are using WriteField method

writer.NextRecord();

}

One point to note that if you were writing a file using the WriteRecord or WriteField methods, you will not get a header record in the file. If you wish to have a header record us the WriteHeader method (example is commented out in final code).

A completed example can be found below:

using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using CsvHelper;

namespace CSVHelperWriteSample
{
    class Program
    {
        static void Main(string[] args)
        {
            using (var sr = new StreamReader(@"countrylist.csv"))
            {
                using (var sw = new StreamWriter(@"countrylistoutput.csv"))
                {
                    var reader = new CsvReader(sr); 
                    var writer = new CsvWriter(sw);

                    //CSVReader will now read the whole file into an enumerable
                    IEnumerable records = reader.GetRecords<DataRecord>().ToList();

                    //Write the entire contents of the CSV file into another
                    writer.WriteRecords(records);

                    //Now we will write the data into the same output file but will do it 
                    //Using two methods.  The first is writing the entire record.  The second
                    //method writes individual fields.  Note you must call NextRecord method after 
                    //using Writefield to terminate the record.

                    //Note that WriteRecords will write a header record for you automatically.  If you 
                    //are not using the WriteRecords method and you want to a header, you must call the 
                    //Writeheader method like the following:
                    //
                    //writer.WriteHeader<DataRecord>();
                    //
                    //Do not use WriteHeader as WriteRecords will have done that already.

                    foreach (DataRecord record in records)
                    { 
                       //Write entire current record
                       writer.WriteRecord(record);

                       //write record field by field
                       writer.WriteField(record.CommonName);
                       writer.WriteField(record.FormalName);
                       writer.WriteField(record.TelephoneCode);
                       writer.WriteField(record.CountryCode);
                       //ensure you write end of record when you are using WriteField method
                       writer.NextRecord();
                    }
                }
            }
        }
    }
}

using System;

using System.Collections;

using System.Collections.Generic;

using System.Diagnostics;

using System.IO;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using CsvHelper;

namespace CSVHelperWriteSample

{

class Program

{

static void Main(string[] args)

{

using (var sr = new StreamReader(@"countrylist.csv"))

{

using (var sw = new StreamWriter(@"countrylistoutput.csv"))

{

var reader = new CsvReader(sr);

var writer = new CsvWriter(sw);

//CSVReader will now read the whole file into an enumerable

IEnumerable records = reader.GetRecords().ToList();

//Write the entire contents of the CSV file into another

writer.WriteRecords(records);

//Now we will write the data into the same output file but will do it

//Using two methods. The first is writing the entire record. The second

//method writes individual fields. Note you must call NextRecord method after

//using Writefield to terminate the record.

//Note that WriteRecords will write a header record for you automatically. If you

//are not using the WriteRecords method and you want to a header, you must call the

//Writeheader method like the following:

//writer.WriteHeader();

//Do not use WriteHeader as WriteRecords will have done that already.

foreach (DataRecord record in records)

{

//Write entire current record

writer.WriteRecord(record);

//write record field by field

writer.WriteField(record.CommonName);

writer.WriteField(record.FormalName);

writer.WriteField(record.TelephoneCode);

writer.WriteField(record.CountryCode);

//ensure you write end of record when you are using WriteField method

writer.NextRecord();

}

You can download this sample code with CsvHelper and CSV file here:

Filed Under: C#, Technology Tagged With: C#, CSV, CSVHelper, IEnumerable, writing

Reading CSV files using CSVHelper package (C#, IEnumerable)

November 29, 2013 by Carlos Ferreira 19 Comments

I have come across many times the need to incorporate the reading of CSV files in an application. Below I will show how to use Josh Close’s CsvHelper to import a CSV file which looks like the following (file will be included below).

CommonName,FormalName,TelephoneCode,CountryCode
Argentina,Argentine Republic,54,ARG
Armenia,Republic of Armenia,374,ARM
Australia,Commonwealth of Australia,61,AUS
Austria,Republic of Austria,43,AUT
“Bahamas, The”,Commonwealth of The Bahamas,-241,BHS
Bangladesh,People’s Republic of Bangladesh,880,BGD

Note this CSV file is a simpler file based on the file which is located here.

The first thing to do is to Install CsvHelper. To do this run the following command in the Package Manager Console:

Install-Package CsvHelper

1	Install-Package CsvHelper

Now add CsvHelper to the program by adding:

using CsvHelper;

1	using CsvHelper;

The next step is to create a class which has properties with the same name of the column headings found in the csv file. Below you will find an example of a class which does this:

 class DataRecord
    {
        //Should have properties which correspond to the Column Names in the file
        //i.e. CommonName,FormalName,TelephoneCode,CountryCode
        public String CommonName { get; set; }
        public String FormalName { get; set; }
        public String TelephoneCode { get; set; }
        public String CountryCode { get; set; }
    }

class DataRecord

{

//Should have properties which correspond to the Column Names in the file

//i.e. CommonName,FormalName,TelephoneCode,CountryCode

public String CommonName { get; set; }

public String FormalName { get; set; }

public String TelephoneCode { get; set; }

public String CountryCode { get; set; }

}

Finally create an instance of CSVReader and invoke the GetRecords method using the DataRecord class. Below you will find an example of this:

var reader = new CsvReader(sr);
IEnumerable<DataRecord> records = reader.GetRecords<DataRecord>();

1 2	var reader = new CsvReader(sr); IEnumerable records = reader.GetRecords();

An completed example can be found below:

using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using CsvHelper;

namespace CSVHelperReadSample
{
    internal class Program
    {
        private static void Main(string[] args)
        {
            using (var sr = new StreamReader(@"countrylist.csv"))
            {
                var reader = new CsvReader(sr);

                //CSVReader will now read the whole file into an enumerable
                IEnumerable<DataRecord> records = reader.GetRecords<DataRecord>();

                //First 5 records in CSV file will be printed to the Output Window
                foreach (DataRecord record in records.Take(5)) 
                {
                    Debug.Print("{0} {1}, {2}, {3}", record.CommonName, record.CountryCode, record.FormalName,
                        record.TelephoneCode);
                }
            }
        }
    }
}

using System.Collections.Generic;

using System.Diagnostics;

using System.IO;

using System.Linq;

using CsvHelper;

namespace CSVHelperReadSample

{

internal class Program

{

private static void Main(string[] args)

{

using (var sr = new StreamReader(@"countrylist.csv"))

{

var reader = new CsvReader(sr);

//CSVReader will now read the whole file into an enumerable

IEnumerable records = reader.GetRecords();

//First 5 records in CSV file will be printed to the Output Window

foreach (DataRecord record in records.Take(5))

{

Debug.Print("{0} {1}, {2}, {3}", record.CommonName, record.CountryCode, record.FormalName,

record.TelephoneCode);

}

You can download this sample code with CsvHelper and CSV file here: CVSHelperReadSample

Filed Under: C#, Technology Tagged With: CSV C# CSVHelper Linq IEnumerable

C# Methods with Unlimited Parameters

January 11, 2013 by Carlos Ferreira 2 Comments

To create a method that can take unlimited parameters, utilize the params keyword in the method declaration. This allows you to specify a method parameter that take an argument where the number of arguments is variable. You are not allowed to have any other method parameters declared after a params method parameter.

MSDN resource: params

Example:

 static void Main(string[] args)
        {
            AddNumbers(12, 14, 15);
        }

 public static void AddNumbers(params int[] numbers)
        {
            int result = 0;
            for (int i = 0; i &lt; numbers.Length; i++)
                result+= numbers[i];
            Console.WriteLine(result);
        }

static void Main(string[] args)

{

AddNumbers(12, 14, 15);

}

public static void AddNumbers(params int[] numbers)

{

int result = 0;

for (int i = 0; i < numbers.Length; i++)

result+= numbers[i];

Console.WriteLine(result);

}

PSGMUMGGBJAR

Filed Under: C#, Technology, Uncategorized Tagged With: .Net, C Sharp, C#, Methods, parameters, unlimited

Writing CSV files using CSVHelper package (C#, IEnumerable)

Like this:

Reading CSV files using CSVHelper package (C#, IEnumerable)

Like this:

C# Methods with Unlimited Parameters

Like this:

Carlos Ferreira

Advertisement

Articles

Archives

Writing CSV files using CSVHelper package (C#, IEnumerable)

Share this:

Like this:

Reading CSV files using CSVHelper package (C#, IEnumerable)

Share this:

Like this:

C# Methods with Unlimited Parameters

Share this:

Like this:

Carlos Ferreira

Advertisement

Articles

Archives