Class VacuumJob

Namespace

The.Web.SQL

Assembly

Instagile.Web.Client.dll

Deletes generated data that has outlived its utility: un-finalised frozen query results, audit records, job runs, and any application entities listed in CustomTargets.

public class VacuumJob : ScheduledJobBase, IHostedService, IDisposable

Inheritance

object

BackgroundService

JobBase

ScheduledJobBase

VacuumJob

Implements

IHostedService

IDisposable

Inherited Members

ScheduledJobBase.Schedule

ScheduledJobBase.Budget

ScheduledJobBase.IsOverBudget()

ScheduledJobBase.ExecuteAsync(CancellationToken)

ScheduledJobBase.Reschedule(Schedule)

ScheduledJobBase.Dispose()

JobBase.Logger

JobBase.Name

JobBase.IsJobRunRecordingEnabled

JobBase.JobRunProgressUpdateInterval

JobBase.RunningSince

JobBase.RunningUntil

JobBase.RunStatus

JobBase.CancelRun()

JobBase.CanExecute

JobBase.ExecuteOnceAsync(Identity, IPrincipal, CancellationToken)

JobBase.ExecuteOnceAsync(Identity, CancellationToken)

JobBase.ExecuteOnceAsync(IPrincipal, CancellationToken)

JobBase.ExecuteOnceAsync(CancellationToken)

JobBase.ExecuteOnceAsync(IProgress<Status>, IPrincipal, CancellationToken)

JobBase.ExecuteOnceAsync(IProgress<Status>, CancellationToken)

BackgroundService.StartAsync(CancellationToken)

BackgroundService.StopAsync(CancellationToken)

BackgroundService.ExecuteTask

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Rows are deleted in pages so that large backlogs can be cleared out over time; a run stops when its time Budget is spent and resumes on the next Schedule.

Constructors

VacuumJob(JobParameters<VacuumJob>, IOptions<VacuumOptions>, IDatabase, IDMLDialect, EntityMetadataDictionary)

public VacuumJob(JobParameters<VacuumJob> parameters, IOptions<VacuumOptions> options, IDatabase database, IDMLDialect dml, EntityMetadataDictionary metadata)

Parameters

parameters JobParameters<VacuumJob>

options IOptions<VacuumOptions>

database IDatabase

dml IDMLDialect

metadata EntityMetadataDictionary

Methods

DescribeJobParameters()

Creates a debug view of the data on which the job is currently operating.

protected override string DescribeJobParameters()

Returns

string

ExecuteJobAsync(IServices, IPrincipal, IProgress<Status>, CancellationToken)

Implements the actual job logic.

protected override Task ExecuteJobAsync(IServices services, IPrincipal principal, IProgress<Status> progress, CancellationToken cancellationToken)

Parameters

services IServices

principal IPrincipal

progress IProgress<Status>

cancellationToken CancellationToken

Returns

Task