How do I run the trade_links commands from the shell?
Table of Contents
This file documents the trade_links resource at the shell, one section per command. Every command is a subcommand of trade_links, 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:
trade_links list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at trading.v1.trade_links.list.
trade_links 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:
trade_links get <from_trade_id> <to_trade_id> <link_type>
It is addressed at trading.v1.trade_links.get.
trade_links get 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
trade_links get-many <from_trade_id> <to_trade_id> <link_type>
It is addressed at trading.v1.trade_links.get_many.
trade_links get-many 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __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:
trade_links add <link_type> <trade_activity_id> <reason> <commentary>
It is addressed at trading.v1.trade_links.put.
trade_links add __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:
trade_links set <from_trade_id> <to_trade_id> <link_type> <trade_activity_id> <reason> <commentary> [--version <n>]
It is addressed at trading.v1.trade_links.put.
trade_links set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __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:
trade_links put-many --count <n> <from_trade_id> <to_trade_id> <link_type> <trade_activity_id> <reason> <commentary>
It is addressed at trading.v1.trade_links.put_many.
trade_links put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __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:
trade_links delete <from_trade_id> <to_trade_id> <link_type> <reason> <commentary> [--version <n>]
It is addressed at trading.v1.trade_links.delete.
trade_links delete 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __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:
trade_links delete-many <from_trade_id> <to_trade_id> <link_type> <reason> <commentary>
It is addressed at trading.v1.trade_links.delete_many.
trade_links delete-many 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ system.new_record generated_script
1.9. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
trade_links versions <from_trade_id> <to_trade_id> <link_type> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at trading.v1.trade_links_versions.list.
trade_links versions 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
trade_links version <from_trade_id> <to_trade_id> <link_type> --version <n>
It is addressed at trading.v1.trade_links_versions.get.
trade_links version 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ --version 1