DocsWorkflowsComponentsDatadata:list:compare

data:list:compare

Sorts two lists of items into buckets by comparing them key by key. Items pair up through the configured key paths, so the two lists may name the same thing differently. A pair whose compared values all agree is the same. A pair whose values disagree is classified against the base, which is git's three-way merge question and the only reason a base is accepted at all. The side that still equals the base did not move, so a pair lands in a_moved, b_moved or both_moved and a caller reads the merge policy straight off the bucket name instead of re-deriving it a step later. A pair with no base for its key is different, since nothing there says which side moved. Every bucket is emitted in key order and nothing is written anywhere.

Options

Name	Type	Description
`a`	`[]map[string]any`	The first list of items
`b`	`[]map[string]any`	The second list of items
`base`	`[]map[string]any`	The shared ancestor both lists were derived from
`keys`	`[]CompareField`	The paths whose values identify the same item in each list
↳ `a`	`string`	The dotted path read from list A
↳ `b`	`string`	The dotted path read from list B
↳ `base`	`string`	The dotted path read from the base list
`compare`	`[]CompareField`	The paths whose values decide whether two paired items are the same
↳ `a`	`string`	The dotted path read from list A
↳ `b`	`string`	The dotted path read from list B
↳ `base`	`string`	The dotted path read from the base list

Outputs

Name	Type	Description
`only_in_a`	`[]CompareItem`	The items whose key appears in A and not in B
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `item`	`map[string]any`	The item as it appears in its own list
`only_in_b`	`[]CompareItem`	The items whose key appears in B and not in A
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `item`	`map[string]any`	The item as it appears in its own list
`same`	`[]ComparePair`	The paired items whose compared values all agree
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `a`	`map[string]any`	The item as it appears in list A
↳ `b`	`map[string]any`	The item as it appears in list B
↳ `base`	`map[string]any`	The item as it appears in the base list
`different`	`[]ComparePair`	The paired items whose compared values disagree and that have no base to say which side moved
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `a`	`map[string]any`	The item as it appears in list A
↳ `b`	`map[string]any`	The item as it appears in list B
↳ `base`	`map[string]any`	The item as it appears in the base list
`a_moved`	`[]ComparePair`	The paired items where A moved away from the base and B did not
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `a`	`map[string]any`	The item as it appears in list A
↳ `b`	`map[string]any`	The item as it appears in list B
↳ `base`	`map[string]any`	The item as it appears in the base list
`b_moved`	`[]ComparePair`	The paired items where B moved away from the base and A did not
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `a`	`map[string]any`	The item as it appears in list A
↳ `b`	`map[string]any`	The item as it appears in list B
↳ `base`	`map[string]any`	The item as it appears in the base list
`both_moved`	`[]ComparePair`	The paired items where both sides moved away from the base
↳ `key`	`[]any`	The identifying values read through the configured key paths
↳ `a`	`map[string]any`	The item as it appears in list A
↳ `b`	`map[string]any`	The item as it appears in list B
↳ `base`	`map[string]any`	The item as it appears in the base list
`counts`	`ListCompareCounts`	The size of every bucket
↳ `only_in_a`	`int`
↳ `only_in_b`	`int`
↳ `same`	`int`
↳ `different`	`int`
↳ `a_moved`	`int`
↳ `b_moved`	`int`
↳ `both_moved`	`int`

Example

name: Compare a product list against the store
actions:
  - name: changes
    component: data:list:compare
    vars:
      a: "{{ var.products }}"
      b: "{{ var.store }}"
      keys:
        - a: sku
          b: product_sku
      compare:
        - a: price
          b: unit_price

outputs:
  only_in_a: "{{ changes.only_in_a }}"
  only_in_b: "{{ changes.only_in_b }}"
  different: "{{ changes.different }}"
  counts: "{{ changes.counts }}"

Edit or read the source on GitHub