Usage guide
This guide is organized as a practical user journey so you can move from foundational checks to advanced rule logic in a predictable order.
Start with single-instance and graph-level validation to confirm structural correctness, then expand into uniqueness and time-series quality, and finally use conditional and chained conditional logic for derived operational outcomes and multi-step reasoning.
You can follow the journey end-to-end when onboarding, or jump directly to the section that matches your current use case.
For how rules are stored and published, see Rule sources.
This usage guide follows one validation journey:
- Single instance data quality validation - Expected outcome: per-instance pass/fail findings for required fields and basic constraints.
- Graph consistency - Expected outcome: detected relationship and model-consistency issues across connected instances (SPARQL / cross-node).
- Edge existence - Expected outcome: typed-edge cardinality pass/fail for MultiEdgeConnection relations (
dqs:edgeExistenceConstraint). - Uniqueness - Expected outcome: duplicate-value detection with actionable violation records for cleanup and rerun.
- Time series - Expected outcome: signal-quality findings for gaps, stale data, range violations, and temporal anomalies.
- Conditional logic - Expected outcome: derived rule outputs (
RuleEngineResult) for operational classification and automation. - Chained conditional logic - Expected outcome: multi-stage inferred outcomes with lineage (
causedBy) across dependent rules.
Start with context
Validation journey
- Single instance data quality validation — confirm that rules work (
run_validation()vs estate historic), then sync-cursor and historic orchestration - Graph consistency
- Edge existence
- Uniqueness
- Time series
- Conditional logic
- Chained conditional logic
Supporting operations
- Confirm that rules work — sample
run_validation()vs estateenqueue_historic_validation()(includingforce=True) - Rule sources
- Editing Data Products and RuleSets in Flows apps — Publish, siblings, discovery, lookback for app developers
- Building an app on the data quality engine — publish contract, immutable record queries, and how to rate an app
- Records output
- Reverse navigation from instance views — 0.5 opt-in
multi_reverse_direct_relationthroughfocusNodeInstance - Records streams (mutable vs immutable)
- Stream retention
- Pre-persist Save gate — overlay a proposed patch and validate before DMS
apply - Data quality dimensions in SHACL rules
- Migration 0.4.0
- Migration 0.4.1+
- Migration 0.4.4
- Invoke Cognite Functions
- Runtime options
- Deploy infrastructure and pipeline
- Atlas rule-authoring agent — PyPI-packaged skill/agent for Consistency
sh:noderules in Flows chat - Lifecycle and CI/CD