Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

msg2db_list

List the messages of a msg2db store (a dict-style message store on timeranger2), via its pkey / pkey2 indices (the active message plus its instances), including each record’s __md_msg2db__ metadata.

Usage

msg2db_list PATH [options]

PATH is a positional argument: the tranger root, the database, or even a topic directory — msg2db_list resolves the database and topic from it when --database / --topic are omitted.

Options

OptionPurpose
--database / -bmsg2db database (auto-resolved from PATH if omitted)
--topic / -cTopic to list
--ids / -iComma-separated message ids
--fields / -fSelect output fields (implies table mode)
--mode form|tableOutput layout
--recursive / -rWalk subtopics
--print-tranger / --print-msg2dbRaw JSON dumps of the underlying tranger / msg2db
--dry-run / -nResolve and print the plan only

See also