perpetual mapper
Manage mappers.
perpetual mapper create
Create a new mapper.
perpetual mapper create [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Required | Integration ID the mapper belongs to (INT_*). |
--name | string | Required | Mapper name. |
--query | string | Required | Hamelin query mapping parsed tables to the ECS view. |
--parser-ids | string, repeatable | Optional | Parser IDs the mapper reads from (comma-separated or repeated). |
--deploy | boolean | Optional | Whether to deploy the mapper (default: false). |
--changeset | string | Optional | Changeset (CHG_*) to stage this create into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual mapper delete
Delete a mapper.
perpetual mapper delete <id> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Mapper ID (MPR_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Optional | Integration (INT_*) that owns the mapper; skips the org-wide search for it. |
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage into; REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
perpetual mapper export
Write a mapper as a GitOps file.
perpetual mapper export <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Mapper ID (MPR_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--dir | string | Optional | Directory for a new file (default .). |
--file | string | Optional | Existing .mapper.yaml/.json file to edit in place. |
--integration | string | Optional | Integration (INT_*) that owns the mapper; skips the org-wide search for it. |
Also accepts the global flags, including the sign-in flags.
perpetual mapper get
Get a mapper.
perpetual mapper get <id> [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
id | Required | Mapper ID (MPR_*). |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Optional | Integration (INT_*) that owns the mapper; skips the org-wide search for it. |
Also accepts the global flags, including the sign-in flags.
perpetual mapper list
List mappers.
perpetual mapper list [flags]
Changes: Stages nothing.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--space | string, repeatable | Optional | Only these spaces: SPC_* ids, comma-separated or repeated. |
--filter | string | Optional | Raw OData $filter expression, passed to the server as is. |
--integration | string | Optional | Only this integration's mappers (INT_*), read from its endpoint; not with --space. |
--top | string | Optional | Items per page (server default 100). |
--skip | string | Optional | Number of items to skip. |
--all | boolean | Optional | Fetch every page (1000 items per request). |
Also accepts the global flags, including the sign-in flags.
perpetual mapper update
Update a mapper.
perpetual mapper update <mapperId> [flags]
Changes: Stages its writes into a changeset.
Output: With --json, prints its result in the JSON envelope and any error in the error envelope.
Arguments
| Argument | Required | Description |
|---|---|---|
mapperId | Required | Mapper ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--integration | string | Required | Integration ID the mapper belongs to (INT_*). |
--name | string | Optional | New mapper name. |
--query | string | Optional | New Hamelin query. |
--parser-ids | string, repeatable | Optional | New parser IDs (comma-separated or repeated). |
--deploy | boolean | Optional | Whether to deploy the mapper. |
--base-version | string | Optional | Expected current version for optimistic concurrency. |
--changeset | string | Optional | Changeset (CHG_*) to stage this update into — REQUIRED (the CLI makes no live changes). |
Also accepts the global flags, including the sign-in flags.
Perpetual CLI 0.5.0