How do I run the tenor_schedules commands from the shell?

Table of Contents

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

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

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

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

tenor_schedules get <code>

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

tenor_schedules get __none__

1.3. get-many

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

The command is shaped like this:

tenor_schedules get-many <code>

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

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

tenor_schedules add <code> <name> <description> <display_order> <schedule_source> <calendar_code> <diary_entry_type> <reason> <commentary>

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

tenor_schedules add __none__ __none__ __none__ 0 __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:

tenor_schedules set <code> <name> <description> <display_order> <schedule_source> <calendar_code> <diary_entry_type> <reason> <commentary> [--version <n>]

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

tenor_schedules set __none__ __none__ __none__ 0 __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:

tenor_schedules put-many --count <n> <code> <name> <description> <display_order> <schedule_source> <calendar_code> <diary_entry_type> <reason> <commentary>

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

tenor_schedules put-many --count 1 __none__ __none__ __none__ 0 __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:

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

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

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

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

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

tenor_schedules delete-many __none__ system.new_record generated_script

1.9. by-calendar-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:

tenor_schedules by-calendar-code <calendar_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.tenor_schedules.list_by_calendar_code.

tenor_schedules by-calendar-code __none__ --limit 1

1.10. by-diary-entry-type

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:

tenor_schedules by-diary-entry-type <diary_entry_type> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.tenor_schedules.list_by_diary_entry_type.

tenor_schedules by-diary-entry-type __none__ --limit 1

1.11. versions

Reads the row's recorded history, newest first.

The command is shaped like this:

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

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

tenor_schedules versions __none__ --limit 1

1.12. version

Reads one recorded version of the row.

The command is shaped like this:

tenor_schedules version <code> --version <n>

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

tenor_schedules version __none__ --version 1

Emacs 29.3 (Org mode 9.6.15)