How do I run the lei_relationships commands from the shell?

Table of Contents

This file documents the lei_relationships resource at the shell, one section per command. Every command is a subcommand of lei_relationships, 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:

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

It is addressed at dq.v1.lei_relationships.list.

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

lei_relationships get <relationship_start_node_node_id>

It is addressed at dq.v1.lei_relationships.get.

lei_relationships get __none__

1.3. get-many

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

The command is shaped like this:

lei_relationships get-many <relationship_start_node_node_id>

It is addressed at dq.v1.lei_relationships.get_many.

lei_relationships get-many __none__

Emacs 29.3 (Org mode 9.6.15)