How do I run the composite_inputs commands from the shell?
Table of Contents
This file documents the composite_inputs resource at the shell, one section per command. Every command is a subcommand of composite_inputs, 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:
composite_inputs list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at marketdata.v1.composite_inputs.list.
composite_inputs 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:
composite_inputs get <oresmd_uri>
It is addressed at marketdata.v1.composite_inputs.get.
composite_inputs get __none__
1.3. get-many
Reads several rows in one request, one key group per row.
The command is shaped like this:
composite_inputs get-many <oresmd_uri>
It is addressed at marketdata.v1.composite_inputs.get_many.
composite_inputs 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:
composite_inputs add <composite_id> <provider_code> <oresmd_uri> <position> <reason> <commentary>
It is addressed at marketdata.v1.composite_inputs.put.
composite_inputs add 00000000-0000-0000-0000-000000000000 __none__ __none__ 0 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:
composite_inputs set <id> <composite_id> <provider_code> <oresmd_uri> <position> <reason> <commentary> [--version <n>]
It is addressed at marketdata.v1.composite_inputs.put.
composite_inputs set 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ __none__ 0 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:
composite_inputs put-many --count <n> <id> <composite_id> <provider_code> <oresmd_uri> <position> <reason> <commentary>
It is addressed at marketdata.v1.composite_inputs.put_many.
composite_inputs put-many --count 1 00000000-0000-0000-0000-000000000000 00000000-0000-0000-0000-000000000000 __none__ __none__ 0 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:
composite_inputs delete <oresmd_uri> <reason> <commentary> [--version <n>]
It is addressed at marketdata.v1.composite_inputs.delete.
composite_inputs 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:
composite_inputs delete-many <oresmd_uri> <reason> <commentary>
It is addressed at marketdata.v1.composite_inputs.delete_many.
composite_inputs delete-many __none__ system.new_record generated_script
1.9. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
composite_inputs versions <oresmd_uri> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at marketdata.v1.composite_inputs_versions.list.
composite_inputs versions __none__ --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
composite_inputs version <oresmd_uri> --version <n>
It is addressed at marketdata.v1.composite_inputs_versions.get.
composite_inputs version __none__ --version 1