IFluidDataStoreAttributes2 Interface

This API is deprecated and will be removed in a future release.

This interface will no longer be exported in the future(AB#8004).

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

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

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

Signature

export interface IFluidDataStoreAttributes2 extends OmitAttributesVersions<IFluidDataStoreAttributes1>

Extends: OmitAttributesVersions<IFluidDataStoreAttributes1>

Properties

Property	Alerts	Modifiers	Type	Description
disableIsolatedChannels	Beta	optional, readonly	true	True if channels are not isolated in .channels subtrees, otherwise isolated. This is required in both datastore attributes as well as the root container, because reused summary handles may cause different format versions in each datastore subtree within the summary.
snapshotFormatVersion	Beta	optional, readonly	undefined	Switch from snapshotFormatVersion to summaryFormatVersion
summaryFormatVersion	Beta	readonly	2

Property Details

disableIsolatedChannels

True if channels are not isolated in .channels subtrees, otherwise isolated. This is required in both datastore attributes as well as the root container, because reused summary handles may cause different format versions in each datastore subtree within the summary.

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 disableIsolatedChannels?: true;

Type: true

snapshotFormatVersion

Switch from snapshotFormatVersion to summaryFormatVersion

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 snapshotFormatVersion?: undefined;

Type: undefined

summaryFormatVersion

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 summaryFormatVersion: 2;

Type: 2