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​

Property Alerts Modifiers Type Description
readonlyInStagingMode Alpha readonly boolean When set to true, data stores will appear to be readonly while in staging mode.

Property Details​

readonlyInStagingMode​

When set to true, data stores will appear to be 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​

This policy is useful for data stores that do not support staging mode, such as those using consensus DDS. It ensures that the data store appears readonly during staging mode to discourage unsupported operations.