Querying metadata in the system

See information on querying metadata in Helix IPLM, including fields that are available to search, and examples.

Searching in PiCLI

Details on the use of the Helix IPLM query language and Saved queries can be found on their respective pages.

Metadata Related Fields for use in Queries

Attributes, Labels, and Properties can be queried via the query language, but they are queried via the -q or -sq options associated with the primary objects to which they are associated (IP, Library, Saved query, etc), rather than directly via the commands used to list labels, attributes, and properties.

Attributes

  • creation_timestamp (integer)

  • creator (user)

  • name (string)

  • value (string)

Labels

  • color (string)

  • creation_timestamp (integer)

  • creator (user)

  • name (string)

Properties

Properties are queried directly via their name and value.

Example queries

All Libraries with Label1 or Label2 Attached 
> pi lib ls -q 'any(labels, {it = "project" or it = "analog"})'
┌──────────┬───────────┬──────────────────────────────────────────┬─────────┐
│ NAME     │ VENDOR    │ DESCRIPTION                              │ LABELS  │
╞══════════╪═══════════╪══════════════════════════════════════════╪═════════╡
│ tutorial │ Helix │ The Helix tutorial SoC project, a    │ project │
│          │           │ mixed signal automotive project based on │         │
│          │           │ TMS 90nm technology                      │         │
└──────────┴───────────┴──────────────────────────────────────────┴─────────┘
Found 1 matching object(s).

Find All Libraries with a Particular Attribute Name 
> pi lib ls  -q 'any(attributes, {it.name=="FAQ"})'
┌──────────┬───────────┬──────────────────────────────────────────┬─────────┐
│ NAME     │ VENDOR    │ DESCRIPTION                              │ LABELS  │
╞══════════╪═══════════╪══════════════════════════════════════════╪═════════╡
│ tutorial │ Helix │ The Helix tutorial SoC project, a    │ project │
│          │           │ mixed signal automotive project based on │         │
│          │           │ TMS 90nm technology                      │         │
└──────────┴───────────┴──────────────────────────────────────────┴─────────┘
Found 1 matching object(s).
IPs by Property Value 
> pi ip ls -q 'prop1="test1"'
┌──────────────────────┬────┬─────────────┬────────────┬────────────┬─────────────────┐
│ NAME                 │ DM │ ALIASES     │ CREATED BY │ CREATED ON │ VERSION MESSAGE │
╞══════════════════════╪════╪═════════════╪════════════╪════════════╪═════════════════╡
│ drinks.beer@1.TRUNK  │ P4 │ HEAD LATEST │            │            │ Version one     │
│ drinks.vodka@1.TRUNK │ P4 │ HEAD LATEST │            │            │ Version one     │
└──────────────────────┴────┴─────────────┴────────────┴────────────┴─────────────────┘