Skip to main content

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​

FlagTypeRequiredDescription
--integrationstringRequiredIntegration ID the mapper belongs to (INT_*).
--namestringRequiredMapper name.
--querystringRequiredHamelin query mapping parsed tables to the ECS view.
--parser-idsstring, repeatableOptionalParser IDs the mapper reads from (comma-separated or repeated).
--deploybooleanOptionalWhether to deploy the mapper (default: false).
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredMapper ID (MPR_*).

Flags​

FlagTypeRequiredDescription
--integrationstringOptionalIntegration (INT_*) that owns the mapper; skips the org-wide search for it.
--base-versionstringOptionalExpected current version for optimistic concurrency.
--changesetstringOptionalChangeset (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​

ArgumentRequiredDescription
idRequiredMapper ID (MPR_*).

Flags​

FlagTypeRequiredDescription
--dirstringOptionalDirectory for a new file (default .).
--filestringOptionalExisting .mapper.yaml/.json file to edit in place.
--integrationstringOptionalIntegration (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​

ArgumentRequiredDescription
idRequiredMapper ID (MPR_*).

Flags​

FlagTypeRequiredDescription
--integrationstringOptionalIntegration (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​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated.
--filterstringOptionalRaw OData $filter expression, passed to the server as is.
--integrationstringOptionalOnly this integration's mappers (INT_*), read from its endpoint; not with --space.
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch 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​

ArgumentRequiredDescription
mapperIdRequiredMapper ID.

Flags​

FlagTypeRequiredDescription
--integrationstringRequiredIntegration ID the mapper belongs to (INT_*).
--namestringOptionalNew mapper name.
--querystringOptionalNew Hamelin query.
--parser-idsstring, repeatableOptionalNew parser IDs (comma-separated or repeated).
--deploybooleanOptionalWhether to deploy the mapper.
--base-versionstringOptionalExpected current version for optimistic concurrency.
--changesetstringOptionalChangeset (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