Skip to main content

perpetual parser

Manage parsers.

perpetual parser create​

Create a new parser.

perpetual parser 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 parser belongs to (INT_*).
--namestringRequiredParser name.
--querystringRequiredHamelin query that extracts fields from connector data.
--connector-idsstring, repeatableOptionalConnector IDs the parser reads from (comma-separated or repeated).
--deploybooleanOptionalWhether to deploy the parser (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 parser delete​

Delete a parser.

perpetual parser 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
idRequiredParser ID (PRS_*).

Flags​

FlagTypeRequiredDescription
--integrationstringOptionalIntegration (INT_*) that owns the parser; 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 parser export​

Write a parser as a GitOps file.

perpetual parser 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
idRequiredParser ID (PRS_*).

Flags​

FlagTypeRequiredDescription
--dirstringOptionalDirectory for a new file (default .).
--filestringOptionalExisting .parser.yaml/.json file to edit in place.
--integrationstringOptionalIntegration (INT_*) that owns the parser; skips the org-wide search for it.

Also accepts the global flags, including the sign-in flags.

perpetual parser get​

Get a parser.

perpetual parser 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
idRequiredParser ID (PRS_*).

Flags​

FlagTypeRequiredDescription
--integrationstringOptionalIntegration (INT_*) that owns the parser; skips the org-wide search for it.

Also accepts the global flags, including the sign-in flags.

perpetual parser list​

List parsers.

perpetual parser 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 parsers (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 parser update​

Update a parser.

perpetual parser update <parserId> [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
parserIdRequiredParser ID.

Flags​

FlagTypeRequiredDescription
--integrationstringRequiredIntegration ID the parser belongs to (INT_*).
--namestringOptionalNew parser name.
--querystringOptionalNew Hamelin query.
--connector-idsstring, repeatableOptionalNew connector IDs (comma-separated or repeated).
--deploybooleanOptionalWhether to deploy the parser.
--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