How do I run the fx_forward_publishes commands from the shell?

Table of Contents

This file documents the fx_forward_publishes resource at the shell, one section per command. Every command is a subcommand of fx_forward_publishes, and every section exports its own script into projects/ores.shell/scripts/library/. Loading a script runs that one command, so a failure names the command it came from.

1. Commands

1.1. list

Reads one page of the collection. Nothing addresses it but the caller's tenant, so it is the read that shows what exists.

The command is shaped like this:

fx_forward_publishes list [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at marketdata.v1.fx_forward_publishes.list.

fx_forward_publishes list --limit 1

1.2. get

Reads the one row its key addresses. A key states every identifying column, so a partial key is refused rather than answered with an arbitrary row.

The command is shaped like this:

fx_forward_publishes get <id>

It is addressed at marketdata.v1.fx_forward_publishes.get.

fx_forward_publishes get 00000000-0000-0000-0000-000000000000

1.3. get-many

Reads several rows in one request, one key group per row.

The command is shaped like this:

fx_forward_publishes get-many <id>

It is addressed at marketdata.v1.fx_forward_publishes.get_many.

fx_forward_publishes get-many 00000000-0000-0000-0000-000000000000

1.4. by-request-id

Reads one page of the rows that share a relation value. The relation is part of the address rather than a filter applied after the read.

The command is shaped like this:

fx_forward_publishes by-request-id <request_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at marketdata.v1.fx_forward_publishes.list_by_request_id.

fx_forward_publishes by-request-id 00000000-0000-0000-0000-000000000000 --limit 1

1.5. versions

Reads the row's recorded history, newest first.

The command is shaped like this:

fx_forward_publishes versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at marketdata.v1.fx_forward_publishes_versions.list.

fx_forward_publishes versions 00000000-0000-0000-0000-000000000000 --limit 1

1.6. version

Reads one recorded version of the row.

The command is shaped like this:

fx_forward_publishes version <id> --version <n>

It is addressed at marketdata.v1.fx_forward_publishes_versions.get.

fx_forward_publishes version 00000000-0000-0000-0000-000000000000 --version 1

Emacs 29.3 (Org mode 9.6.15)