Introduction to the Matches Pattern Check
The Matches Pattern check asserts that every value in a text field matches a regular expression you provide. Use it when the accepted values follow a structure rather than a finite list: identifiers, codes, formatted references, and any field whose shape is the rule.
This section is the complete guide to the check. The Deep Dive covers the definition, properties, and full evaluation semantics, explains how anomalies are reported, walks through production examples, and collects best practices; the How-tos are step-by-step tutorials for creating, editing, and deleting a check; the API page documents the payload for programmatic use; and the FAQ answers the most frequent questions.
Next Steps
-
How It Works
The complete reference: definition, field scope, the pattern property, matching semantics, NULL handling, arrays, filter behavior, and coverage.
-
Anomaly Reporting
The anomaly messages the check produces, what the numbers mean, Source Records highlighting, and Custom Anomaly Description.
-
Examples
Three production scenarios with sample data, anomaly messages, and the SQL equivalent of what the check evaluates.
-
Best Practices
Guidelines for writing the expression, anchoring it, pairing rules, and keeping the signal clean.
-
Permissions
The team permission each action needs: view, create, edit, archive, restore, and delete.
-
Create a Check
Step-by-step tutorial for creating a Matches Pattern check with a regular expression.
-
Edit a Check
Step-by-step tutorial for changing the pattern, or adjusting the filter, coverage, and organizational properties.
-
Delete a Check
Step-by-step tutorial for archiving a check and deleting it permanently.
-
Troubleshooting
Common problems with anchoring, escaping, NULLs, arrays, and anomaly reporting, and how to resolve them.
-
API
Payload shape and field notes for creating a Matches Pattern check programmatically.
-
FAQ
Short answers to questions about anchoring, case sensitivity, NULLs, and anomaly reporting.