Skip to content

data-governance data-contract dataset create

qlik data-governance data-contract dataset create

Create data contracts in bulk

Synopsis

Creates a data contract for each listed dataset ID, notably to apply a contract to every dataset of a data product at once. The caller’s “Compute data quality” write privilege is checked once for the whole request, before any dataset is processed, so a caller lacking it is rejected upfront with HTTP 403 rather than failing every entry individually. Each dataset is then processed independently and concurrently: a failure on one (no write permission on its space, dataset not found, or a contract already existing) does not block the others. Unlike PATCH /expectations, an existing contract is never overwritten: it is reported as a failure. The dataset-level write permission, which depends on each dataset’s space/owner, is still checked per dataset. The request is capped at 100 datasets; a larger batch is rejected upfront with HTTP 400, before any contract is created.

qlik data-governance data-contract dataset create [flags]

Options

--datasets-datasetId string Identifier of the dataset the data contract must be created for.
--datasets-expectations-dataProfile-max int New upper bound (inclusive). Absent = unchanged, null = remove the bound, value = set.
--datasets-expectations-dataProfile-min int New lower bound (inclusive). Absent = unchanged, null = remove the bound, value = set.
--datasets-expectations-dataProfile-name string The name of the volume expectation. Currently only "volume" is supported (case-insensitive). Unknown names produce per-item errors (not 400).
--datasets-expectations-dataProfile-status string Activation status of an expectation. ˋACTIVATEDˋ means the expectation is enforced, ˋDEACTIVATEDˋ means it was explicitly turned off, and ˋNOT_ACTIVATEDˋ means it has never been activated.
Allowed values: "ACTIVATED", "DEACTIVATED", "NOT_ACTIVATED"
--datasets-expectations-trustScore-name string The name of the trust score dimension. One of: global, validity, completeness, accuracy, diversity, discoverability, usage, timeliness. Matched case-insensitively. Unknown names produce a per-item error in the response.
--datasets-expectations-trustScore-status string Activation status of an expectation. ˋACTIVATEDˋ means the expectation is enforced, ˋDEACTIVATEDˋ means it was explicitly turned off, and ˋNOT_ACTIVATEDˋ means it has never been activated.
Allowed values: "ACTIVATED", "DEACTIVATED", "NOT_ACTIVATED"
--datasets-expectations-trustScore-threshold int New failure threshold value (0-100 inclusive).
--datasets-expectations-trustScore-warning int New warning range value (0-100 inclusive). Must be strictly greater than the effective threshold. Absent means no change. Set to null to remove.
-f, --file file Read request body from the specified file
-h, --help help for create
--interval int Duration in seconds to wait between retries, at least 1 (default 1)
-q, --quiet Return only IDs from the command
--raw Return original response from server without any processing
--retry int Number of retries to do before failing, max 10

Options inherited from parent commands

-c, --config string path/to/config.yml where parameters can be set instead of on the command line
--context string Name of the context used when connecting to Qlik Associative Engine
--headers stringToString HTTP headers to use when connecting to Qlik Associative Engine (default [])
--insecure Allow connecting to hosts with self-signed certificates
--json Returns output in JSON format, if possible. Disables verbose and traffic output
-s, --server string URL to Qlik Cloud or directly to a Qlik Associative Engine
--server-type string The type of server you are using: cloud, Windows (Enterprise on Windows) or engine
-v, --verbose Log extra information
Was this page helpful?