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