MPOSAirDataCleanUp 3.0.0

MPOSAirDataCleanUp

MPOSAirDataCleanUp is a database table rows clean up library. It's usage it's enforced with the methods described bellow. However, the explanation can be simplified:

• Specify the DbContext type to be used.
• Add 1 or more SQL Delete from statements in a base64 encoded format
• Add a start time.
• Add a clean up period.
• Optional: add restrictions

Installation

To install the package, simply search the MPOSAirDataCleanUp package on nuget.org and install it in the same project where Entity Framework Core resides.

The following example illustrates the usage within a Web API project.

1. ServiceCollectionsExtensions Define the clean up services like so:

public static void AddDataCleanUp(this IServiceCollection services)
{
	services.AddDataCleanUpServices();

	services.AddSingleton<ICleanUpService, CleanUpService<VoucherDbContext>>();
}

2. ApplicationBuilderExtensions The following method configures the clean up service:

public static void ConfigureDataCleanUp(this IApplicationBuilder app)
{
	var cleanUpService = (ICleanUpService)app.ApplicationServices.GetService(typeof(ICleanUpService));

	var service = cleanUpService = service.WithContext(typeof(InvoiceDbContext))
                                            .WithSqlDeleteStatements(deleteStatements)
                                            .WithPeriod(CleanUpPeriod.Daily)
                                            .WithUtcStartTime(cleanUpHour)
                                            .WithVacuum()
                                            .WithNoRestrictions();
	Task.Run(async () => await service.InitializeCleanUp(new System.Threading.CancellationToken()));
}

Then, in StartUp.cs, you have the following:

1. ConfigureServices

         services.AddDataCleanUp();

2. Configure

          app.ConfigureDataCleanUp();

Dependencies

A new table will need to be created in your database. This table is used by MPOSAirDataCleanUp to keep track of cleaned entities. To this end, the DataCleaningEntityTypeConfiguration file already exists in the package. Simply add it to your Entity Framework configuration. Example:

 protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.ApplyConfiguration(new DataCleaningEntityTypeConfiguration());
        }

It's ok if you are not using Configuration files. When overriding OnModelCreating just configure the DataCleaning entity type.

Remember to add the migration when using Code First approach.

Method Description

Currently, the CleanUpService supports the following methods. Their usage is strictly enforced. Example of usage in an appsettings.json file:

  "CLEANUPPERIOD": 0,
  "CLEANUPSTARTTIME": "02:00:00",
  "CLEANUPDELETESTATEMENTS": [
    "ZGVsZXRlIGZyb20gIkludm9pY2VzIiBpIHdoZXJlIGkuIkhlYWRlcl9Eb2N1bWVudFR5cGUiID0gJ1ZPSUQnIGFuZCBpLiJDcmVhdGVkRGF0ZSIgPCBub3coKSAtIGludGVydmFsJzMwIGRheXMn",
    "ZGVsZXRlIGZyb20gIkludm9pY2VzIiBpIHdoZXJlIGkuIkNyZWF0ZWREYXRlIiA8IG5vdygpIC0gaW50ZXJ2YWwnMzAgZGF5cyc=",
    "ZGVsZXRlIGZyb20gIkludm9pY2VzIiBpIHVzaW5nICJPcGVuSW52b2ljZURldGFpbHMiIG9pZDIgd2hlcmUgaS4iSWQiID0gb2lkMi4iSW52b2ljZUlkIiBhbmQgb2lkMi4iU3RhdHVzIiA9ICdPcGVuJyBhbmQgb2lkMi4iQ3JlYXRlZERhdGUiIDwgbm93KCkgLSBpbnRlcnZhbCcxIGRheXMn",
    "ZGVsZXRlIGZyb20gIk9wZW5JbnZvaWNlRGV0YWlscyIgb2lkMiB3aGVyZSBvaWQyLiJTdGF0dXMiID0gJ09wZW4nIGFuZCBvaWQyLiJDcmVhdGVkRGF0ZSIgPCBub3coKSAtIGludGVydmFsJzEgZGF5cyc="
  ]

CleanUpPeriod Options

• Daily - if the set time is before the current UTC time, then the next clean up will take place tomorrow.
• Weekly - every Sunday
• Monthly - the 1st of every month
• Yearly - the last day of the year

CAUTION

Any and all exceptions are captured and shown into the console output of the application that uses the nuget.

Make sure the table DataCleanings exists, otherwise, the nuget throws the error into the console and the cleaning will not take place.