Skip to main content

CkMigrationResult

Namespace: Meshmakers.Octo.Runtime.Contracts.CkModelMigrations

Result of a CK model migration execution

public class CkMigrationResult

Inheritance ObjectCkMigrationResult

Properties

Success

Whether the migration completed successfully

public bool Success { get; set; }

Property Value

Boolean

FromModel

Source CK model version

public CkModelId FromModel { get; set; }

Property Value

CkModelId

ToModel

Target CK model version

public CkModelId ToModel { get; set; }

Property Value

CkModelId

EntitiesAdded

Number of entities added

public int EntitiesAdded { get; set; }

Property Value

Int32

EntitiesUpdated

Number of entities updated

public int EntitiesUpdated { get; set; }

Property Value

Int32

EntitiesDeleted

Number of entities deleted

public int EntitiesDeleted { get; set; }

Property Value

Int32

TotalEntitiesAffected

Total number of entities affected

public int TotalEntitiesAffected { get; }

Property Value

Int32

DurationMs

Duration of the migration in milliseconds

public long DurationMs { get; set; }

Property Value

Int64

Errors

Errors that occurred during migration

public List<string> Errors { get; set; }

Property Value

List<String>

Warnings

Warnings generated during migration

public List<string> Warnings { get; set; }

Property Value

List<String>

BackupId

ID of the backup created before migration (if CreateBackup was true)

public string BackupId { get; set; }

Property Value

String

Constructors

CkMigrationResult()

Caution

Constructors of types with required members are not supported in this version of your compiler.


public CkMigrationResult()

Methods

Succeeded(CkModelId, CkModelId)

Creates a successful result

public static CkMigrationResult Succeeded(CkModelId fromModel, CkModelId toModel)

Parameters

fromModel CkModelId

toModel CkModelId

Returns

CkMigrationResult

Failed(CkModelId, CkModelId, String)

Creates a failed result

public static CkMigrationResult Failed(CkModelId fromModel, CkModelId toModel, string error)

Parameters

fromModel CkModelId

toModel CkModelId

error String

Returns

CkMigrationResult