Interface BatchMigrator<AppModelType, DbModelType>

A batch migrator object that uses atomic batch writes.

interface BatchMigrator<
    AppModelType = firestore.DocumentData,
    DbModelType extends firestore.DocumentData = firestore.DocumentData,
> {
    traverser: Traverser<AppModelType, DbModelType>;
    deleteField(field: string | FieldPath): Promise<MigrationResult>;
    deleteFields(...fields: (string | FieldPath)[]): Promise<MigrationResult>;
    onAfterBatchComplete(
        callback: BatchCallback<AppModelType, DbModelType>,
    ): void;
    onBeforeBatchStart(
        callback: BatchCallback<AppModelType, DbModelType>,
    ): void;
    renameField(
        oldField: string | FieldPath,
        newField: string | FieldPath,
    ): Promise<MigrationResult>;
    renameFields(
        ...changes: [
            oldField: string
            | FieldPath,
            newField: string | FieldPath,
        ][],
    ): Promise<MigrationResult>;
    set(
        data: PartialWithFieldValue<AppModelType>,
        options: SetOptions,
    ): Promise<MigrationResult>;
    set(data: WithFieldValue<AppModelType>): Promise<MigrationResult>;
    setWithDerivedData(
        getData: SetPartialDataGetter<AppModelType, DbModelType>,
        options: SetOptions,
    ): Promise<MigrationResult>;
    setWithDerivedData(
        getData: SetDataGetter<AppModelType, DbModelType>,
    ): Promise<MigrationResult>;
    update(
        data: UpdateData<DbModelType>,
        precondition?: Precondition,
    ): Promise<MigrationResult>;
    update(
        field: string | FieldPath,
        value: any,
        ...moreFieldsOrPrecondition: any[],
    ): Promise<MigrationResult>;
    updateWithDerivedData(
        getData: UpdateDataGetter<AppModelType, DbModelType>,
        precondition?: Precondition,
    ): Promise<MigrationResult>;
    updateWithDerivedData(
        getData: UpdateFieldValueGetter<AppModelType, DbModelType>,
    ): Promise<MigrationResult>;
    withPredicate(
        predicate: MigrationPredicate<AppModelType, DbModelType>,
    ): BatchMigrator<AppModelType, DbModelType>;
    withTraverser(
        traverser: Traverser<AppModelType, DbModelType>,
    ): BatchMigrator<AppModelType, DbModelType>;
}

Type Parameters

AppModelType = firestore.DocumentData
DbModelType extends firestore.DocumentData = firestore.DocumentData

Hierarchy (View Summary)

Migrator<AppModelType, DbModelType>
- BatchMigrator

Index

Properties

traverser

Methods

deleteField deleteFields onAfterBatchComplete onBeforeBatchStart renameField renameFields set setWithDerivedData update updateWithDerivedData withPredicate withTraverser

Properties

`Readonly`traverser

traverser: Traverser<AppModelType, DbModelType>

The underlying traverser.

Methods

deleteField

deleteField(field: string | FieldPath): Promise<MigrationResult>
Deletes the specified field from all documents in this collection.
Parameters
- field: string | FieldPath
  The field to delete.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.deleteField
- Defined in src/api/interfaces/Migrator.ts:102

deleteFields

deleteFields(...fields: (string | FieldPath)[]): Promise<MigrationResult>
Deletes the specified fields from all documents in this collection.
Parameters
- ...fields: (string | FieldPath)[]
  A list of fields to delete.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Example
```
const field1 = new firestore.FieldPath('name', 'last');
const field2 = 'lastModifiedAt';
await migrator.deleteFields(field1, field2);
```
Inherited from Migrator.deleteFields
- Defined in src/api/interfaces/Migrator.ts:134

onAfterBatchComplete

onAfterBatchComplete(callback: BatchCallback<AppModelType, DbModelType>): void
Registers a callback function that fires after a batch is processed. You can register at most 1 callback. If you call this function multiple times, only the last callback will be registered.
Parameters
- callback: BatchCallback<AppModelType, DbModelType>
  A synchronous callback that takes batch doc snapshots and the 0-based batch index as its arguments.
Returns void
Inherited from Migrator.onAfterBatchComplete
- Defined in src/api/interfaces/Migrator.ts:78

onBeforeBatchStart

