Implement Spark-compatible `xpath_short`

未关闭
#288 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
rust, sql
领域
database

调研方向

Start by reading Spark's XPathShort and XPathShortEvaluator in xpath.scala and XmlExpressionEvalUtils.scala, then locate the shared number() evaluator in crates/spark/src/function/xml/ referenced by the xpath and xpath_double issues. Implement the narrowing as (d as i32) as i16, add crates/sqllogictest/test_files/xml/xpath_short.slt, and document the function with #[user_doc]. Done means the listed examples and edge cases pass in the SLT file.

由索引模型根据 Issue 内容生成。

描述

enhancement

Part of #271 and apache/datafusion-comet#7300.

What the function does

xpath_short(xml, path) evaluates an XPath 1.0 expression, converts the result with XPath number() into a
Java Double, and narrows it with Double.shortValue(), giving a SMALLINT. Both arguments are strings
(collation-aware from 4.0), and path must be foldable. The result is always nullable. Available since Spark
2.0.0.

The number() conversion is in the xpath_double issue. Parsing, DTD and entity handling, namespaces, NULL
handling and errors are in the xpath issue. This issue covers only the double-to-short step.

The narrowing is Java's (short) d, which does not saturate. JLS 5.1.3 first converts the double to int,
with saturation and NaN becoming 0, and then keeps the low 16 bits. In Rust this is (d as i32) as i16, not
d as i16, which would saturate at i16::MAX.

Examples
SELECT xpath_short('<a><b>1</b><b>2</b></a>', 'sum(a/b)');
-- 3
SELECT xpath_short('<a>this is not a number</a>', 'a');
-- 0
SELECT xpath_short('<a><b>2000000000</b><c>40000000000</c></a>', 'a/b * a/c');
-- -1
SELECT xpath_short('<a>try a boolean</a>', 'a = 10');
-- 0
SELECT xpath_short('<a><b class="odd">1</b><b class="even">2</b><b class="odd">4</b><c>8</c></a>', 'a/b');
-- 1
SELECT xpath_short('<a><b class="odd">1</b><b class="even">2</b><b class="odd">4</b><c>8</c></a>', 'sum(a/*)');
-- 15
SELECT xpath_short('<a><b class="odd">10000</b><b class="even">2</b><b class="odd">4</b><c>8</c></a>', 'sum(a/b[@class="odd"])');
-- 10004

These come from the ExpressionDescription, the Hive udf_xpath_short golden files run by
HiveCompatibilitySuite, and XPathExpressionSuite. The -1 comes from
(short) (int) 8.0E19 = (short) 2147483647 = -1.

Edge cases to test
  • Wrap-around, by code reading:
    • <a>40000</a> gives -25536;
    • <a>32768</a> gives -32768;
    • <a>65536</a> gives 0;
    • -1 div 0 gives (short) Integer.MIN_VALUE, which is 0;
    • 1 div 0 gives -1.
  • Truncation toward zero before wrapping: <a>-2.7</a> gives -2.
  • NaN gives 0. This covers non-numeric text, 0 div 0, and the empty node-set, which is NaN in
    XPath 1.0.
  • NULL or '' arguments give NULL. A non-literal path gives DATATYPE_MISMATCH.NON_FOLDABLE_INPUT.
    Malformed XML and an invalid path raise runtime errors (see the xpath issue).
Differences across Spark versions

None found beyond the shared ones in the xpath issue.

Implementation notes
  • Spark: XPathShort in sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/xml/xpath.scala.
    It calls XPathShortEvaluator (ret.shortValue()) in .../xml/XmlExpressionEvalUtils.scala.
  • DataFusion core has no equivalent.
  • Reuse the shared number() evaluator from the xpath and xpath_double issues in
    crates/spark/src/function/xml/, and narrow with (d as i32) as i16.
  • Tests: add crates/sqllogictest/test_files/xml/xpath_short.slt and document the function with #[user_doc].

This issue was generated by an LLM (Claude) from the Apache Spark source code and tests. Examples come from Spark's ExpressionDescription examples, test suites and .sql.out golden files, but please verify them against Spark before relying on them.

主要语言
Rust
星标
7
派生
15
平均合并
16 小时 43 分钟
30 天内合并 PR
26

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

apache/datafusion-spark 的其他 Issue

查看 apache/datafusion-spark 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。