The VersaTul Collection Streamers provides functionality that enables developers to quickly convert a collection of objects in memory into a data-reader that can be used for Bulk inserting data into a SQL Database, or be used to generate flat files. Developers can use the streamers to: 1. Convert a Collection to a Data-Reader. 2. Convert from a Data-Reader to other file formats such as CSV, TAB or Json. 3. Compress converted data into Zip files. 4. Transport the converted data via e-mail. The Streamers project also works with Display Attributes which is used to manipulate the properties on the objects in the collection such as formatting the data or renaming the property with a desired display name.
Get Started
$ dotnet add package VersaTul.Collection.StreamersReadme
VersaTul Collection Streamers
VersaTul Collection Streamers is a library that provides functionality to quickly convert a collection of objects in memory into a data-reader that can be used for bulk inserting data into a SQL Database, or be used to generate flat files. It also works with display attributes to manipulate the properties on the objects in the collection.
Features
- Convert from a data-reader to other file formats such as CSV, TAB or JSON
- Use display attributes to format or rename the properties
- Send streamers via email attachments
- Save streamers to physical files on disk
- Compress streamers for transport over the network
- Convert any collection to an IDataReader
Installation
To use VersaTul Collection Streamers, first install it using nuget:
PM> NuGet\Install-Package VersaTul.Collection.Streamers -Version latest
Usage
The library provides several interfaces and classes to create and manipulate streamers. Here are some of the main ones:
IStreamer: A base interface that represents the data contained in the stream and the functionality that can be applied to the data.IStreamCreator: A base interface that represents the functionality for creating streamers.ICsvStreamer: A specific stream type interface that represents the functionality for creating csv streamers.ITabStreamer: A specific stream type interface that represents the functionality for creating tab streamers.IJsonStreamer: A specific stream type interface that represents the functionality for creating json streamers.BaseStreamer: A concrete implementation of theIStreamerandIStreamCreatorinterfaces. Providing common functionality for all streamers.CsvStreamer: A concrete implementation of theICsvStreamerinterface.JsonStreamer: A concrete implementation of theIJsonStreamerinterface.TabStreamer: A concrete implementation of theITabStreamerinterface.IMailTransporter: Represents a set of functionality to send streamers via email attachments.IStreamFileConverter: Represent a set of conversion techniques that can be applied to a streamer.ICompressTransport: Represents a set of functionality to reduce streamers for transport over the network.CollectionReaderExtensions: Contains theToReadermethod that can be used to convert any collection to anIDataReader.
Here is a simple example of using the CsvStreamer to create a csv file from a collection of Person objects:
using VersaTul.Collection.Streamers;
using VersaTul.Collection.Streamers.Compressions;
using VersaTul.Collection.Streamers.Converters;
using VersaTul.Compression;
using VersaTul.Handler.File;
using VersaTul.Object.Converters;
using VersaTul.Utilities;
namespace CollectionStreamers
{
class Program
{
static void Main(string[] args)
{
// Create N number of data model
var people = GetPeople(1000);
// Create Needed Instances
var directoryWrapper = new DirectoryWrapper();
var utility = new CommonUtility();
var flattener = new Flattener();
var zipper = new Zipper(new Archiver());
var compressor = new Compressor(zipper);
var fileUtil = new FileUtility(directoryWrapper, directoryWrapper);
var fileConvert = new FileConverter(fileUtil, compressor);
// Creating the CsvStreamer Instance
var csvStreamer = new CsvStreamer(utility, fileUtil, flattener);
// Create CSV from given people collection
var csv = csvStreamer.Create(people, "people");
// Save csv to Path
fileConvert.Save(csv, "C:\\your\\file\\path\\here\\", false);
}
// Helper method for generating list of data model.
private static IEnumerable<Person> GetPeople(int amount)
{
var people = new List<Person>(amount);
var names = new[] { "John Doe", "Jane Smith", "Susan Williams", "Mike Burger", "Joe Williams", "Timmy Smith", "Lisa Ray", "Stanley Smith", "Sam Jones", };
for (int i = 0; i < amount; i++)
{
people.Add(new Person
{
Age = i + 10,
Name = CommonUtil.RandomSampler(names),
AccountBalance = (100.99m * i),
BestFriend = CommonUtil.RandomSampler(people)
});
}
return people;
}
}
// Data Model
public class Person
{
public int Age { get; set; }
public string? Name { get; set; }
public decimal AccountBalance { get; set; }
public IEnumerable<Person>? Friends { get; set; }
public Person? BestFriend { get; set; }
}
// Helper class
public static class CommonUtil
{
public static T? RandomSampler<T>(IList<T> source)
{
var max = source.Count;
if (max == 0) return default;
var rand = new Random();
var position = rand.Next(max);
return source[position];
}
}
}
License
This project is licensed under the MIT License - see the LICENSE file for details.