Net4x.PropertyBagLibrary 1.9.9.26247

PropertyBagLibrary

Helpers to convert optional DataTable columns into JSON property bags and utilities to temporarily patch/restore primary keys when saving datasets via IDapperContext.

Purpose

• Convert non-mandatory columns of a DataTable into a single JSON column (property bag) to simplify storage or transfer while keeping required columns as explicit fields.
• Provide utilities to merge/enrich property bags with values from loaded rows and to patch primary keys (generated vs historical IDs) when persisting data via database contexts.

Main functionality

• DataTableJsonExtension.ConvertNonMandatoryColumnsToPropertyBag(this DataTable dataTable, string[] mandatoryFields, string propertyBagColumnName, params ColumnDefinition[] additionalColumnsToAdd)

  • Moves every column not listed in mandatoryFields into a JSON string stored in propertyBagColumnName for each row.
  • Adds implicit mandatory columns if requested and can preserve or merge existing property-bag JSON values.

• PropertyBagHelper extensions

  • Methods to enrich consolidated rows with values from loaded rows, manage property-bag dictionaries, and save patched dictionaries back into the property bag column.
  • Uses Newtonsoft.Json for serialization and CoreLibrary.Utility.Conversion helpers for conversions.

• PrimaryKeyPatchRestore extensions (requires IDapperContext)

  • PutGeneratedPrimaryKeyAsync / PutHistoricalPrimaryKeyAsync helpers that iterate DataTable or DataSet rows and call a ProcessColumnDelegate to map or patch primary key values after insert operations.
  • Useful when data save operations return generated IDs that need to be propagated back into in-memory tables or when historical IDs must be substituted.

Typical usage

• Convert optional columns into a property bag before saving or serializing:

var mandatory = new[] { "Id", "Name" };
var ok = dataTable.ConvertNonMandatoryColumnsToPropertyBag(mandatory, "PropertyBag");

• Merge values from a loaded entity into a consolidated row and update its property bag:

var modified = consolidatedRow.EnrichConsolidatedTableColumnWithValuesFromLoadedTable(
    dateTime, column, loadedRow, "PropertyBag", "ModifiedDate");

• Patch primary keys after saving with IDapperContext:

// processColumn is a delegate that applies the returned generated id into the DataRow
await dapperContext.PutGeneratedPrimaryKeyAsync(dataTable, valueTuples, "GeneratedId", "HistoricalId", processColumn);

Notes and recommendations

• Serialization uses Newtonsoft.Json so ensure the package is available for your target framework.
• The property bag column is stored as a JSON string; consumers must deserialize it to access contained key/value pairs.
• The library operates in-memory on DataTable/DataSet objects; it is not optimized for extremely large datasets. For large volumes prefer streaming or database-side approaches.
• Primary key patching helpers are asynchronous to accommodate database roundtrips; provide a ProcessColumnDelegate implementation that performs any required ID mapping.

Dependencies

• Newtonsoft.Json for JSON serialization.
• DapperLibrary.Data and DapperLibrary.DbContexts for integration helpers.
• CoreLibrary utilities for conversions and logging.

License / Contributing

See repository root for license and contribution guidelines.