How do I run the currency_calendars commands from the shell?

Table of Contents

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

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

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

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

currency_calendars get <currency_iso_code> <calendar_code>

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

currency_calendars get __none__ __none__

1.3. get-many

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

The command is shaped like this:

currency_calendars get-many <currency_iso_code> <calendar_code>

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

currency_calendars get-many __none__ __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:

currency_calendars add <currency_iso_code> <calendar_code> <reason> <commentary>

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

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

currency_calendars set <currency_iso_code> <calendar_code> <reason> <commentary> [--version <n>]

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

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

currency_calendars put-many --count <n> <currency_iso_code> <calendar_code> <reason> <commentary>

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

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

currency_calendars delete <currency_iso_code> <calendar_code> <reason> <commentary> [--version <n>]

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

currency_calendars delete __none__ __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:

currency_calendars delete-many <currency_iso_code> <calendar_code> <reason> <commentary>

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

currency_calendars delete-many __none__ __none__ system.new_record generated_script

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

currency_calendars by-currency-iso-code <currency_iso_code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.currency_calendars.list_by_currency_iso_code.

currency_calendars by-currency-iso-code __none__ --limit 1

Emacs 29.3 (Org mode 9.6.15)