ChangeFeedStartFrom class

パッケージ:

@azure/cosmos

ChangeFeedIterator を開始する場所の基本クラス。

メソッド

Beginning(PartitionKey | FeedRange)	ChangeFeedIterator に時刻の先頭から開始するように指示するオブジェクトを返します。
Continuation(string)	保存ポイントからの変更の読み取りを開始するように ChangeFeedIterator に指示するオブジェクトを返します。
Now(PartitionKey | FeedRange)	ChangeFeedIterator に、この時点以降の変更の読み取りを開始するように指示するオブジェクトを返します。
Time(Date, PartitionKey | FeedRange)	ある時点から変更の読み取りを開始するように ChangeFeedIterator に指示するオブジェクトを返します。

メソッドの詳細

Beginning(PartitionKey | FeedRange)

ChangeFeedIterator に時刻の先頭から開始するように指示するオブジェクトを返します。

static function Beginning(cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromBeginning

パラメーター

cfResource

PartitionKey | FeedRange

変更をフェッチする PartitionKey または FeedRange。 コンテナー全体の変更をフェッチする場合は、空白のままにします。

戻り値

ChangeFeedStartFromBeginning

Continuation(string)

保存ポイントからの変更の読み取りを開始するように ChangeFeedIterator に指示するオブジェクトを返します。

static function Continuation(continuationToken: string): ChangeFeedStartFromContinuation

パラメーター

continuationToken

string

戻り値

ChangeFeedStartFromContinuation

Now(PartitionKey | FeedRange)

ChangeFeedIterator に、この時点以降の変更の読み取りを開始するように指示するオブジェクトを返します。

static function Now(cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromNow

パラメーター

cfResource

PartitionKey | FeedRange

変更をフェッチする PartitionKey または FeedRange。 コンテナー全体の変更をフェッチする場合は、空白のままにします。

戻り値

ChangeFeedStartFromNow

Time(Date, PartitionKey | FeedRange)

ある時点から変更の読み取りを開始するように ChangeFeedIterator に指示するオブジェクトを返します。

static function Time(startTime: Date, cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromTime

パラメーター

startTime

Date

変更の読み取りを開始する時刻を指定する Date オブジェクト。

cfResource

PartitionKey | FeedRange

変更をフェッチする PartitionKey または FeedRange。 コンテナー全体の変更をフェッチする場合は、空白のままにします。

戻り値

ChangeFeedStartFromTime