How do I run the draft_reasons commands from the shell?
Table of Contents
This file documents the draft_reasons resource at the shell, one section per command. Every command is a subcommand of draft_reasons, 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:
draft_reasons list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at trading.v1.draft_reasons.list.
draft_reasons 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:
draft_reasons get <code>
It is addressed at trading.v1.draft_reasons.get.
draft_reasons get __none__
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
draft_reasons get-many <code>
It is addressed at trading.v1.draft_reasons.get_many.
draft_reasons 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:
draft_reasons add <code> <description> <responsible_role> <reason> <commentary>
It is addressed at trading.v1.draft_reasons.put.
draft_reasons add __none__ __none__ __none__ 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:
draft_reasons set <code> <description> <responsible_role> <reason> <commentary> [--version <n>]
It is addressed at trading.v1.draft_reasons.put.
draft_reasons set __none__ __none__ __none__ 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:
draft_reasons put-many --count <n> <code> <description> <responsible_role> <reason> <commentary>
It is addressed at trading.v1.draft_reasons.put_many.
draft_reasons put-many --count 1 __none__ __none__ __none__ 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:
draft_reasons delete <code> <reason> <commentary> [--version <n>]
It is addressed at trading.v1.draft_reasons.delete.
draft_reasons 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:
draft_reasons delete-many <code> <reason> <commentary>
It is addressed at trading.v1.draft_reasons.delete_many.
draft_reasons 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:
draft_reasons versions <code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at trading.v1.draft_reasons_versions.list.
draft_reasons versions __none__ --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
draft_reasons version <code> --version <n>
It is addressed at trading.v1.draft_reasons_versions.get.
draft_reasons version __none__ --version 1