How do I run the workflow_instances commands from the shell?
Table of Contents
This file documents the workflow_instances resource at the shell, one section per command. Every command is a subcommand of workflow_instances, 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:
workflow_instances list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at workflow.v1.workflow_instances.list.
workflow_instances 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:
workflow_instances get <id>
It is addressed at workflow.v1.workflow_instances.get.
workflow_instances 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:
workflow_instances get-many <id>
It is addressed at workflow.v1.workflow_instances.get_many.
workflow_instances 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:
workflow_instances add <type> <state_id> <request_json> <result_json> <error> <correlation_id> <created_by> <current_step_index> <step_count> <materialised_steps_json> <completed_at> <last_event_at> <reason> <commentary>
It is addressed at workflow.v1.workflow_instances.put.
workflow_instances add __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ 0 0 __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:
workflow_instances set <id> <type> <state_id> <request_json> <result_json> <error> <correlation_id> <created_by> <current_step_index> <step_count> <materialised_steps_json> <completed_at> <last_event_at> <reason> <commentary> [--version <n>]
It is addressed at workflow.v1.workflow_instances.put.
workflow_instances set 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ 0 0 __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:
workflow_instances put-many --count <n> <id> <type> <state_id> <request_json> <result_json> <error> <correlation_id> <created_by> <current_step_index> <step_count> <materialised_steps_json> <completed_at> <last_event_at> <reason> <commentary>
It is addressed at workflow.v1.workflow_instances.put_many.
workflow_instances put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ 0 0 __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:
workflow_instances delete <id> <reason> <commentary> [--version <n>]
It is addressed at workflow.v1.workflow_instances.delete.
workflow_instances 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:
workflow_instances delete-many <id> <reason> <commentary>
It is addressed at workflow.v1.workflow_instances.delete_many.
workflow_instances 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:
workflow_instances versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at workflow.v1.workflow_instances_versions.list.
workflow_instances versions 00000000-0000-0000-0000-000000000000 --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
workflow_instances version <id> --version <n>
It is addressed at workflow.v1.workflow_instances_versions.get.
workflow_instances version 00000000-0000-0000-0000-000000000000 --version 1