How do I run the party_countries commands from the shell?

Table of Contents

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

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

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

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

party_countries get <party_id> <country_alpha2_code>

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

party_countries get 00000000-0000-0000-0000-000000000000 __none__

1.3. get-many

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

The command is shaped like this:

party_countries get-many <party_id> <country_alpha2_code>

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

party_countries get-many 00000000-0000-0000-0000-000000000000 __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:

party_countries add <party_id> <country_alpha2_code> <reason> <commentary>

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

party_countries add 00000000-0000-0000-0000-000000000000 __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:

party_countries set <party_id> <country_alpha2_code> <reason> <commentary> [--version <n>]

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

party_countries set 00000000-0000-0000-0000-000000000000 __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:

party_countries put-many --count <n> <party_id> <country_alpha2_code> <reason> <commentary>

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

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

party_countries delete <party_id> <country_alpha2_code> <reason> <commentary> [--version <n>]

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

party_countries delete 00000000-0000-0000-0000-000000000000 __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:

party_countries delete-many <party_id> <country_alpha2_code> <reason> <commentary>

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

party_countries delete-many 00000000-0000-0000-0000-000000000000 __none__ system.new_record generated_script

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

party_countries by-party-id <party_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.party_countries.list_by_party_id.

party_countries by-party-id 00000000-0000-0000-0000-000000000000 --limit 1

Emacs 29.3 (Org mode 9.6.15)