# How Between Checks Work

Source: https://userguide.qualytics.io/data-quality-checks/between/deep-dive/how-it-works/

## Definition

*Asserts that every value in a numeric field falls between a minimum and a maximum boundary, with each side independently inclusive or exclusive.*

## Overview

The Between rule defines a numeric range on a single field. Each row must hold a value inside the range formed by **Min** and **Max**. Each boundary carries its own **Inclusive** setting, so the same check can express a closed range (`min <= value <= max`), an open one (`min < value < max`), or a half-open range where only one side accepts the boundary value.

Typical use cases:

- Validate a numeric range such as a discount between 0 and 1, or a score between 0 and 100.
- Enforce plausibility on a measurement, for example an age between 0 and 120.
- Keep a monetary amount inside an approved band for a given product or contract.

## Field Scope

**Single:** The rule evaluates exactly one field per check.

**Accepted Types**

| Type | Supported |
| --- | --- |
| `Integral` | Yes |
| `Fractional` | Yes |
| `Array` | Yes |

On an array field, every element is tested against the range and the row fails as soon as one element falls outside it. That evaluation runs as a field-level check, so it reports a Shape Anomaly for the field instead of per-row Record Anomalies, whatever the coverage is set to.

## General Properties

**Tab: Details**

| Name | Supported |
| --- | --- |
| Filter  Allows the targeting of specific data based on conditions | Supported |
| Coverage Customization  Allows adjusting the percentage of records that must meet the rule's conditions | Supported |

**Tab: Filter Guide**

The filter allows you to define a subset of data upon which the rule will operate.

It requires a valid **Spark SQL** expression that determines the criteria rows in the DataFrame should meet. This means the expression specifies which rows the DataFrame should include based on those criteria. Since it's applied directly to the Spark DataFrame, traditional SQL constructs like WHERE clauses **are not** supported.

> **Example: Examples**
>
> **Direct Conditions**
>
> Simply specify the condition you want to be met.
>
> > **Success: Correct usage" collapsible="true**
> >
> > ```sql
> > O_TOTALPRICE > 1000
> > ```
> >
> > ```sql
> > C_MKTSEGMENT = 'BUILDING'
> > ```
>
> > **Failure: Incorrect usage" collapsible="true**
> >
> > ```sql
> > WHERE O_TOTALPRICE > 1000
> > ```
> >
> > ```sql
> > WHERE C_MKTSEGMENT = 'BUILDING'
> > ```
>
> **Combining Conditions**
>
> Combine multiple conditions using logical operators like `AND` and `OR`.
>
> > **Success: Correct usage" collapsible="true**
> >
> > ```sql
> > O_ORDERPRIORITY = '1-URGENT' AND O_ORDERSTATUS = 'O'
> > ```
> >
> > ```sql
> > (L_SHIPDATE = '1998-09-02' OR L_RECEIPTDATE = '1998-09-01') AND L_RETURNFLAG = 'R'
> > ```
>
> > **Failure: Incorrect usage" collapsible="true**
> >
> > ```sql
> > WHERE O_ORDERPRIORITY = '1-URGENT' AND O_ORDERSTATUS = 'O'
> > ```
> >
> > ```sql
> > O_TOTALPRICE > 1000, O_ORDERSTATUS = 'O'
> > ```
>
> **Utilizing Functions**
>
> Leverage Spark SQL functions to refine and enhance your conditions.
>
> > **Success: Correct usage" collapsible="true**
> >
> > ```sql
> > RIGHT(
> >     O_ORDERPRIORITY,
> >     LENGTH(O_ORDERPRIORITY) - INSTR('-', O_ORDERPRIORITY)
> > ) = 'URGENT'
> > ```
> >
> > ```sql
> > LEVENSHTEIN(C_NAME, 'Supplier#000000001') < 7
> > ```
>
> > **Failure: Incorrect usage" collapsible="true**
> >
> > ```sql
> > RIGHT(
> >     O_ORDERPRIORITY,
> >     LENGTH(O_ORDERPRIORITY) - CHARINDEX('-', O_ORDERPRIORITY)
> > ) = 'URGENT'
> > ```
> >
> > ```sql
> > EDITDISTANCE(C_NAME, 'Supplier#000000001') < 7
> > ```
>
> **Using scan-time variables**
>
> To refer to the current dataframe being analyzed, use the reserved dynamic variable `{{_qualytics_self}}`.
>
> > **Success: Correct usage" collapsible="true**
> >
> > ```sql
> > O_ORDERSTATUS IN (
> >     SELECT DISTINCT O_ORDERSTATUS
> >     FROM {{_qualytics_self}}
> >     WHERE O_TOTALPRICE > 1000
> > )
> > ```
>
> > **Failure: Incorrect usage" collapsible="true**
> >
> > ```sql
> > O_ORDERSTATUS IN (
> >     SELECT DISTINCT O_ORDERSTATUS
> >     FROM ORDERS
> >     WHERE O_TOTALPRICE > 1000
> > )
> > ```
>
> While subqueries can be useful, their application within filters in our context has limitations. For example, directly referencing other containers or the broader target container in such subqueries **is not supported**. Attempting to do so will result in an error.
>
> > **Warning: Important Note on {{_qualytics_self}}**
> >
> > The `{{_qualytics_self}}` keyword refers to the dataframe that's currently under examination. In the context of a full scan, this variable represents the entire target container. However, during incremental scans, it only reflects a subset of the target container, capturing just the incremental data. It's crucial to recognize that in such scenarios, using `{{_qualytics_self}}` may not encompass all entries from the target container.

