IWatermarkService.getOrCreateWatermark() method

Copy as MarkdownOpen in...

Home > @cbnsndwch/zero-contracts > IWatermarkService > getOrCreateWatermark

IWatermarkService.getOrCreateWatermark() method

Retrieves an existing watermark for the given shard ID and a change source's native resume token value, or creates a new one if one cannot be retrieved.

Signature:

getOrCreateWatermark(shardId: string, resumeToken: string): Promise<string>;

Parameters

Parameter

Type

Description

shardId

string

The identifier for the shard.

resumeToken

string

The resume token in teh change source's native format.

Returns:

Promise<string>

A promise that resolves to the watermark string.