Getting Started

This guide will help you quickly get up and running with Wolfgang.Etl.Xml.

Prerequisites

  • .NET 8.0 SDK or later (also supports .NET Framework 4.6.2+ and .NET Standard 2.0)
  • (Optional) A logging provider (e.g. Microsoft.Extensions.Logging)

Installation

Via .NET CLI

dotnet add package Wolfgang.Etl.Xml

Via Package Manager Console

Install-Package Wolfgang.Etl.Xml

Quick Start

Extracting from XML

Read items from an XML stream and pipe them through a transformer into a loader:

using Wolfgang.Etl.TestKit;
using Wolfgang.Etl.Xml;

// XmlSingleStreamExtractor reads items from a single XML document
// ILogger is optional — omit for no logging, or pass settings + logger for full control
var extractor = new XmlSingleStreamExtractor<Person>(xmlStream);

// Use TestKit placeholders for the rest of the pipeline
var transformer = new TestTransformer<Person>();
var loader = new TestLoader<Person>(collectItems: true);

await loader.LoadAsync(transformer.TransformAsync(extractor.ExtractAsync()));

var items = loader.GetCollectedItems();

Loading to XML

Pipe items from any source through a transformer and write them to an XML stream:

using Wolfgang.Etl.TestKit;
using Wolfgang.Etl.Xml;

// Use TestKit as the data source
var extractor = new TestExtractor<Person>(people);
var transformer = new TestTransformer<Person>();

// XmlSingleStreamLoader writes items to a single XML document
var loader = new XmlSingleStreamLoader<Person>(outputStream);

await loader.LoadAsync(transformer.TransformAsync(extractor.ExtractAsync()));

Multi-stream (one item per file)

For scenarios where each record lives in its own XML file:

// Extract from multiple XML files
var extractor = new XmlMultiStreamExtractor<Person>(xmlStreams);

// Load to individual XML files via a stream factory
var loader = new XmlMultiStreamLoader<Person>
(
    person => File.Create($"{person.Id}.xml")
);

Next Steps

Additional Resources

Edit this page