InedoSDK Reference
Version:

IChangeScriptExecuter Interface

Implemented by database connections which provide change script execution.

Inheritance Hierarchy

  • Inedo.Extensibility.DatabaseConnections.IChangeScriptExecuter

Syntax

public interface IChangeScriptExecuter

Properties

Name Description
MaxChangeScriptVersion

Gets the highest supported version of change scripts.

Methods

Name Description
ExecuteChangeScriptAsync(ChangeScriptId scriptId, string scriptName, string scriptText, System.Threading.CancellationToken cancellationToken)

When implemented by a derived class, executes the specified script provided that the specified script has not already been executed, and returns a Boolean indicating whether the script was skipped as a result of being executed.

GetStateAsync(System.Threading.CancellationToken cancellationToken)

When implemented by a derived class, retrieves the changes that occurred in the database.

InitializeDatabaseAsync(System.Threading.CancellationToken cancellationToken)

When implemented by a derived class, initializes the database by installing metadata tables for tracking change scripts and version numbers.

UpgradeSchemaAsync(System.Collections.Generic.IReadOnlyDictionary<int, System.Guid> canoncialGuids, System.Threading.CancellationToken cancellationToken)

When implemented by a derived class, migrates existing v1 script execution records to a new v2 table.