How do I run the books commands from the shell?
Table of Contents
This file documents the books resource at the shell, one section per command. Every command is a subcommand of books, 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:
books list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.books.list.
books 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:
books get <id>
It is addressed at refdata.v1.books.get.
books 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:
books get-many <id>
It is addressed at refdata.v1.books.get_many.
books 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:
books add <id> <name> <description> <parent_portfolio_id> <owner_unit_id> <functional_currency> <gl_account_ref> <cost_center> <book_status> <regulatory_book_type> <is_sweepable> <rates_centre_code> <reason> <commentary>
It is addressed at refdata.v1.books.put.
books add 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ __none__ false __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:
books set <id> <name> <description> <parent_portfolio_id> <owner_unit_id> <functional_currency> <gl_account_ref> <cost_center> <book_status> <regulatory_book_type> <is_sweepable> <rates_centre_code> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.books.put.
books set 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ __none__ false __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:
books put-many --count <n> <id> <name> <description> <parent_portfolio_id> <owner_unit_id> <functional_currency> <gl_account_ref> <cost_center> <book_status> <regulatory_book_type> <is_sweepable> <rates_centre_code> <reason> <commentary>
It is addressed at refdata.v1.books.put_many.
books put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ __none__ __none__ __none__ false __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:
books delete <id> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.books.delete.
books 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:
books delete-many <id> <reason> <commentary>
It is addressed at refdata.v1.books.delete_many.
books delete-many 00000000-0000-0000-0000-000000000000 system.new_record generated_script
1.9. by-parent-portfolio-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:
books by-parent-portfolio-id <parent_portfolio_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.books.list_by_parent_portfolio_id.
books by-parent-portfolio-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:
books versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.books_versions.list.
books versions 00000000-0000-0000-0000-000000000000 --limit 1
1.11. version
Reads one recorded version of the row.
The command is shaped like this:
books version <id> --version <n>
It is addressed at refdata.v1.books_versions.get.
books version 00000000-0000-0000-0000-000000000000 --version 1