AdoNetGrainStorage

1. Documentation
2. API reference
3. Microsoft.Orleans.Persistence.AdoNet
4. AdoNetGrainStorage

class

Namespace: Orleans.Storage

NuGetSourceMarkdown

Stores grain state in a relational database using ADO.NET.

public class AdoNetGrainStorage : ILifecycleParticipant<ISiloLifecycle>, IGrainStorage

Remarks

Configuration is provided through AdoNetGrainStorageOptions.

Configure exactly one of AdoNetGrainStorageOptions or AdoNetGrainStorageOptions.

AdoNetGrainStorageOptions identifies the ADO.NET provider and defaults to Microsoft.Data.SqlClient.

Constructors

• AdoNetGrainStorage(IActivatorProvider, ILogger<AdoNetGrainStorage>, IOptions<AdoNetGrainStorageOptions>, IOptions<ClusterOptions>, string) Initializes a new instance of the AdoNetGrainStorage class.

Properties

• CurrentOperationalQueries The queries currently used. When this is updated, the new queries will take effect immediately.
• HashPicker The hash generator used to hash natural keys, grain ID and grain type to a more narrow index.
• Serializer Gets or sets the serializer used to convert grain state to and from its stored representation.

Methods

• ClearStateAsync(string, GrainId, IGrainState<T>)Clear state data function for this storage provider.
• Participate(ISiloLifecycle) Registers the provider's initialization and shutdown callbacks with the silo lifecycle.
• ReadStateAsync(string, GrainId, IGrainState<T>) Read state data function for this storage provider.
• WriteStateAsync(string, GrainId, IGrainState<T>) Write state data function for this storage provider.

Fields

• BinaryFormatSerializerTag Tag for BinaryFormatSerializer
• DefaultInitializationQuery The default query to initialize this structure from the Orleans database.
• JsonFormatSerializerTag Tag for JsonFormatSerializer
• XmlFormatSerializerTag Tag for XmlFormatSerializer