List items with a specific key — mc_list_stream_key_items • multichainr

Returns all items in a stream that have a given key.

Usage

mc_list_stream_key_items(
  conn,
  stream,
  key,
  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.
key: Character string. The key to filter by.
verbose: Logical. If TRUE, returns detailed information.
count: Integer. Number of items to return (default 10).
start: Optional integer. Offset for pagination.
local_ordering: Logical. Use local ordering.

Value

A data frame (via rpc_res_to_df) with items.

See also

Other streams: mc_create_stream(), mc_create_stream_from(), mc_get_stream_info(), mc_get_stream_item(), mc_get_stream_key_summary(), mc_get_stream_publisher_summary(), mc_list_stream_block_items(), mc_list_stream_items(), mc_list_stream_keys(), mc_list_stream_publisher_items(), mc_list_stream_publishers(), mc_list_stream_query_items(), mc_list_stream_tx_items(), mc_list_streams(), mc_publish(), mc_publish_from(), mc_publish_multi(), mc_publish_multi_from()

Examples

if (FALSE) { # \dontrun{
items <- mc_list_stream_key_items(conn, "mystream", "mykey")
} # }