Skip to main content

Lookup file

File nameResource
*.lookup.yamlLookup

GitOps file for a single space.

Queries​

The query lives in a Hamelin sidecar file next to this one, named <name>.lookup.hmln.

Identity​

  • originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.
  • id: Server-assigned id. Absent until the resource exists.

Fields​

FieldTypeRequiredDescription
archivedbooleanOptionalDefaults to false.
deploybooleanRequiredWhether the lookup is deployed. A deployed lookup has a backing dataset that queries can join against.
folderstringOptionalA Folder by its originKey (managed in this repo) or its server id (FLD_…).
idstringOptionalServer-assigned id. Absent until the resource exists. Pattern: ^LKP_[A-Z0-9]{1,7}$.
keyColumnsarray of stringRequired
namestringRequiredThe lookup's freeform display name. The backing dataset's schema.name is derived from this server-side.
originKeystringRequiredGitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$.
sourceFormatenumRequiredOne of parsed_lines, csv.
spaceIdstringRequiredSpace the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$.

In a content pack​

A content pack's source directory uses the same file, with these differences:

  • Not used in a pack: deploy, originKey, spaceId.
  • These fields are new in a pack, or have a different type, requirement or meaning there:
FieldTypeRequiredDescription
folderstringOptionalid of a Folder file in the same pack. Omit to place the item at the pack root. Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
idstringRequiredFormat: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

Perpetual CLI 0.5.0