Skip to content

refactor: support ops.case_when_op and fix invert_op for the sqlglot compiler #2174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chelsea-lin merged 3 commits into from
Oct 17, 2025
Merged

refactor: support ops.case_when_op and fix invert_op for the sqlglot compiler #2174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59b6080
refactor: support ops.case_when_op for the sqlglot compiler
chelsea-lin Oct 15, 2025
136ec2f
fix ops.invert_op in engine tests
chelsea-lin Oct 15, 2025
4858b9d
exclude test_engines_isin_op_nested_filter due to lack of parantheses
chelsea-lin Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 46 additions & 12 deletions bigframes/core/compile/sqlglot/expressions/generic_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import bigframes.core.compile.sqlglot.scalar_compiler as scalar_compiler

register_unary_op = scalar_compiler.scalar_op_compiler.register_unary_op
register_nary_op = scalar_compiler.scalar_op_compiler.register_nary_op
register_ternary_op = scalar_compiler.scalar_op_compiler.register_ternary_op


Expand Down Expand Up @@ -67,23 +68,18 @@ def _(expr: TypedExpr, op: ops.AsTypeOp) -> sge.Expression:
return _cast(sg_expr, sg_to_type, op.safe)


@register_ternary_op(ops.clip_op)
def _(
original: TypedExpr,
lower: TypedExpr,
upper: TypedExpr,
) -> sge.Expression:
return sge.Greatest(
this=sge.Least(this=original.expr, expressions=[upper.expr]),
expressions=[lower.expr],
)


@register_unary_op(ops.hash_op)
def _(expr: TypedExpr) -> sge.Expression:
return sge.func("FARM_FINGERPRINT", expr.expr)


@register_unary_op(ops.invert_op)
def _(expr: TypedExpr) -> sge.Expression:
if expr.dtype == dtypes.BOOL_DTYPE:
return sge.Not(this=expr.expr)
return sge.BitwiseNot(this=expr.expr)


