How do I run the cuts commands from the shell?
Table of Contents
This file documents the cuts resource at the shell, one section per command. Every command is a subcommand of cuts, 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:
cuts list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at reporting.v1.cuts.list.
cuts 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:
cuts get <id>
It is addressed at reporting.v1.cuts.get.
cuts 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:
cuts get-many <id>
It is addressed at reporting.v1.cuts.get_many.
cuts get-many 00000000-0000-0000-0000-000000000000
1.4. by-kind-code
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:
cuts by-kind-code <kind_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at reporting.v1.cuts.list_by_kind_code.
cuts by-kind-code __none__ --limit 1
1.5. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
cuts versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at reporting.v1.cuts_versions.list.
cuts versions 00000000-0000-0000-0000-000000000000 --limit 1
1.6. version
Reads one recorded version of the row.
The command is shaped like this:
cuts version <id> --version <n>
It is addressed at reporting.v1.cuts_versions.get.
cuts version 00000000-0000-0000-0000-000000000000 --version 1