spark-instrumented-optimizer/docs/sql-ref-null-semantics.md

---
layout: global
title: NULL Semantics
displayTitle: NULL Semantics
license: |
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
---

### Description
A table consists of a set of rows and each row contains a set of columns.
A column is associated with a data type and represents
a specific attribute of an entity (for example, `age` is a column of an
entity called `person`). Sometimes, the value of a column
specific to a row is not known at the time the row comes into existence.
In `SQL`, such values are represented as `NULL`. This section details the
semantics of `NULL` values handling in various operators, expressions and
other `SQL` constructs.

1. [Null handling in comparison operators](#comp-operators)
2. [Null handling in Logical operators](#logical-operators)
3. [Null handling in Expressions](#expressions)
      1. [Null handling in null-intolerant expressions](#null-intolerant)
      2. [Null handling Expressions that can process null value operands](#can-process-null)
      3. [Null handling in built-in aggregate expressions](#built-in-aggregate)
4. [Null handling in WHERE, HAVING and JOIN conditions](#condition-expressions)
5. [Null handling in GROUP BY and DISTINCT](#aggregate-operator)
6. [Null handling in ORDER BY](#order-by)
7. [Null handling in UNION, INTERSECT, EXCEPT](#set-operators)
8. [Null handling in EXISTS and NOT EXISTS subquery](#exists-not-exists)
9. [Null handling in IN and NOT IN subquery](#in-not-in)

<style type="text/css">
.tsclass {font-size:12px;color:#333333;width:40%;border-width: 2px;border-color: #729ea5;border-collapse: collapse;}
.tsclass th {text-align: left;}
</style>

The following illustrates the schema layout and data of a table named `person`. The data contains `NULL` values in
the `age` column and this table will be used in various examples in the sections below.
**<u>TABLE: person</u>**
<table class="tsclass" border="1">
<tr><th>Id</th><th>Name</th><th>Age</th></tr>
<tr><td>100</td><td>Joe</td><td>30</td></tr>
<tr><td>200</td><td>Marry</td><td>NULL</td></tr>
<tr><td>300</td><td>Mike</td><td>18</td></tr>
<tr><td>400</td><td>Fred</td><td>50</td></tr>
<tr><td>500</td><td>Albert</td><td>NULL</td></tr>
<tr><td>600</td><td>Michelle</td><td>30</td></tr>
<tr><td>700</td><td>Dan</td><td>50</td></tr>
</table>

### Comparison operators <a name="comp-operators"></a>

Apache spark supports the standard comparison operators such as '>', '>=', '=', '<' and '<='.
The result of these operators is unknown or `NULL` when one of the operands or both the operands are
unknown or `NULL`. In order to compare the `NULL` values for equality, Spark provides a null-safe
equal operator ('<=>'), which returns `False` when one of the operand is `NULL` and returns 'True` when
both the operands are `NULL`. The following table illustrates the behaviour of comparison operators when
one or both operands are `NULL`:

<table class="tsclass" border="1">
  <tr>
    <th>Left Operand</th>
    <th>Right  Operand</th>
    <th>></th>
    <th>>=</th>
    <th>=</th>
    <th><</th>
    <th><=</th>
    <th><=></th>
  </tr>
  <tr>
    <td>NULL</td>
    <td>Any value</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>False</td>
  </tr>
  <tr>
    <td>Any value</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>False</td>
  </tr>
  <tr>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>True</td>
  </tr>
</table>

### Examples
{% highlight sql %}
-- Normal comparison operators return `NULL` when one of the operand is `NULL`.
SELECT 5 > null AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

-- Normal comparison operators return `NULL` when both the operands are `NULL`.
SELECT null = null AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

-- Null-safe equal operator return `False` when one of the operand is `NULL`
SELECT 5 <=> null AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |false            |
  +-----------------+

-- Null-safe equal operator return `True` when one of the operand is `NULL`
SELECT NULL <=> NULL;
  +-----------------+
  |expression_output|
  +-----------------+
  |true             |
  +-----------------+
{% endhighlight %}

### Logical operators <a name="logical-operators"></a>
Spark supports standard logical operators such as `AND`, `OR` and `NOT`. These operators take `Boolean` expressions
as the arguments and return a `Boolean` value.  

The following tables illustrate the behavior of logical operators when one or both operands are `NULL`.

<table class="tsclass" border="1">
  <tr>
    <th>Left Operand</th>
    <th>Right Operand</th>
    <th>OR</th>
    <th>AND</th>
  </tr>
  <tr>
    <td>True</td>
    <td>NULL</td>
    <td>True</td>
    <td>NULL</td>
  </tr>
  <tr>
    <td>False</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>False</td>
  </tr>
  <tr>
    <td>NULL</td>
    <td>True</td>
    <td>True</td>
    <td>NULL</td>
  </tr>
  <tr>
    <td>NULL</td>
    <td>False</td>
    <td>NULL</td>
    <td>NULL</td>
  </tr>
  <tr>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
    <td>NULL</td>
  </tr>
</table>
<br>
<table class="tsclass" border="1">
  <tr>
    <th>operand</th>
    <th>NOT</th>
  </tr>
  <tr>
    <td>NULL</td>
    <td>NULL</td>
  </tr>
</table>

### Examples
{% highlight sql %}
-- Normal comparison operators return `NULL` when one of the operands is `NULL`.
SELECT (true OR null) AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |true             |
  +-----------------+

-- Normal comparison operators return `NULL` when both the operands are `NULL`.
SELECT (null OR false) AS expression_output
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

-- Null-safe equal operator returns `False` when one of the operands is `NULL`
SELECT NOT(null) AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+
{% endhighlight %}

### Expressions <a name="expressions"></a>
The comparison operators and logical operators are treated as expressions in
Spark. Other than these two kinds of expressions, Spark supports other form of
expressions such as function expressions, cast expressions, etc. The expressions
in Spark can be broadly classified as :
- Null intolerant expressions
- Expressions that can process `NULL` value operands
  - The result of these expressions depends on the expression itself.

#### Null intolerant expressions <a name="null-intolerant"></a>
Null intolerant expressions return `NULL` when one or more arguments of 
expression are `NULL` and most of the expressions fall in this category.

##### Examples
{% highlight sql %}
SELECT concat('John', null) as expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

SELECT positive(null) as expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

SELECT to_date(null) as expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+
{% endhighlight %}

#### Expressions that can process null value operands. <a name="can-process-null"></a>

This class of expressions are designed to handle `NULL` values. The result of the 
expressions depends on the expression itself. As an example, function expression `isnull`
returns a `true` on null input and `false` on non null input where as function `coalesce`
returns the first non `NULL` value in its list of operands. However, `coalesce` returns
`NULL` when all its operands are `NULL`. Below is an incomplete list of expressions of this category.
  - COALESCE
  - NULLIF
  - IFNULL
  - NVL
  - NVL2
  - ISNAN
  - NANVL
  - ISNULL
  - ISNOTNULL
  - ATLEASTNNONNULLS 
  - IN


##### Examples
{% highlight sql %}
SELECT isnull(null) AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |true             |
  +-----------------+

-- Returns the first occurrence of non `NULL` value.
SELECT coalesce(null, null, 3, null) AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |3                |
  +-----------------+

-- Returns `NULL` as all its operands are `NULL`. 
SELECT coalesce(null, null, null, null) AS expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |null             |
  +-----------------+

SELECT isnan(null) as expression_output;
  +-----------------+
  |expression_output|
  +-----------------+
  |false            |
  +-----------------+
{% endhighlight %}

#### Builtin Aggregate Expressions <a name="built-in-aggregate"></a>
Aggregate functions compute a single result by processing a set of input rows. Below are
the rules of how `NULL` values are handled by aggregate functions.
- `NULL` values are ignored from processing by all the aggregate functions.
  - Only exception to this rule is COUNT(*) function.
- Some aggregate functions return `NULL` when all input values are `NULL` or the input data set
  is empty.<br> The list of these functions is:
  - MAX
  - MIN
  - SUM
  - AVG
  - EVERY
  - ANY
  - SOME
   
#### Examples
{% highlight sql %}
-- `count(*)` does not skip `NULL` values.
SELECT count(*) FROM person;
  +--------+
  |count(1)|
  +--------+
  |7       |
  +--------+

-- `NULL` values in column `age` are skipped from processing.
SELECT count(age) FROM person;
  +----------+
  |count(age)|
  +----------+
  |5         |
  +----------+

-- `count(*)` on an empty input set returns 0. This is unlike the other
-- aggregate functions, such as `max`, which return `NULL`.
SELECT count(*) FROM person where 1 = 0;
  +--------+
  |count(1)|
  +--------+
  |0       |
  +--------+

-- `NULL` values are excluded from computation of maximum value.
SELECT max(age) FROM person;
  +--------+
  |max(age)|
  +--------+
  |50      |
  +--------+

-- `max` returns `NULL` on an empty input set.
SELECT max(age) FROM person where 1 = 0;
  +--------+
  |max(age)|
  +--------+
  |null    |
  +--------+

{% endhighlight %}

### Condition expressions in WHERE, HAVING and JOIN clauses. <a name="condition-expressions"></a>
`WHERE`, `HAVING` operators filter rows based on the user specified condition.
A `JOIN` operator is used to combine rows from two tables based on a join condition.
For all the three operators, a condition expression is a boolean expression and can return
 <code>True, False or Unknown (NULL)</code>. They are "satisfied" if the result of the condition is `True`.

#### Examples
{% highlight sql %}
-- Persons whose age is unknown (`NULL`) are filtered out from the result set.
SELECT * FROM person WHERE age > 0;
  +--------+---+
  |name    |age|
  +--------+---+
  |Michelle|30 |
  |Fred    |50 |
  |Mike    |18 |
  |Dan     |50 |
  |Joe     |30 |
  +--------+---+

-- `IS NULL` expression is used in disjunction to select the persons
-- with unknown (`NULL`) records.
SELECT * FROM person WHERE age > 0 OR age IS NULL;
  +--------+----+
  |name    |age |
  +--------+----+
  |Albert  |null|
  |Michelle|30  |
  |Fred    |50  |
  |Mike    |18  |
  |Dan     |50  |
  |Marry   |null|
  |Joe     |30  |
  +--------+----+

-- Person with unknown(`NULL`) ages are skipped from processing.
SELECT * FROM person GROUP BY age HAVING max(age) > 18;
  +---+--------+                                                                  
  |age|count(1)|
  +---+--------+
  |50 |2       |
  |30 |2       |
  +---+--------+

-- A self join case with a join condition `p1.age = p2.age AND p1.name = p2.name`.
-- The persons with unknown age (`NULL`) are filtered out by the join operator.
SELECT * FROM person p1, person p2
WHERE p1.age = p2.age
  AND p1.name = p2.name;
  +--------+---+--------+---+
  |name    |age|name    |age|
  +--------+---+--------+---+
  |Michelle|30 |Michelle|30 |
  |Fred    |50 |Fred    |50 |
  |Mike    |18 |Mike    |18 |
  |Dan     |50 |Dan     |50 |
  |Joe     |30 |Joe     |30 |
  +--------+---+--------+---+

-- The age column from both legs of join are compared using null-safe equal which
-- is why the persons with unknown age (`NULL`) are qualified by the join.
SELECT * FROM person p1, person p2
WHERE p1.age <=> p2.age
  AND p1.name = p2.name;
+--------+----+--------+----+
|    name| age|    name| age|
+--------+----+--------+----+
|  Albert|null|  Albert|null|
|Michelle|  30|Michelle|  30|
|    Fred|  50|    Fred|  50|
|    Mike|  18|    Mike|  18|
|     Dan|  50|     Dan|  50|
|   Marry|null|   Marry|null|
|     Joe|  30|     Joe|  30|
+--------+----+--------+----+

{% endhighlight %}

### Aggregate operator (GROUP BY, DISTINCT) <a name="aggregate-operator"></a>
As discussed in the previous section [comparison operator](sql-ref-null-semantics.html#comparison-operators),
two `NULL` values are not equal. However, for the purpose of grouping and distinct processing, the two or more
values with `NULL data`are grouped together into the same bucket. This behaviour is conformant with SQL
standard and with other enterprise database management systems.

#### Examples
{% highlight sql %}
-- `NULL` values are put in one bucket in `GROUP BY` processing.
SELECT age, count(*) FROM person GROUP BY age;
  +----+--------+                                                                 
  |age |count(1)|
  +----+--------+
  |null|2       |
  |50  |2       |
  |30  |2       |
  |18  |1       |
  +----+--------+

-- All `NULL` ages are considered one distinct value in `DISTINCT` processing.
SELECT DISTINCT age FROM person;
  +----+
  |age |
  +----+
  |null|
  |50  |
  |30  |
  |18  |
  +----+

{% endhighlight %}

### Sort operator (ORDER BY Clause) <a name="order-by"></a>
Spark SQL supports null ordering specification in `ORDER BY` clause. Spark processes the `ORDER BY` clause by
placing all the `NULL` values at first or at last depending on the null ordering specification. By default, all
the `NULL` values are placed at first.

#### Examples
{% highlight sql %}
-- `NULL` values are shown at first and other values
-- are sorted in ascending way.
SELECT age, name FROM person ORDER BY age;
  +----+--------+
  |age |name    |
  +----+--------+
  |null|Marry   |
  |null|Albert  |
  |18  |Mike    |
  |30  |Michelle|
  |30  |Joe     |
  |50  |Fred    |
  |50  |Dan     |
  +----+--------+

-- Column values other than `NULL` are sorted in ascending
-- way and `NULL` values are shown at the last.
SELECT age, name FROM person ORDER BY age NULLS LAST;
  +----+--------+
  |age |name    |
  +----+--------+
  |18  |Mike    |
  |30  |Michelle|
  |30  |Joe     |
  |50  |Dan     |
  |50  |Fred    |
  |null|Marry   |
  |null|Albert  |
  +----+--------+

-- Columns other than `NULL` values are sorted in descending
-- and `NULL` values are shown at the last.
SELECT age, name FROM person ORDER BY age DESC NULLS LAST;
  +----+--------+
  |age |name    |
  +----+--------+
  |50  |Fred    |
  |50  |Dan     |
  |30  |Michelle|
  |30  |Joe     |
  |18  |Mike    |
  |null|Marry   |
  |null|Albert  |
  +----+--------+
{% endhighlight %}

### Set operators (UNION, INTERSECT, EXCEPT) <a name="set-operators"></a>
`NULL` values are compared in a null-safe manner for equality in the context of
set operations. That means when comparing rows, two `NULL` values are considered 
equal unlike the regular `EqualTo`(`=`) operator.

#### Examples
{% highlight sql %}
CREATE VIEW unknown_age SELECT * FROM person WHERE age IS NULL;

-- Only common rows between two legs of `INTERSECT` are in the 
-- result set. The comparison between columns of the row are done
-- in a null-safe manner.
SELECT name, age FROM person
INTERSECT
SELECT name, age from unknown_age;
  +------+----+                                                                   
  |name  |age |
  +------+----+
  |Albert|null|
  |Marry |null|
  +------+----+

-- `NULL` values from two legs of the `EXCEPT` are not in output. 
-- This basically shows that the comparison happens in a null-safe manner.
SELECT age, name FROM person
EXCEPT
SELECT age FROM unknown_age;
  +---+--------+                                                                  
  |age|name    |
  +---+--------+
  |30 |Joe     |
  |50 |Fred    |
  |30 |Michelle|
  |18 |Mike    |
  |50 |Dan     |
  +---+--------+

-- Performs `UNION` operation between two sets of data. 
-- The comparison between columns of the row ae done in
-- null-safe manner.
SELECT name, age FROM person
UNION 
SELECT name, age FROM unknown_age;
  +--------+----+                                                                 
  |name    |age |
  +--------+----+
  |Albert  |null|
  |Joe     |30  |
  |Michelle|30  |
  |Marry   |null|
  |Fred    |50  |
  |Mike    |18  |
  |Dan     |50  |
  +--------+----+
{% endhighlight %}


### EXISTS/NOT EXISTS Subquery <a name="exists-not-exists"></a>
In Spark, EXISTS and NOT EXISTS expressions are allowed inside a WHERE clause. 
These are boolean expressions which return either `TRUE` or
`FALSE`. In other words, EXISTS is a membership condition and returns `TRUE`
when the subquery it refers to returns one or more rows. Similarly, NOT EXISTS
is a non-membership condition and returns TRUE when no rows or zero rows are
returned from the subquery.

These two expressions are not affected by presence of NULL in the result of
the subquery. They are normally faster because they can be converted to
semijoins / anti-semijoins without special provisions for null awareness.

#### Examples
{% highlight sql %}
-- Even if subquery produces rows with `NULL` values, the `EXISTS` expression
-- evaluates to `TRUE` as the subquery produces 1 row.
SELECT * FROM person WHERE EXISTS (SELECT null);
  +--------+----+                                                                 
  |name    |age |
  +--------+----+
  |Albert  |null|
  |Michelle|30  |
  |Fred    |50  |
  |Mike    |18  |
  |Dan     |50  |
  |Marry   |null|
  |Joe     |30  |
  +--------+----+

-- `NOT EXISTS` expression returns `FALSE`. It returns `TRUE` only when
-- subquery produces no rows. In this case, it returns 1 row.
SELECT * FROM person WHERE NOT EXISTS (SELECT null);
  +----+---+
  |name|age|
  +----+---+
  +----+---+

-- `NOT EXISTS` expression returns `TRUE`.
SELECT * FROM person WHERE NOT EXISTS (SELECT 1 WHERE 1 = 0);
  +--------+----+
  |name    |age |
  +--------+----+
  |Albert  |null|
  |Michelle|30  |
  |Fred    |50  |
  |Mike    |18  |
  |Dan     |50  |
  |Marry   |null|
  |Joe     |30  |
  +--------+----+
{% endhighlight %}

### IN/NOT IN Subquery <a name="in-not-in"></a>
In Spark, `IN` and `NOT IN` expressions are allowed inside a WHERE clause of
a query. Unlike the `EXISTS` expression, `IN` expression can return a `TRUE`,
`FALSE` or `UNKNOWN (NULL)` value. Conceptually a `IN` expression is semantically
equivalent to a set of equality condition separated by a disjunctive operator (`OR`).
For example, c1 IN (1, 2, 3) is semantically equivalent to `(C1 = 1 OR c1 = 2 OR c1 = 3)`.

As far as handling `NULL` values are concerned, the semantics can be deduced from
the `NULL` value handling in comparison operators(`=`) and logical operators(`OR`).
To summarize, below are the rules for computing the result of an `IN` expression.

- TRUE is returned when the non-NULL value in question is found in the list
- FALSE is returned when the non-NULL value is not found in the list and the
  list does not contain NULL values
- UNKNOWN is returned when the value is `NULL`, or the non-NULL value is not found in the list
  and the list contains at least one `NULL` value

NOT IN always returns UNKNOWN when the list contains `NULL`, regardless of the input value.
This is because IN returns UNKNOWN if the value is not in the list containing `NULL`,
and because NOT UNKNOWN is again UNKNOWN.
 
#### Examples
{% highlight sql %}
-- The subquery has only `NULL` value in its result set. Therefore,
-- the result of `IN` predicate is UNKNOWN.
SELECT * FROM person WHERE age IN (SELECT null);
  +----+---+
  |name|age|
  +----+---+
  +----+---+

-- The subquery has `NULL` value in the result set as well as a valid 
-- value `50`. Rows with age = 50 are returned. 
SELECT * FROM person
WHERE age IN (SELECT age FROM VALUES (50), (null) sub(age));
  +----+---+
  |name|age|
  +----+---+
  |Fred|50 |
  |Dan |50 |
  +----+---+

-- Since subquery has `NULL` value in the result set, the `NOT IN`
-- predicate would return UNKNOWN. Hence, no rows are
-- qualified for this query.
SELECT * FROM person
WHERE age NOT IN (SELECT age FROM VALUES (50), (null) sub(age));
  +----+---+
  |name|age|
  +----+---+
  +----+---+

{% endhighlight %}