MongoDB\ChangeStream::key()

Definição

MongoDB\ChangeStream::key()

Retorna o índice do evento atual no change stream.

function key(): integer|null

O índice do primeiro evento em um change stream começa em zero e será incrementado em um para cada evento subsequente.

Return Values

O índice do evento atual no fluxo de alterações, ou null se não houver nenhum evento atual (ou seja, MongoDB\ChangeStream::valid() retorna false).

Exemplos

Este exemplo reporta o índice de eventos enquanto itera um change stream.

<?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']);
}

Supondo que um documento tenha sido inserido, atualizado e excluído enquanto o script acima iterava o change stream, a saída seria semelhante a:

0: insert
1: update
2: delete

Veja também

• MongoDB\Client::watch()

• MongoDB\Collection::watch()

• MongoDB\Database::watch()

• Iterator::key()

• Iteração de cursor tailable

• Documentação do Change Streams no Manual do MongoDB