Add between operator (#2335)

<!--
Thanks for opening a pull request!
-->

<!-- In the case this PR will resolve an issue, please replace
${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
<!-- Closes #${GITHUB_ISSUE_ID} -->

# Rationale for this change

Fixes #792

# Are these changes tested?

# Are there any user-facing changes?

Add `BETWEEN` operator

<!-- In the case of user-facing changes, please add the changelog label.
-->

Author: jtuglu1

mkdocs/docs/expression-dsl.md

@@ -60,6 +60,8 @@ age_greater_than_18 = GreaterThan("age", 18)
 
 # Greater than or equal to
 age_greater_than_or_equal_18 = GreaterThanOrEqual("age", 18)
+
+
 ```
 
 #### Set Predicates

mkdocs/docs/row-filter-syntax.md

@@ -100,6 +100,15 @@ column NOT LIKE 'prefix%'
 !!! important
     The `%` wildcard is only supported at the end of the pattern. Using it in the middle or beginning of the pattern will raise an error.
 
+## BETWEEN
+
+The BETWEEN operator filters a numeric value against an inclusive range, e.g. `a between 1 and 2` is equivalent to `a >= 1 and a <= 2`.
+
+```sql
+column BETWEEN 1 AND 2
+column BETWEEN 1.0 AND 2.0
+```
+
 ## Logical Operations
 
 Combine multiple conditions using logical operators:

pyiceberg/expressions/parser.py

@@ -79,6 +79,7 @@
 NULL = CaselessKeyword("null")
 NAN = CaselessKeyword("nan")
 LIKE = CaselessKeyword("like")
+BETWEEN = CaselessKeyword("between")
 
 unquoted_identifier = Word(alphas + "_", alphanums + "_$")
 quoted_identifier = QuotedString('"', escChar="\\", unquoteResults=True)
@@ -106,6 +107,7 @@ def _(result: ParseResults) -> Reference:
 string = sgl_quoted_string.set_results_name("raw_quoted_string")
 decimal = common.real().set_results_name("decimal")
 integer = common.signed_integer().set_results_name("integer")
+number = common.number().set_results_name("number")
 literal = Group(string | decimal | integer | boolean).set_results_name("literal")
 literal_set = Group(
     DelimitedList(string) | DelimitedList(decimal) | DelimitedList(integer) | DelimitedList(boolean)
@@ -149,6 +151,12 @@ def _(result: ParseResults) -> Literal[L]:
 left_ref = column + comparison_op + literal
 right_ref = literal + comparison_op + column
 comparison = left_ref | right_ref
+between = column + BETWEEN + number + AND + number
+
+
+@between.set_parse_action
+def _(result: ParseResults) -> BooleanExpression:
+    return And(GreaterThanOrEqual(result.column, result[2]), LessThanOrEqual(result.column, result[4]))
 
 
 @left_ref.set_parse_action
@@ -258,7 +266,7 @@ def _evaluate_like_statement(result: ParseResults) -> BooleanExpression:
         return EqualTo(result.column, StringLiteral(literal_like.value.replace("\\%", "%")))
 
 
-predicate = (comparison | in_check | null_check | nan_check | starts_check | boolean).set_results_name("predicate")
+predicate = (between | comparison | in_check | null_check | nan_check | starts_check | boolean).set_results_name("predicate")
 
 
 def handle_not(result: ParseResults) -> Not:

tests/expressions/test_parser.py

@@ -39,9 +39,10 @@
     NotNull,
     NotStartsWith,
     Or,
+    Reference,
     StartsWith,
 )
-from pyiceberg.expressions.literals import DecimalLiteral
+from pyiceberg.expressions.literals import DecimalLiteral, LongLiteral
 
 
 def test_always_true() -> None:
@@ -238,3 +239,31 @@ def test_quoted_column_with_dots() -> None:
 
 def test_quoted_column_with_spaces() -> None:
     assert EqualTo("Foo Bar", "data") == parser.parse("\"Foo Bar\" = 'data'")
+
+
+def test_valid_between() -> None:
+    assert And(
+        left=GreaterThanOrEqual(Reference(name="foo"), LongLiteral(1)),
+        right=LessThanOrEqual(Reference(name="foo"), LongLiteral(3)),
+    ) == parser.parse("foo between 1 and 3")
+    assert And(
+        left=GreaterThanOrEqual(Reference(name="foo"), LongLiteral(1)),
+        right=LessThanOrEqual(Reference(name="foo"), LongLiteral(1)),
+    ) == parser.parse("foo between 1 and 1")
+    assert And(
+        left=GreaterThanOrEqual(Reference(name="foo"), DecimalLiteral(Decimal(1.0))),
+        right=LessThanOrEqual(Reference(name="foo"), DecimalLiteral(Decimal(4.0))),
+    ) == parser.parse("foo between 1.0 and 4.0")
+    assert parser.parse("foo between 1 and 3") == parser.parse("1 <= foo and foo <= 3")
+
+
+def test_invalid_between() -> None:
+    # boolean
+    with pytest.raises(ParseException) as exc_info:
+        parser.parse("foo between true and false")
+    assert "Expected number, found 'true'" in str(exc_info)
+
+    # string
+    with pytest.raises(ParseException) as exc_info:
+        parser.parse("foo between 'a' and 'b'")
+    assert 'Expected number, found "\'"' in str(exc_info)