... | ... | @@ -176,27 +176,28 @@ The flags are: |
|
|
|
|
|
## `list`
|
|
|
|
|
|
You can list data e.g. as follows:
|
|
|
Use the `pepcli list` command to determine which data is available in PEP:
|
|
|
|
|
|
```
|
|
|
pepcli list -C <column group> -P <participant group> -T <ticket out file>
|
|
|
```
|
|
|
|
|
|
This will list the data that is in PEP, in json format. If a data entry is short enough, it will be displayed directly in the output. For larger entries it will display an id, which can be used with the [`get` command](#get). There are flags to change this behaviour.
|
|
|
The command outputs its information as a JSON array with one entry per subject. Every such entry contains the subject's polymorphic pseudonym, plus an array listing the columns in which data is stored for the subject. If the data is short enough, it will be included directly in the output. For larger entries, the output will include an id that can be used with the [`get` command](#get). There are flags to change this behavior.
|
|
|
|
|
|
Important flags are:
|
|
|
|
|
|
- `-C` Column group to list data for. Can be repeated if you want data for more than one column group. There is a special column group `*` that contains all columns.
|
|
|
- `-c` Specific column to list data for. Can be repeated, and combined with `-C` if you want multiple columns and column groups
|
|
|
- `-P` Participant group to list data for. Can be repeated if you want data for more than one participant group. There is a special participant group `*` that contains all participants.
|
|
|
- `-p` Specific participant to list data for. Can be repeated, and combined with `-P` if you want mulitple participants and participant groups
|
|
|
- `-p` Specific participant to list data for. Can be repeated, and combined with `-P` if you want multiple participants and participant groups
|
|
|
- `-l` Include the local pseudonyms in the output. By default pepcli will only show polymorphic pseudonyms (PP). These are not constant, and cannot be used to see whether data belongs to the same participant. You need the local pseudonyms (LP) for that.
|
|
|
- `-T` The first thing PEP does when you interact with it, is checking whether you have access to the partipant(group)s and column(group)s you request. If you do have access, it will hand out a ticket. You can store this ticket with the `-T` flag, to use it for later actions.
|
|
|
- `-T` The first thing PEP does when you interact with it, is checking whether you have access to the participant(group)s and column(group)s you request. If you do have access, it will hand out a ticket. You can store this ticket with the `-T` flag, to use it for later actions.
|
|
|
- `-t` You can pass a ticket from an earlier request with the `-t` flag. The column(group)s and participant(group)s of this request must be a subset of the earlier request.
|
|
|
- `-s` The size limit (in bytes) for data that should be inlined. Currently defaults to 1000. Setting this to 0 means that data wil ALWAYS be inlined
|
|
|
- `-s` The size limit (in bytes) for data that should be inlined, i.e. be included the the `list` command's output. Currently defaults to 1000. Setting this to 0 means that data will ALWAYS be inlined
|
|
|
- `--no-inline-data` Never inline data
|
|
|
- `-g` Data MAY show up grouped, when it belongs to the same participant. By default this depends on the order in which data comes in, so this grouping is not guaranteed. Use `-g` to force grouping of data. This may impact performance.
|
|
|
|
|
|
Note: Shells use `*` for globbing. We do not want this behaviour, so make sure you escape it with a backslash or double quotes when invoking pepcli from e.g. bash.
|
|
|
Note: Shells use `*` for globbing. We do not want this behavior, so make sure you escape it with a backslash or double quotes when invoking pepcli from e.g. bash.
|
|
|
|
|
|
## `pull`
|
|
|
|
... | ... | |