isSuperset

Description

Returns true if array1 is a superset of array2, or false otherwise.

• When comparing array1 and array2, duplicates are discarded. This means two arrays of different lengths but with the same unique elements are considered equal.
• Supported element types include string, bool, number, interval, timestamp, regexp, and enum.

Syntax

Like many functions in DataPrime, isSuperset supports two notations, function and method. These interchangeable forms allow flexibility in how you structure expressions.

Function notation

isSuperset(array1: array<T>, array2: array<T>): bool

Method notation

(array1: array<T>).isSuperset(array2: array<T>): bool

Arguments

Name	Type	Required	Description
array1	array<T>	true	The array to test as a superset
array2	array<T>	true	The array to test against, must be fully contained within array1

Example

Use case: Verify if all jobs contain the started jobs

Suppose you want to confirm that a list of all jobs includes every job that has been started. Consider the following input:

{
    "all_jobs": ["Chris", "John", "Adam", "Ariel", "Zev"],
    "started_jobs": ["Chris", "John"]
}

By applying isSuperset, you can verify that all_jobs fully contains the elements in started_jobs.

Example query

Function notation

create is_superset from isSuperset(all_jobs, started_jobs)

Method notation

create is_superset from all_jobs.isSuperset(started_jobs)

Example output

The result will include a new field is_superset indicating whether the superset condition is satisfied:

{
    "all_jobs": ["Chris", "John", "Adam", "Ariel", "Zev"],
    "started_jobs": ["Chris", "John"],
    "is_superset": true
}