onBeforeBatchStart(callback: BatchCallback<AppModelType, DbModelType>): void
Registers a callback function that fires right before a batch starts processing. You can register at most 1 callback. If you call this function multiple times, only the last callback will be registered.
Parameters
- callback: BatchCallback<AppModelType, DbModelType>
  A synchronous callback that takes batch doc snapshots and the 0-based batch index as its arguments.
Returns void
Inherited from Migrator.onBeforeBatchStart
- Defined in src/api/interfaces/Migrator.ts:70

renameField

renameField(
oldField: string | FieldPath,
newField: string | FieldPath,
): Promise<MigrationResult>
Renames the specified field in all documents in this collection. Ignores the fields that are missing.
Parameters
- oldField: string | FieldPath
  The old field.
- newField: string | FieldPath
  The new field.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.renameField
- Defined in src/api/interfaces/Migrator.ts:159

renameFields

renameFields(
...changes: [oldField: string | FieldPath, newField: string | FieldPath][],
): Promise<MigrationResult>
Renames the specified fields in all documents in this collection. Ignores the fields that are missing.
Parameters
- ...changes: [oldField: string | FieldPath, newField: string | FieldPath][]
  A list of [oldField, newField] tuples. Each tuple is an array of 2 elements: the old field to rename and the new field.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Example
```
const change1 = [new firestore.FieldPath('name', 'last'), 'lastName'];
const change2 = ['lastModifiedAt', 'lastUpdatedAt'];
await migrator.renameFields(change1, change2);
```
Inherited from Migrator.renameFields
- Defined in src/api/interfaces/Migrator.ts:195

set

set(
data: PartialWithFieldValue<AppModelType>,
options: SetOptions,
): Promise<MigrationResult>
Sets all documents in this collection with the provided data.
Parameters
- data: PartialWithFieldValue<AppModelType>
  A data object with which to set each document.
- options: SetOptions
  An object to configure the set behavior.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.set
- Defined in src/api/interfaces/Migrator.ts:222
set(data: WithFieldValue<AppModelType>): Promise<MigrationResult>
Sets all documents in this collection with the provided data.
Parameters
- data: WithFieldValue<AppModelType>
  A data object with which to set each document.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.set
- Defined in src/api/interfaces/Migrator.ts:249

setWithDerivedData

setWithDerivedData(
getData: SetPartialDataGetter<AppModelType, DbModelType>,
options: SetOptions,
): Promise<MigrationResult>
Sets all documents in this collection with the provided data.
Parameters
- getData: SetPartialDataGetter<AppModelType, DbModelType>
  A function that takes a document snapshot and returns a data object with which to set each document.
- options: SetOptions
  An object to configure the set behavior.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.setWithDerivedData
- Defined in src/api/interfaces/Migrator.ts:275
setWithDerivedData(
getData: SetDataGetter<AppModelType, DbModelType>,
): Promise<MigrationResult>
Sets all documents in this collection with the provided data.
Parameters
- getData: SetDataGetter<AppModelType, DbModelType>
  A function that takes a document snapshot and returns a data object with which to set each document.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.setWithDerivedData
- Defined in src/api/interfaces/Migrator.ts:303

update

update(
data: UpdateData<DbModelType>,
precondition?: Precondition,
): Promise<MigrationResult>
Updates all documents in this collection with the provided data.
Parameters
- data: UpdateData<DbModelType>
  A non-empty data object with which to update each document.
- Optionalprecondition: Precondition
  A Precondition to enforce on this update.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.update
- Defined in src/api/interfaces/Migrator.ts:328
update(
    field: string | FieldPath,
    value: any,
    ...moreFieldsOrPrecondition: any[],
): Promise<MigrationResult>
Updates all documents in this collection with the provided field-value pair.
Parameters
- field: string | FieldPath
  The first field to update in each document.
- value: any
  The first value corresponding to the first field. Must not be undefined.
- ...moreFieldsOrPrecondition: any[]
  An alternating list of field paths and values to update, optionally followed by a Precondition to enforce on this update.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.update
- Defined in src/api/interfaces/Migrator.ts:359

updateWithDerivedData

updateWithDerivedData(
getData: UpdateDataGetter<AppModelType, DbModelType>,
precondition?: Precondition,
): Promise<MigrationResult>
Updates all documents in this collection with the provided data.
Parameters
- getData: UpdateDataGetter<AppModelType, DbModelType>
  A function that takes a document snapshot and returns a non-empty data object with which to update each document.