## Specific Properties

Between has four rule-specific properties:

| Name | Description |
| --- | --- |
| Min | The lower boundary of the accepted range. |
| Inclusive (min) | Whether a value equal to **Min** passes. |
| Max | The upper boundary of the accepted range. |
| Inclusive (max) | Whether a value equal to **Max** passes. |

## Anomaly Types

| Type | Supported |
| --- | --- |
| Record Flag inconsistencies at the row level | Supported |
| Shape Flag inconsistencies in the overall patterns and distributions of a field | Supported |

## Evaluation Flow

Every Between check follows the same four-step evaluation flow:

1. **Apply the filter clause.** If the check has a `filter` set, only rows matching the filter expression continue to the next step. Rows outside the filter are ignored and cannot contribute to the violation count.
2. **Read the field value.** The platform reads the numeric value for the current row.
3. **Compare against both boundaries.** The value must satisfy the lower comparison (`>` or `>=`, depending on the min inclusivity) **and** the upper comparison (`<` or `<=`). Failing either side fails the row.
4. **Apply coverage.** At 100% coverage, any failing row causes the check to fail. Below 100% coverage, the check fails only when the passing fraction drops below the threshold (see [Coverage and Tolerance](https://userguide.qualytics.io/data-quality-checks/between/deep-dive/how-it-works/#coverage-and-tolerance)).

## Boundary Inclusivity

The two **Inclusive** settings are independent, which lets one check express four different ranges:

| Min inclusive | Max inclusive | Accepted values |
| --- | --- | --- |
| Yes | Yes | `min <= value <= max` (closed range) |
| No | No | `min < value < max` (open range) |
| Yes | No | `min <= value < max` (common for buckets, where the upper edge belongs to the next bucket) |
| No | Yes | `min < value <= max` |

The half-open form is the safest choice when several checks partition a continuous scale, because it leaves no value belonging to two ranges at once.

## NULL Handling

The check **passes NULL values**: a row with `NULL` in the evaluated field is not counted as a violation. Between only asserts that *present* values fall inside the range and does not enforce mandatory presence on the field.

If the field must also be populated, pair Between with a [Not Null](https://userguide.qualytics.io/data-quality-checks/not-null/introduction/) check on the same field.

## The Filter Clause

The filter clause is a SQL `WHERE` expression applied **before** the evaluation. Filtered-out rows are ignored entirely (they cannot trigger a violation and are not counted in the totals).

Common uses:

- Applying a range only to a product line, a region, or a contract tier.
- Excluding sentinel rows that carry a placeholder value tracked by a separate clean-up task.
- Scoping the check to a partition (`event_date = current_date()`).

When a filter is set, the message names it at the end of its first sentence, as `(applied to records where <expression>)`. Record and Shape Anomaly messages both carry it.

## Coverage and Tolerance

Coverage is a fractional value between `0` and `1` that defines the minimum fraction of evaluated rows that must pass:

- **`1.0` (100%, default):** every row in the filtered set must pass. Any failing row causes the check to fail. This is the strictest setting.
- **`< 1.0`:** the check tolerates a fraction of rows falling outside the range. The check fails only when the fraction of passing rows drops below the threshold.

Lower coverage values are useful when a small, known fraction of out-of-range values is expected. Use coverage carefully: a 0.5% tolerance can mask a real regression that happens to fall just under the threshold.

## See Also

- **Anomaly Reporting**

  The anomaly messages the check produces, what the numbers mean, Source Records highlighting, and Custom Anomaly Description.

  [Anomaly Reporting](https://userguide.qualytics.io/data-quality-checks/between/deep-dive/anomaly-reporting/)
- **Examples**

  Three production scenarios with sample data, anomaly messages, and the SQL equivalent of what the check evaluates.

  [Examples](https://userguide.qualytics.io/data-quality-checks/between/deep-dive/examples/)
- **Best Practices**

  Guidelines for choosing boundaries, setting inclusivity, pairing rules, and keeping the signal clean.

  [Best Practices](https://userguide.qualytics.io/data-quality-checks/between/deep-dive/best-practices/)
- **Permissions**

  The team permission each action needs: view, create, edit, archive, restore, and delete.

  [Permissions](https://userguide.qualytics.io/data-quality-checks/between/deep-dive/permissions/)

*Last updated: September 22, 2026.*
