How do I run the workflow_plan_dependencies commands from the shell?

Table of Contents

This file documents the workflow_plan_dependencies resource at the shell, one section per command. Every command is a subcommand of workflow_plan_dependencies, 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_plan_dependencies list [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at workflow.v1.workflow_plan_dependencies.list.

workflow_plan_dependencies 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_plan_dependencies get <id>

It is addressed at workflow.v1.workflow_plan_dependencies.get.

workflow_plan_dependencies 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_plan_dependencies get-many <id>

It is addressed at workflow.v1.workflow_plan_dependencies.get_many.

workflow_plan_dependencies 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_plan_dependencies add <workflow_id> <consumer_step_index> <producer_step_index> <reason> <commentary>

It is addressed at workflow.v1.workflow_plan_dependencies.put.

workflow_plan_dependencies add 00000000-0000-0000-0000-000000000000 0 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:

workflow_plan_dependencies set <id> <workflow_id> <consumer_step_index> <producer_step_index> <reason> <commentary> [--version <n>]

It is addressed at workflow.v1.workflow_plan_dependencies.put.

workflow_plan_dependencies set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 0 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:

workflow_plan_dependencies put-many --count <n> <id> <workflow_id> <consumer_step_index> <producer_step_index> <reason> <commentary>

It is addressed at workflow.v1.workflow_plan_dependencies.put_many.

workflow_plan_dependencies put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 0 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:

workflow_plan_dependencies delete <id> <reason> <commentary> [--version <n>]

It is addressed at workflow.v1.workflow_plan_dependencies.delete.

workflow_plan_dependencies 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_plan_dependencies delete-many <id> <reason> <commentary>

It is addressed at workflow.v1.workflow_plan_dependencies.delete_many.

workflow_plan_dependencies delete-many 00000000-0000-0000-0000-000000000000 system.new_record generated_script

1.9. by-workflow-id

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:

workflow_plan_dependencies by-workflow-id <workflow_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at workflow.v1.workflow_plan_dependencies.list_by_workflow_id.

workflow_plan_dependencies by-workflow-id 00000000-0000-0000-0000-000000000000 --limit 1

1.10. versions

Reads the row's recorded history, newest first.

The command is shaped like this:

workflow_plan_dependencies versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at workflow.v1.workflow_plan_dependencies_versions.list.

workflow_plan_dependencies versions 00000000-0000-0000-0000-000000000000 --limit 1

1.11. version

Reads one recorded version of the row.

The command is shaped like this:

workflow_plan_dependencies version <id> --version <n>

It is addressed at workflow.v1.workflow_plan_dependencies_versions.get.

workflow_plan_dependencies version 00000000-0000-0000-0000-000000000000 --version 1

Emacs 29.3 (Org mode 9.6.15)