Interface LDTransactionalDataSourceUpdates

Transactional version of LDDataSourceUpdates with support for applyChanges

interface LDTransactionalDataSourceUpdates {
    applyChanges(
        basis: boolean,
        data: LDFeatureStoreDataStorage,
        callback: () => void,
        initMetadata?: InitMetadata,
        selector?: string,
    ): void;
    init(
        allData: LDFeatureStoreDataStorage,
        callback: () => void,
        initMetadata?: InitMetadata,
    ): void;
    upsert(
        kind: DataKind,
        data: LDKeyedFeatureStoreItem,
        callback: () => void,
    ): void;
}

Hierarchy (View Summary)

LDDataSourceUpdates
- LDTransactionalDataSourceUpdates

Index

Methods

applyChanges init upsert

Methods

applyChanges

applyChanges(
    basis: boolean,
    data: LDFeatureStoreDataStorage,
    callback: () => void,
    initMetadata?: InitMetadata,
    selector?: string,
): void
Parameters
- basis: boolean
  If true, completely overwrites the current contents of the data store with the provided data. If false, upserts the items in the provided data. Upserts are made only if provided items have newer versions than existing items.
- data: LDFeatureStoreDataStorage
  An object in which each key is the "namespace" of a collection (e.g. "features") and the value is an object that maps keys to entities. The actual type of this parameter is interfaces.FullDataSet<VersionedData>.
- callback: () => void
  Will be called after the changes are applied.
- OptionalinitMetadata: InitMetadata
  Optional metadata to initialize the data source with.
- Optionalselector: string
  opaque string that uniquely identifies the state that contains the changes
Returns void
- Defined in packages/shared/sdk-server/src/api/subsystems/LDTransactionalDataSourceUpdates.ts:21

init

init(
    allData: LDFeatureStoreDataStorage,
    callback: () => void,
    initMetadata?: InitMetadata,
): void
Completely overwrites the current contents of the data store with a set of items for each collection.
Parameters
- allData: LDFeatureStoreDataStorage
  An object in which each key is the "namespace" of a collection (e.g. "features") and the value is an object that maps keys to entities. The actual type of this parameter is interfaces.FullDataSet<VersionedData>.
- callback: () => void
  Will be called when the store has been initialized.
- OptionalinitMetadata: InitMetadata
  Optional metadata to initialize the data source with.
Returns void
Inherited from LDDataSourceUpdates.init
- Defined in packages/shared/sdk-server/src/api/subsystems/LDDataSourceUpdates.ts:30

upsert

upsert(
    kind: DataKind,
    data: LDKeyedFeatureStoreItem,
    callback: () => void,
): void
Updates or inserts an item in the specified collection. For updates, the object will only be updated if the existing version is less than the new version.
Parameters
- kind: DataKind
  The type of data to be accessed. The actual type of this parameter is interfaces.DataKind.
- data: LDKeyedFeatureStoreItem
  The contents of the entity, as an object that can be converted to JSON. The store should check the version property of this object, and should not overwrite any existing data if the existing version is greater than or equal to that value. The actual type of this parameter is interfaces.VersionedData.
- callback: () => void
  Will be called after the upsert operation is complete.
Returns void
Inherited from LDDataSourceUpdates.upsert
- Defined in packages/shared/sdk-server/src/api/subsystems/LDDataSourceUpdates.ts:49

Interface LDTransactionalDataSourceUpdates

Hierarchy (View Summary)

Index

Methods

Methods

applyChanges

Parameters

Returns void

init

Parameters

Returns void

upsert

Parameters

Returns void

Settings

On This Page