MongoDB\ChangeStream::key()

Definición

MongoDB\ChangeStream::key()

Devuelve el índice del evento actual en el flujo de cambios.

function key(): integer|null

El índice del primer evento en un flujo de cambios comienza en cero y se incrementará en uno por cada evento subsiguiente.

Return Values

El índice del evento actual en el flujo de cambios, o null si no hay un evento actual (por ejemplo, MongoDB\ChangeStream::valid() devuelve false).

Ejemplos

Este ejemplo reporta el índice de eventos mientras itera en un flujo de cambios.

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

Suponiendo que se insertara, actualizara y eliminara un documento mientras el script anterior estuviese iterando el flujo de cambios, la salida se parecería entonces a:

0: insert
1: update
2: delete

Ver también

• MongoDB\Client::watch()
• MongoDB\Collection::watch()
• MongoDB\Database::watch()

• Iterator::key()

• Iteración de cursor con seguimiento

• Change Streams documentación en el manual de MongoDB