Class Sql

Namespace

DCR.Workflow.Effect

Assembly

DCR.Workflow.dll

public class Sql : EffectBase, IClientEffect, IEffect

Inheritance

object

EffectBase

Sql

Implements

IClientEffect

IEffect

Inherited Members

EffectBase.LocalParameters

EffectBase.GetIntParameter(Dictionary<string, string>, string)

EffectBase.AtMostOnce

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MiscExtensions.ToLog<T>(T?)

Constructors

Sql(ILogger<Sql>)

public Sql(ILogger<Sql> logger)

Parameters

logger ILogger<Sql>

Properties

Description

public override string Description { get; }

Property Value

string

Id

Id of the effect

public override string Id { get; }

Property Value

string

Remarks

This is the id used to identify the effect. Modellers use this id to indicate that an activity should have the effect

RequiredParameters

Parameters required to be set

public override string[] RequiredParameters { get; }

Property Value

string[]

Remarks

The context parameter to Runtime.Execute must define at least the keys listed here.

ShouldRunActivityDidExecute

public override bool ShouldRunActivityDidExecute { get; }

Property Value

bool

ShouldRunActivityWillExecute

public override bool ShouldRunActivityWillExecute { get; }

Property Value

bool

Methods

ActivityDidExecute(Model, Activity, Dictionary<string, string>)

public override Task<Result> ActivityDidExecute(Model m, Activity a, Dictionary<string, string> parameters)

Parameters

m Model

a Activity

parameters Dictionary<string, string>

Returns

Task<Result>

ActivityWillExecute(Model, Activity, Dictionary<string, string>)

Callback to run effect before activity execution

public override Task<Result> ActivityWillExecute(Model m, Activity a, Dictionary<string, string> parameters)

Parameters

m Model

a Activity

parameters Dictionary<string, string>

The parameters for the effect. In value, references to model values, e.g., $(Activity) are replaced with their values. [LINK: model value references docs] The dictionary is guaranteed to have defined value for all keys in RequiredParameters.

Returns

Task<Result>

A pair of a Result structure and an optional state object to be passed in to a subsequent call to ActivityDidExecute.

Remarks

Execute the effect, possibly returning an updated value. The effect executes before the underlying activity is executed, and if the effect fails (throws), execution of the activity is aborted.

ExecuteClientEffectAsync(Model, Activity, Dictionary<string, string>)

public Task<object?> ExecuteClientEffectAsync(Model m, Activity _, Dictionary<string, string> parameters)

Parameters

m Model

_ Activity

parameters Dictionary<string, string>

Returns

Task<object>

SetClientEffectState(object?)

Set the client state

public void SetClientEffectState(object? u)

Parameters

u object

The client state, provided by the host system. Note that this value may be null.

Remarks

This is guaranteed to be called before any of the following executes: - ActivityWillExecute(Model, Activity, Dictionary<string, string>) - ActivityDidExecute(Model, Activity, Dictionary<string, string>) - ExecuteClientEffectAsync(Model, Activity, Dictionary<string, string>)

SetSecrets(Dictionary<string, string>)

public override void SetSecrets(Dictionary<string, string> secrets)

Parameters

secrets Dictionary<string, string>