How do I run the report_definitions commands from the shell?
Table of Contents
This file documents the report_definitions resource at the shell, one section per command. Every command is a subcommand of report_definitions, 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:
report_definitions list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at dq.v1.report_definitions.list.
report_definitions 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:
report_definitions get <id>
It is addressed at dq.v1.report_definitions.get.
report_definitions 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:
report_definitions get-many <id>
It is addressed at dq.v1.report_definitions.get_many.
report_definitions get-many 00000000-0000-0000-0000-000000000000
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:
report_definitions add <name> <description> <report_type> <schedule_expression> <concurrency_policy> <display_order> <reason> <commentary>
It is addressed at dq.v1.report_definitions.put.
report_definitions add __none__ - __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:
report_definitions set <id> <name> <description> <report_type> <schedule_expression> <concurrency_policy> <display_order> <reason> <commentary> [--version <n>]
It is addressed at dq.v1.report_definitions.put.
report_definitions set 00000000-0000-0000-0000-000000000000 __none__ - __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:
report_definitions put-many --count <n> <id> <name> <description> <report_type> <schedule_expression> <concurrency_policy> <display_order> <reason> <commentary>
It is addressed at dq.v1.report_definitions.put_many.
report_definitions put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ - __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:
report_definitions delete <id> <reason> <commentary> [--version <n>]
It is addressed at dq.v1.report_definitions.delete.
report_definitions delete 00000000-0000-0000-0000-000000000000 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:
report_definitions delete-many <id> <reason> <commentary>
It is addressed at dq.v1.report_definitions.delete_many.
report_definitions delete-many 00000000-0000-0000-0000-000000000000 system.new_record generated_script
1.9. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
report_definitions versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at dq.v1.report_definitions_versions.list.
report_definitions versions 00000000-0000-0000-0000-000000000000 --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
report_definitions version <id> --version <n>
It is addressed at dq.v1.report_definitions_versions.get.
report_definitions version 00000000-0000-0000-0000-000000000000 --version 1