Class JsonStringSinkExtension

Namespace

Datafication.Sinks.Connectors.JsonConnector

Assembly

Datafication.JsonConnector.dll

Provides extension methods for converting DataBlock instances to JSON string format.

public static class JsonStringSinkExtension

Inheritance

object

JsonStringSinkExtension

Examples

var data = await DataBlock.Connector.LoadJsonAsync("data/employees.json");
var jsonString = await data.JsonStringSinkAsync();
await File.WriteAllTextAsync("output/employees.json", jsonString);

Remarks

These extension methods provide a convenient shorthand API for serializing DataBlocks to JSON. Single-record DataBlocks produce a JSON object, while multi-record DataBlocks produce a JSON array.

Methods

JsonStringSink(DataBlock)

Synchronously converts the DataBlock to a formatted JSON string.

public static string JsonStringSink(this DataBlock dataBlock)

Parameters

dataBlock DataBlock

The DataBlock to convert to JSON.

Returns

string

The JSON string representation of the DataBlock.

Examples

var employees = DataBlock.Connector.LoadJson("data/employees.json");
var jsonOutput = employees.JsonStringSink();
File.WriteAllText("output/employees.json", jsonOutput);

Remarks

If the DataBlock contains a single record, a JSON object is returned. If it contains multiple records, a JSON array of objects is returned. Nested DataBlocks are converted to nested JSON objects.

JsonStringSinkAsync(DataBlock)

Asynchronously converts the DataBlock to a formatted JSON string.

public static Task<string> JsonStringSinkAsync(this DataBlock dataBlock)

Parameters

dataBlock DataBlock

The DataBlock to convert to JSON.

Returns

Task<string>

A task that represents the asynchronous operation. The task result contains the JSON string representation.

Examples

var employees = await DataBlock.Connector.LoadJsonAsync("data/employees.json");
var jsonOutput = await employees.JsonStringSinkAsync();
Console.WriteLine(jsonOutput);

Remarks

If the DataBlock contains a single record, a JSON object is returned. If it contains multiple records, a JSON array of objects is returned. Nested DataBlocks are converted to nested JSON objects.