How do I run the system_settings commands from the shell?

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:

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

It is addressed at variability.v1.system_settings.list.

system_settings list --limit 1

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:

system_settings get <name>

It is addressed at variability.v1.system_settings.get.

system_settings get __none__

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

The command is shaped like this:

system_settings get-many <name>

It is addressed at variability.v1.system_settings.get_many.

system_settings get-many __none__

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:

system_settings add <name> <party_id> <value> <data_type> <description> <reason> <commentary>

It is addressed at variability.v1.system_settings.put.

system_settings add __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ system.new_record generated_script

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:

system_settings set <id> <name> <party_id> <value> <data_type> <description> <reason> <commentary> [--version <n>]

It is addressed at variability.v1.system_settings.put.

system_settings set 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ system.new_record generated_script

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:

system_settings put-many --count <n> <id> <name> <party_id> <value> <data_type> <description> <reason> <commentary>

It is addressed at variability.v1.system_settings.put_many.

system_settings put-many --count 1 00000000-0000-0000-0000-000000000000 __none__ 00000000-0000-0000-0000-000000000000 __none__ __none__ __none__ system.new_record generated_script

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:

system_settings delete <name> <reason> <commentary> [--version <n>]

It is addressed at variability.v1.system_settings.delete.

system_settings delete __none__ system.new_record generated_script

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:

system_settings delete-many <name> <reason> <commentary>

It is addressed at variability.v1.system_settings.delete_many.

system_settings delete-many __none__ system.new_record generated_script

Reads the row's recorded history, newest first.

The command is shaped like this:

system_settings versions <name> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at variability.v1.system_settings_versions.list.

system_settings versions __none__ --limit 1

Reads one recorded version of the row.

The command is shaped like this:

system_settings version <name> --version <n>

It is addressed at variability.v1.system_settings_versions.get.

system_settings version __none__ --version 1