How do I run the routes commands from the shell?

Table of Contents

This file documents the routes resource at the shell, one section per command. Every command is a subcommand of routes, 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:

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

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

routes 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:

routes get <publisher_code>

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

routes get __none__

1.3. get-many

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

The command is shaped like this:

routes get-many <publisher_code>

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

routes get-many __none__

1.4. add

Writes a row. The change states that the row must not exist, so a create that collides with an existing row is refused rather than replacing it. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

routes add <party_id> <publisher_code> <asset_class> <feed_id> <reason> <commentary>

It is addressed at marketdata.v1.routes.put.

routes add 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 system.new_record generated_script

1.5. set

Writes a row. The change states no precondition, so it replaces whatever row the key already addresses. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved. Passing –version makes the write conditional on the version the caller last read.

The command is shaped like this:

routes set <id> <party_id> <publisher_code> <asset_class> <feed_id> <reason> <commentary> [--version <n>]

It is addressed at marketdata.v1.routes.put.

routes set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 system.new_record generated_script

1.6. put-many

Writes several rows in one request. The count states how many field groups follow. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

routes put-many --count <n> <id> <party_id> <publisher_code> <asset_class> <feed_id> <reason> <commentary>

It is addressed at marketdata.v1.routes.put_many.

routes put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 system.new_record generated_script

1.7. delete

Removes a row. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved. Passing –version makes the write conditional on the version the caller last read.

The command is shaped like this:

routes delete <publisher_code> <reason> <commentary> [--version <n>]

It is addressed at marketdata.v1.routes.delete.

routes delete __none__ system.new_record generated_script

1.8. delete-many

Removes several rows in one request. The change carries a reason and a commentary, which the server records on it so the row's history says why it moved.

The command is shaped like this:

routes delete-many <publisher_code> <reason> <commentary>

It is addressed at marketdata.v1.routes.delete_many.

routes delete-many __none__ system.new_record generated_script

1.9. versions

Reads the row's recorded history, newest first.

The command is shaped like this:

routes versions <publisher_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

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

routes versions __none__ --limit 1

1.10. version

Reads one recorded version of the row.

The command is shaped like this:

routes version <publisher_code> --version <n>

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

routes version __none__ --version 1

Emacs 29.3 (Org mode 9.6.15)