tamaki.mes.backup.compare.createSummaryDataSet

Description

Builds a summary dataset showing how many entities were removed, added, and updated for each entity type. Entity types that were entirely removed or added get a row whose Notes column reads File type removed or File type added; entity types that changed get rows with the corresponding counts (only when there is at least one change).

Raises a TypeError if the arguments are not of the expected types.

Syntax

tamaki.mes.backup.compare.createSummaryDataSet(removedEntityTypes, addedEntityTypes, updatedEntityTypes)

Parameters

Parameter	Type	Nullable	Description
removedEntityTypes	List	False	The removed-entity-types list returned by compareEntityLists.
addedEntityTypes	List	False	The added-entity-types list returned by compareEntityLists.
updatedEntityTypes	Dict	False	The updated-entity-types dictionary returned by compareEntityLists.

Returns

A Dataset with the columns Entity, Removed, Added, Updated, and Notes. One row per entity type.

Code Examples

removedTypes, addedTypes, updatedTypes = tamaki.mes.backup.compare.compareEntityLists(oldData, newData)
summary = tamaki.mes.backup.compare.createSummaryDataSet(removedTypes, addedTypes, updatedTypes)
self.getChild("SummaryTable").props.data = summary