- Optionalprecondition: Precondition
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.updateWithDerivedData
- Defined in src/api/interfaces/Migrator.ts:388
updateWithDerivedData(
getData: UpdateFieldValueGetter<AppModelType, DbModelType>,
): Promise<MigrationResult>
Updates all documents in this collection with the provided data.
Parameters
- getData: UpdateFieldValueGetter<AppModelType, DbModelType>
  A function that takes a document snapshot and returns an alternating list of field paths and values to update, optionally followed by a Precondition to enforce on this update.
Returns Promise<MigrationResult>
A Promise resolving to an object representing the details of the migration.
Remarks
Complexity:
- Time complexity: TC(traverser) where C(batchSize) = W(batchSize)
- Space complexity: SC(traverser) where S = O(batchSize)
- Billing: max(1, N) reads, K writes
where:
- N: number of docs in the traversable
- K: number of docs that passed the migration predicate (K<=N)
- W(batchSize): average batch write time
- TC(traverser): time complexity of the underlying traverser
- SC(traverser): space complexity of the underlying traverser
Inherited from Migrator.updateWithDerivedData
- Defined in src/api/interfaces/Migrator.ts:416

withPredicate

withPredicate(
predicate: MigrationPredicate<AppModelType, DbModelType>,
): BatchMigrator<AppModelType, DbModelType>
Applies a migration predicate that indicates whether to migrate the current document or not. By default, all documents are migrated.
Parameters
- predicate: MigrationPredicate<AppModelType, DbModelType>
  A function that takes a document snapshot and returns a boolean indicating whether to migrate it.
Returns BatchMigrator<AppModelType, DbModelType>
A new BatchMigrator object.
Remarks
If you have already applied other migration predicates to this migrator, this and all the other predicates will be evaluated and the resulting booleans will be AND'd to get the boolean that indicates whether to migrate the document or not. This is consistent with the intuitive default behavior that all documents are migrated.
Example
```
const newMigrator = migrator
  .withPredicate((doc) => doc.get('name') !== undefined)
  .withPredicate((doc) => doc.ref.path.startsWith('users/'));
```
In the above case newMigrator will migrate only the documents whose name field is not missing AND whose path starts with "users/".
Overrides Migrator.withPredicate
- Defined in src/api/interfaces/BatchMigrator.ts:35

withTraverser

withTraverser(
traverser: Traverser<AppModelType, DbModelType>,
): BatchMigrator<AppModelType, DbModelType>
Applies a new traverser that will be used by the migrator.
Parameters
- traverser: Traverser<AppModelType, DbModelType>
  The new traverser that the migrator will use.
Returns BatchMigrator<AppModelType, DbModelType>
A new BatchMigrator object.
Overrides Migrator.withTraverser
- Defined in src/api/interfaces/BatchMigrator.ts:45

Interface BatchMigrator<AppModelType, DbModelType>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlytraverser

Methods

deleteField

Parameters

Returns Promise<MigrationResult>

Remarks

deleteFields

Parameters

Returns Promise<MigrationResult>

Remarks

Example

onAfterBatchComplete

Parameters

Returns void

onBeforeBatchStart

Parameters

Returns void

renameField

Parameters

Returns Promise<MigrationResult>

Remarks

renameFields

Parameters

Returns Promise<MigrationResult>

Remarks

Example

set

Parameters

Returns Promise<MigrationResult>

Remarks

Parameters

Returns Promise<MigrationResult>

Remarks

setWithDerivedData

Parameters

Returns Promise<MigrationResult>

Remarks

Parameters

Returns Promise<MigrationResult>

Remarks

update

Parameters

Returns Promise<MigrationResult>

Remarks

Parameters

Returns Promise<MigrationResult>

Remarks

updateWithDerivedData

Parameters

Returns Promise<MigrationResult>

Remarks

Parameters

Returns Promise<MigrationResult>

Remarks

withPredicate

Parameters

Returns BatchMigrator<AppModelType, DbModelType>

Remarks

Example

withTraverser

Parameters

Returns BatchMigrator<AppModelType, DbModelType>

Settings

On This Page

`Readonly`traverser