How do I run the synthetic_fx_spot_configs commands from the shell?
Table of Contents
This file documents the synthetic_fx_spot_configs resource at the shell, one section per command. Every command is a subcommand of synthetic_fx_spot_configs, 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:
synthetic_fx_spot_configs list [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at dq.v1.synthetic_fx_spot_configs.list.
synthetic_fx_spot_configs 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:
synthetic_fx_spot_configs get <id>
It is addressed at dq.v1.synthetic_fx_spot_configs.get.
synthetic_fx_spot_configs 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:
synthetic_fx_spot_configs get-many <id>
It is addressed at dq.v1.synthetic_fx_spot_configs.get_many.
synthetic_fx_spot_configs 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:
synthetic_fx_spot_configs add <name> <description> <enabled> <auto_start> <base_currency_code> <quote_currency_code> <gmm_initial_price> <ticks_per_hour> <process_type> <price_source> <vintage_source> <vintage_date> <reason> <commentary>
It is addressed at dq.v1.synthetic_fx_spot_configs.put.
synthetic_fx_spot_configs add __none__ - false false __none__ __none__ 0 0 __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:
synthetic_fx_spot_configs set <id> <name> <description> <enabled> <auto_start> <base_currency_code> <quote_currency_code> <gmm_initial_price> <ticks_per_hour> <process_type> <price_source> <vintage_source> <vintage_date> <reason> <commentary> [--version <n>]
It is addressed at dq.v1.synthetic_fx_spot_configs.put.
synthetic_fx_spot_configs set 00000000-0000-0000-0000-000000000000 __none__ - false false __none__ __none__ 0 0 __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:
synthetic_fx_spot_configs put-many --count <n> <id> <name> <description> <enabled> <auto_start> <base_currency_code> <quote_currency_code> <gmm_initial_price> <ticks_per_hour> <process_type> <price_source> <vintage_source> <vintage_date> <reason> <commentary>
It is addressed at dq.v1.synthetic_fx_spot_configs.put_many.
synthetic_fx_spot_configs put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ - false false __none__ __none__ 0 0 __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:
synthetic_fx_spot_configs delete <id> <reason> <commentary> [--version <n>]
It is addressed at dq.v1.synthetic_fx_spot_configs.delete.
synthetic_fx_spot_configs 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:
synthetic_fx_spot_configs delete-many <id> <reason> <commentary>
It is addressed at dq.v1.synthetic_fx_spot_configs.delete_many.
synthetic_fx_spot_configs delete-many 00000000-0000-0000-0000-000000000000 system.new_record generated_script
1.9. versions
Reads the row's recorded history, newest first.
The command is shaped like this:
synthetic_fx_spot_configs versions <id> [--offset <n>] [--limit <n>] [--order <field>] [--desc]
It is addressed at dq.v1.synthetic_fx_spot_configs_versions.list.
synthetic_fx_spot_configs versions 00000000-0000-0000-0000-000000000000 --limit 1
1.10. version
Reads one recorded version of the row.
The command is shaped like this:
synthetic_fx_spot_configs version <id> --version <n>
It is addressed at dq.v1.synthetic_fx_spot_configs_versions.get.
synthetic_fx_spot_configs version 00000000-0000-0000-0000-000000000000 --version 1