How do I run the leg_types commands from the shell?

Table of Contents

This file documents the leg_types resource at the shell, one section per command. Every command is a subcommand of leg_types, 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:

leg_types list [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.leg_types.list.

leg_types 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:

leg_types get <code>

It is addressed at refdata.v1.leg_types.get.

leg_types get __none__

1.3. get-many

Reads several rows in one request, one key group per row.

The command is shaped like this:

leg_types get-many <code>

It is addressed at refdata.v1.leg_types.get_many.

leg_types 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:

leg_types add <code> <description> <reason> <commentary>

It is addressed at refdata.v1.leg_types.put.

leg_types add __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:

leg_types set <code> <description> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.leg_types.put.

leg_types set __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:

leg_types put-many --count <n> <code> <description> <reason> <commentary>

It is addressed at refdata.v1.leg_types.put_many.

leg_types put-many --count 1 __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:

leg_types delete <code> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.leg_types.delete.

leg_types 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:

leg_types delete-many <code> <reason> <commentary>

It is addressed at refdata.v1.leg_types.delete_many.

leg_types 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:

leg_types versions <code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.leg_types_versions.list.

leg_types versions __none__ --limit 1

1.10. version

Reads one recorded version of the row.

The command is shaped like this:

leg_types version <code> --version <n>

It is addressed at refdata.v1.leg_types_versions.get.

leg_types version __none__ --version 1

Emacs 29.3 (Org mode 9.6.15)