SqlWorkflowInstanceStore Class

SqlWorkflowInstanceStore Class

.NET Framework (current version)
 

Derives from the abstract InstanceStore class of the persistence functionality and provides implementation to allow saving instance state information to and loading instance state information from an SQL Server 2005 or SQL Server 2008 database.

Namespace:   System.Activities.DurableInstancing
Assembly:  System.Activities.DurableInstancing (in System.Activities.DurableInstancing.dll)

System.Object
  System.Runtime.DurableInstancing.InstanceStore
    System.Activities.DurableInstancing.SqlWorkflowInstanceStore

public sealed class SqlWorkflowInstanceStore : InstanceStore

NameDescription
System_CAPS_pubmethodSqlWorkflowInstanceStore()

Initializes a new instance of the SqlWorkflowInstanceStore class.

System_CAPS_pubmethodSqlWorkflowInstanceStore(String)

Initializes a new instance of the SqlWorkflowInstanceStore class by using the connectionString parameter.

NameDescription
System_CAPS_pubpropertyConnectionString

Gets or sets a connection string with parameters that are used to connect to an underlying persistence database.

System_CAPS_pubpropertyDefaultInstanceOwner

Gets or sets the default instance owner. (Inherited from InstanceStore.)

System_CAPS_pubpropertyEnqueueRunCommands

Gets or set a value that indicates whether Run commands are enqueued. This property is used internally by the SQL Workflow Instance Store and it should not be used in your applications.

System_CAPS_pubpropertyHostLockRenewalPeriod

Specifies the time period within which the host renews its lock on a workflow service instance.

System_CAPS_pubpropertyInstanceCompletionAction

Specifies the action to be taken after a workflow instance completes. Possible values are “DeleteNothing” and “DeleteAll”. The default value is “DeleteAll”. If the property is set to “DeleteNothing”, the persistence provider keeps all the instance data and metadata in the persistence database after the workflow instance completes. If the property is set to “DeleteAll”, the persistence provider deletes all the instance data and metadata after the workflow instance completes.

System_CAPS_pubpropertyInstanceEncodingOption

Specifies a value that indicates whether the instance data must be compressed.

System_CAPS_pubpropertyInstanceLockedExceptionAction

Specifies the action to be taken when the persistence provider catches an InstanceLockedException.

System_CAPS_pubpropertyMaxConnectionRetries

Gets or sets the maximum number of SQL connection retries. The default value is 4.

System_CAPS_pubpropertyRunnableInstancesDetectionPeriod

Specifies the time period after which the SQL Workflow Instance Store runs a detection task to detect any runnable or activatable workflow instances in the persistence database after the previous detection cycle.

NameDescription
System_CAPS_pubmethodBeginExecute(InstanceHandle, InstancePersistenceCommand, TimeSpan, AsyncCallback, Object)

Asynchronously executes persistence commands such as LoadWorkflowCommand and SaveWorkflowCommand.(Inherited from InstanceStore.)

System_CAPS_protmethodBeginTryCommand(InstancePersistenceContext, InstancePersistenceCommand, TimeSpan, AsyncCallback, Object)

A persistence provider implements this method, which determines whether a particular persistence command can be executed. If the command can be executed, executes the command asynchronously.(Inherited from InstanceStore.)

System_CAPS_pubmethodBeginWaitForEvents(InstanceHandle, TimeSpan, AsyncCallback, Object)

Begins an asynchronous operation to listen for any events raised by the instance store for a specific instance handle.(Inherited from InstanceStore.)

System_CAPS_pubmethodCreateInstanceHandle()

Creates an instance handle. (Inherited from InstanceStore.)

System_CAPS_pubmethodCreateInstanceHandle(Guid)

Creates an instance handle. If the DefaultInstanceOwner is set, the value is automatically bound as the new handle’s instance owner. The instance identifier passed as a parameter is automatically bound as the new handle’s instance.(Inherited from InstanceStore.)

System_CAPS_pubmethodCreateInstanceHandle(InstanceOwner)

Creates an instance handle. If the instance owner passed as a parameter is not null, the value is automatically bound as the new handle’s instance owner. (Otherwise, no instance owner is bound, even if DefaultInstanceOwner is set.)(Inherited from InstanceStore.)

System_CAPS_pubmethodCreateInstanceHandle(InstanceOwner, Guid)

Creates an instance handle. If the instance owner passed as a parameter is not null, the value is automatically bound as the new handle’s instance owner. (Otherwise, no instance owner is bound, even if DefaultInstanceOwner is set.) The instance identifier passed as a parameter is automatically bound as the new handle’s instance.(Inherited from InstanceStore.)

System_CAPS_pubmethodEndExecute(IAsyncResult)

Ends the asynchronous operation.(Inherited from InstanceStore.)

System_CAPS_protmethodEndTryCommand(IAsyncResult)

Ends an asynchronous operation.(Inherited from InstanceStore.)

System_CAPS_pubmethodEndWaitForEvents(IAsyncResult)

Ends the asynchronous operation initiated by the BeginWaitForEvents method.(Inherited from InstanceStore.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExecute(InstanceHandle, InstancePersistenceCommand, TimeSpan)

Executes a persistence command synchronously. Examples of persistence commands are: LoadWorkflowCommand and SaveWorkflowCommand. (Inherited from InstanceStore.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodPromote(String, IEnumerable<XName>, IEnumerable<XName>)

Associates the specified properties with a workflow instance so that you can query for instances based on specific values for these properties. These properties that can be used in external queries can be of simple types (for example: Int64, String, and so on) or of a serialized binary type (byte[]). Binary properties are typically used to store tracking data.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTryCommand(InstancePersistenceContext, InstancePersistenceCommand, TimeSpan)

A persistence provider implements this method, which determines whether a particular persistence command can be executed and if the command can be executed executes it asynchronously.(Inherited from InstanceStore.)

System_CAPS_pubmethodWaitForEvents(InstanceHandle, TimeSpan)

A workflow host typically invokes this method to wait for an event to be signaled.(Inherited from InstanceStore.)

SqlWorkflowInstanceStore uses the NetDataContractSerializer to serialize complex types; all types used in workflows to be persisted with this instance store must be serializable using NetDataContractSerializer.

The following code sample demonstrates creating a SqlWorkflowInstanceStore. This example is from the Persistence Participants sample.

.NET Framework
Available since 4.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft