StartLocation

class borneo.changestream.StartLocation(location_type, start_time_ms=0)[source]

Bases: object

The position at which a Change Streams consumer should start reading.

Methods Summary

at_time(start_time_ms)

Start consuming from the specified time in milliseconds since the Epoch.

earliest()

Start consuming from the earliest available message in the stream.

first_uncommitted()

Start consuming at the first uncommitted message in the stream.

get_location_type()

Returns the protocol location type for this start location.

get_start_time()

Returns the start time in milliseconds since the Epoch, or 0 if unset.

latest()

Start consuming messages published after the consumer starts.

Methods Documentation

static at_time(start_time_ms)[source]

Start consuming from the specified time in milliseconds since the Epoch.

static earliest()[source]

Start consuming from the earliest available message in the stream.

static first_uncommitted()[source]

Start consuming at the first uncommitted message in the stream.

get_location_type()[source]

Returns the protocol location type for this start location.

get_start_time()[source]

Returns the start time in milliseconds since the Epoch, or 0 if unset.

static latest()[source]

Start consuming messages published after the consumer starts.