Skip to main content

IFluidDataStorePolicies Interface

These policies can be set by the author of the data store via its data store runtime to influence behaviors.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IFluidDataStorePolicies

Remarks​

Policies allow data store authors to define specific behaviors or constraints for their data stores. These settings can impact how the data store interacts with the runtime and other components.

Properties​

PropertyAlertsModifiersTypeDescription
readonlyInStagingModeBetareadonlybooleanWhen set to true, the data store will appear readonly while in staging mode.

Property Details​

readonlyInStagingMode​

When set to true, the data store will appear readonly while in staging mode.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

readonly readonlyInStagingMode: boolean;

Type: boolean

Remarks​

In staging mode, operations are held locally until committed, so consensus-based operations (e.g., ConsensusRegisterCollection, ConsensusQueue, TaskManager) won't resolve their promises until staging mode exits. Set this to true for data stores that depend on consensus acknowledgments to prevent modifications that would leave the data store in an unresponsive state.