List unique keys in a stream — mc_list_stream_keys • multichainr

Returns the set of distinct keys used in a stream, with optional pagination.

Usage

mc_list_stream_keys(
  conn,
  stream,
  keys = "*",
  verbose = FALSE,
  count = NULL,
  start = NULL,
  local_ordering = FALSE
)

Arguments

conn: A connection object created by mc_connect.
stream: Character string. Stream name, reference, or txid.
keys: Character vector of keys to filter (default "*" for all).
verbose: Logical. If TRUE, returns additional metadata per key.
count: Optional integer. Number of keys to return.
start: Optional integer. Offset.
local_ordering: Logical. Use local ordering.

Value

A data frame (via rpc_res_to_df) with key information.

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_key_items(), 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{
keys <- mc_list_stream_keys(conn, "mystream")
} # }