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