@register_unary_op(ops.isnull_op)
def _(expr: TypedExpr) -> sge.Expression:
return sge.Is(this=expr.expr, expression=sge.Null())
Expand Down Expand Up @@ -114,6 +110,44 @@ def _(
return sge.If(this=condition.expr, true=original.expr, false=replacement.expr)


@register_ternary_op(ops.clip_op)
def _(
original: TypedExpr,
lower: TypedExpr,
upper: TypedExpr,
) -> sge.Expression:
return sge.Greatest(
this=sge.Least(this=original.expr, expressions=[upper.expr]),
expressions=[lower.expr],
)


@register_nary_op(ops.case_when_op)
def _(*cases_and_outputs: TypedExpr) -> sge.Expression:
# Need to upcast BOOL to INT if any output is numeric
result_values = cases_and_outputs[1::2]
do_upcast_bool = any(
dtypes.is_numeric(t.dtype, include_bool=False) for t in result_values
)
if do_upcast_bool:
result_values = tuple(
TypedExpr(
sge.Cast(this=val.expr, to="INT64"),
dtypes.INT_DTYPE,
)
if val.dtype == dtypes.BOOL_DTYPE
else val
for val in result_values
)

return sge.Case(
ifs=[
sge.If(this=predicate.expr, true=output.expr)
for predicate, output in zip(cases_and_outputs[::2], result_values)
],
)


# Helper functions
def _cast_to_json(expr: TypedExpr, op: ops.AsTypeOp) -> sge.Expression:
from_type = expr.dtype
Expand Down
5 changes: 0 additions & 5 deletions bigframes/core/compile/sqlglot/expressions/numeric_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,11 +148,6 @@ def _(expr: TypedExpr) -> sge.Expression:
return sge.Floor(this=expr.expr)


@register_unary_op(ops.invert_op)
def _(expr: TypedExpr) -> sge.Expression:
return sge.BitwiseNot(this=expr.expr)


@register_unary_op(ops.ln_op)
def _(expr: TypedExpr) -> sge.Expression:
return sge.Case(
Expand Down
10 changes: 5 additions & 5 deletions tests/system/small/engines/test_generic_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ def test_engines_fillna_op(scalars_array_value: array_value.ArrayValue, engine):
assert_equivalence_execution(arr.node, REFERENCE_ENGINE, engine)


@pytest.mark.parametrize("engine", ["polars", "bq"], indirect=True)
@pytest.mark.parametrize("engine", ["polars", "bq", "bq-sqlglot"], indirect=True)
def test_engines_casewhen_op_single_case(
scalars_array_value: array_value.ArrayValue, engine
):
Expand All @@ -373,7 +373,7 @@ def test_engines_casewhen_op_single_case(
assert_equivalence_execution(arr.node, REFERENCE_ENGINE, engine)


@pytest.mark.parametrize("engine", ["polars", "bq"], indirect=True)
@pytest.mark.parametrize("engine", ["polars", "bq", "bq-sqlglot"], indirect=True)
def test_engines_casewhen_op_double_case(
scalars_array_value: array_value.ArrayValue, engine
):
Expand All @@ -391,7 +391,7 @@ def test_engines_casewhen_op_double_case(
assert_equivalence_execution(arr.node, REFERENCE_ENGINE, engine)


@pytest.mark.parametrize("engine", ["polars", "bq"], indirect=True)
@pytest.mark.parametrize("engine", ["polars", "bq", "bq-sqlglot"], indirect=True)
def test_engines_isnull_op(scalars_array_value: array_value.ArrayValue, engine):
arr, _ = scalars_array_value.compute_values(
[ops.isnull_op.as_expr(expression.deref("string_col"))]
Expand All @@ -400,7 +400,7 @@ def test_engines_isnull_op(scalars_array_value: array_value.ArrayValue, engine):
assert_equivalence_execution(arr.node, REFERENCE_ENGINE, engine)


@pytest.mark.parametrize("engine", ["polars", "bq"], indirect=True)
@pytest.mark.parametrize("engine", ["polars", "bq", "bq-sqlglot"], indirect=True)
def test_engines_notnull_op(scalars_array_value: array_value.ArrayValue, engine):
arr, _ = scalars_array_value.compute_values(
[ops.notnull_op.as_expr(expression.deref("string_col"))]
Expand All @@ -409,7 +409,7 @@ def test_engines_notnull_op(scalars_array_value: array_value.ArrayValue, engine)
assert_equivalence_execution(arr.node, REFERENCE_ENGINE, engine)


@pytest.mark.parametrize("engine", ["polars", "bq"], indirect=True)
@pytest.mark.parametrize("engine", ["polars", "bq", "bq-sqlglot"], indirect=True)
def test_engines_invert_op(scalars_array_value: array_value.ArrayValue, engine):
arr, _ = scalars_array_value.compute_values(
[
Expand Down
29 changes: 29 additions & 0 deletions ...nit/core/compile/sqlglot/expressions/snapshots/test_generic_ops/test_case_when_op/out.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
WITH `bfcte_0` AS (
SELECT
`bool_col` AS `bfcol_0`,
`int64_col` AS `bfcol_1`,
`int64_too` AS `bfcol_2`,
`float64_col` AS `bfcol_3`
FROM `bigframes-dev`.`sqlglot_test`.`scalar_types`
), `bfcte_1` AS (
SELECT
*,
CASE WHEN `bfcol_0` THEN `bfcol_1` END AS `bfcol_4`,
CASE WHEN `bfcol_0` THEN `bfcol_1` WHEN `bfcol_0` THEN `bfcol_2` END AS `bfcol_5`,
CASE WHEN `bfcol_0` THEN `bfcol_0` WHEN `bfcol_0` THEN `bfcol_0` END AS `bfcol_6`,
CASE
WHEN `bfcol_0`
THEN `bfcol_1`
WHEN `bfcol_0`
THEN CAST(`bfcol_0` AS INT64)
WHEN `bfcol_0`
THEN `bfcol_3`
END AS `bfcol_7`
FROM `bfcte_0`
)
SELECT
`bfcol_4` AS `single_case`,
`bfcol_5` AS `double_case`,
`bfcol_6` AS `bool_types_case`,
`bfcol_7` AS `mixed_types_cast`
FROM `bfcte_1`
19 changes: 19 additions & 0 deletions tests/unit/core/compile/sqlglot/expressions/snapshots/test_generic_ops/test_invert/out.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
WITH `bfcte_0` AS (
SELECT
`bool_col` AS `bfcol_0`,
`bytes_col` AS `bfcol_1`,
`int64_col` AS `bfcol_2`
FROM `bigframes-dev`.`sqlglot_test`.`scalar_types`
), `bfcte_1` AS (
SELECT
*,
~`bfcol_2` AS `bfcol_6`,
~`bfcol_1` AS `bfcol_7`,
NOT `bfcol_0` AS `bfcol_8`
FROM `bfcte_0`
)
SELECT
`bfcol_6` AS `int64_col`,
`bfcol_7` AS `bytes_col`,
`bfcol_8` AS `bool_col`
FROM `bfcte_1`
13 changes: 0 additions & 13 deletions tests/unit/core/compile/sqlglot/expressions/snapshots/test_numeric_ops/test_invert/out.sql
View file
Open in desktop

This file was deleted.

53 changes: 53 additions & 0 deletions tests/unit/core/compile/sqlglot/expressions/test_generic_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,47 @@ def test_astype_json_invalid(
)


def test_case_when_op(scalar_types_df: bpd.DataFrame, snapshot):
ops_map = {
"single_case": ops.case_when_op.as_expr(
"bool_col",
"int64_col",
),
"double_case": ops.case_when_op.as_expr(
"bool_col",
"int64_col",
"bool_col",
"int64_too",
),
"bool_types_case": ops.case_when_op.as_expr(
"bool_col",
"bool_col",
"bool_col",
"bool_col",
),
"mixed_types_cast": ops.case_when_op.as_expr(
"bool_col",
"int64_col",
"bool_col",
"bool_col",
"bool_col",
"float64_col",
),
}

array_value = scalar_types_df._block.expr
result, col_ids = array_value.compute_values(list(ops_map.values()))

# Rename columns for deterministic golden SQL results.
assert len(col_ids) == len(ops_map.keys())
result = result.rename_columns(
{col_id: key for col_id, key in zip(col_ids, ops_map.keys())}
).select_columns(list(ops_map.keys()))

sql = result.session._executor.to_sql(result, enable_cache=False)
snapshot.assert_match(sql, "out.sql")


def test_clip(scalar_types_df: bpd.DataFrame, snapshot):
op_expr = ops.clip_op.as_expr("rowindex", "int64_col", "int64_too")

Expand All @@ -192,6 +233,18 @@ def test_hash(scalar_types_df: bpd.DataFrame, snapshot):
snapshot.assert_match(sql, "out.sql")


def test_invert(scalar_types_df: bpd.DataFrame, snapshot):
bf_df = scalar_types_df[["int64_col", "bytes_col", "bool_col"]]
ops_map = {
"int64_col": ops.invert_op.as_expr("int64_col"),
"bytes_col": ops.invert_op.as_expr("bytes_col"),
"bool_col": ops.invert_op.as_expr("bool_col"),
}
sql = utils._apply_unary_ops(bf_df, list(ops_map.values()), list(ops_map.keys()))

snapshot.assert_match(sql, "out.sql")


def test_isnull(scalar_types_df: bpd.DataFrame, snapshot):
col_name = "float64_col"
bf_df = scalar_types_df[[col_name]]
Expand Down
8 changes: 0 additions & 8 deletions tests/unit/core/compile/sqlglot/expressions/test_numeric_ops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,6 @@ def test_floor(scalar_types_df: bpd.DataFrame, snapshot):
snapshot.assert_match(sql, "out.sql")


def test_invert(scalar_types_df: bpd.DataFrame, snapshot):
col_name = "int64_col"
bf_df = scalar_types_df[[col_name]]
sql = utils._apply_unary_ops(bf_df, [ops.invert_op.as_expr(col_name)], [col_name])

snapshot.assert_match(sql, "out.sql")


def test_ln(scalar_types_df: bpd.DataFrame, snapshot):
col_name = "float64_col"
bf_df = scalar_types_df[[col_name]]
Expand Down