How do I run the purpose_types 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:

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

It is addressed at refdata.v1.purpose_types.list.

purpose_types 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:

purpose_types get <code>

It is addressed at refdata.v1.purpose_types.get.

purpose_types get __none__

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

The command is shaped like this:

purpose_types get-many <code>

It is addressed at refdata.v1.purpose_types.get_many.

purpose_types 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:

purpose_types add <code> <name> <description> <display_order> <reason> <commentary>

It is addressed at refdata.v1.purpose_types.put.

purpose_types add __none__ __none__ __none__ 0 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:

purpose_types set <code> <name> <description> <display_order> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.purpose_types.put.

purpose_types set __none__ __none__ __none__ 0 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:

purpose_types put-many --count <n> <code> <name> <description> <display_order> <reason> <commentary>

It is addressed at refdata.v1.purpose_types.put_many.

purpose_types put-many --count 1 __none__ __none__ __none__ 0 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:

purpose_types delete <code> <reason> <commentary> [--version <n>]

It is addressed at refdata.v1.purpose_types.delete.

purpose_types 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:

purpose_types delete-many <code> <reason> <commentary>

It is addressed at refdata.v1.purpose_types.delete_many.

purpose_types delete-many __none__ system.new_record generated_script

Reads the row's recorded history, newest first.

The command is shaped like this:

purpose_types versions <code> [--offset <n>] [--limit <n>] [--order <field>] [--desc]

It is addressed at refdata.v1.purpose_types_versions.list.

purpose_types versions __none__ --limit 1

Reads one recorded version of the row.

The command is shaped like this:

purpose_types version <code> --version <n>

It is addressed at refdata.v1.purpose_types_versions.get.

purpose_types version __none__ --version 1