Skip to contents

Returns a list of items published in a stream, with pagination and ordering.

Usage

mc_list_stream_items(
  conn,
  stream,
  verbose = FALSE,
  count = 10,
  start = NULL,
  local_ordering = FALSE
)

Arguments

conn

A connection object created by mc_connect.

stream

Character string. Stream name, reference, or txid.

verbose

Logical. If TRUE, returns detailed item information.

count

Integer. Number of items to return (default 10).

start

Optional integer. Offset (positive for forward, negative for backward). If omitted, the most recent items are returned.

local_ordering

Logical. If TRUE, uses local node's transaction ordering (default FALSE).

Value

A data frame (via rpc_res_to_df) with item details.

Examples

if (FALSE) { # \dontrun{
# Get the 10 most recent items
items <- mc_list_stream_items(conn, "mystream")

# Get next 5 items after the 10th
items <- mc_list_stream_items(conn, "mystream", count = 5, start = 10)
} # }