MongoDB\ChangeStream::key()

定義

MongoDB\ChangeStream::key()

変更ストリーム内の現在のイベントのインデックスを返します。

function key(): integer|null

変更ストリーム内の最初のイベントのインデックスは 0 から始まり、後続のイベントごとに 1 ずつ増加します。

Return Values

変更ストリーム内の現在のイベントのインデックス。または、現在のイベントがない場合はnull （ MongoDB\ChangeStream::valid()はfalse を返します）。

例

この例では、変更ストリームを反復処理しながら、イベントのインデックスを報告します。

<?php
$uri = 'mongodb://rs1.example.com,rs2.example.com/?replicaSet=myReplicaSet';
$collection = (new MongoDB\Client($uri))->test->inventory;
$changeStream = $collection->watch();
for ($changeStream->rewind(); true; $changeStream->next()) {    if ( ! $changeStream->valid()) {        continue;    }
    $event = $changeStream->current();
    printf("%d: %s\n", $changeStream->key(), $event['operationType']);}

上記のスクリプトが変更ストリームを反復処理している間にドキュメントが挿入、更新、および削除されたと仮定すると、出力は次のようになります。

0: insert1: update2: delete

その他の参照

戻る

getResumeToken()

next()