How do I run the credit_limits commands from the shell?
Table of Contents
This file documents the credit_limits resource at the shell, one section per command. Every command is a subcommand of credit_limits, 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:
credit_limits list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.credit_limits.list.
credit_limits 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:
credit_limits get <code>
It is addressed at refdata.v1.credit_limits.get.
credit_limits get __none__
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
credit_limits get-many <code>
It is addressed at refdata.v1.credit_limits.get_many.
credit_limits 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:
credit_limits add <code> <party_id> <counterparty_id> <limit_amount> <description> <reason> <commentary>
It is addressed at refdata.v1.credit_limits.put.
credit_limits add __none__ 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 - - 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:
credit_limits set <id> <code> <party_id> <counterparty_id> <limit_amount> <description> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.credit_limits.put.
credit_limits set 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 - - 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:
credit_limits put-many --count <n> <id> <code> <party_id> <counterparty_id> <limit_amount> <description> <reason> <commentary>
It is addressed at refdata.v1.credit_limits.put_many.
credit_limits put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 - - 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:
credit_limits delete <code> <reason> <commentary> [--version <n>]
It is addressed at refdata.v1.credit_limits.delete.
credit_limits 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:
credit_limits delete-many <code> <reason> <commentary>
It is addressed at refdata.v1.credit_limits.delete_many.
credit_limits delete-many __none__ system.new_record generated_script
1.9. by-counterparty-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:
credit_limits by-counterparty-id <counterparty_id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.credit_limits.list_by_counterparty_id.
credit_limits by-counterparty-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:
credit_limits versions <code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at refdata.v1.credit_limits_versions.list.
credit_limits versions __none__ --limit 1
1.11. version
Reads one recorded version of the row.
The command is shaped like this:
credit_limits version <code> --version <n>
It is addressed at refdata.v1.credit_limits_versions.get.
credit_limits version __none__ --version 1