Implement Spark-compatible `regexp_substr`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
Start by reading Spark's RegExpSubStr in regexpExpressions.scala, which is defined purely as NullIf(RegExpExtract(left, right, 0), "") — the new function in crates/spark/src/function/string/ must reproduce that nullif-on-empty semantics, not just a regex search. Check whether regexp_extract exists yet in this crate; if not, the shared core decides the shape of the work. Add crates/sqllogictest/test_files/string/regexp_substr.slt covering the listed NULL/empty-match/invalid-pattern cases, and annotate the UDF with #[user_doc].
由索引模型根据 Issue 内容生成。
描述
Part of #174 and apache/datafusion-comet#7300.
What the function does
regexp_substr(str, regexp) returns the first substring of str that matches the Java regular expression regexp, or NULL if there is no match. It is RuntimeReplaceable: the analyzer rewrites it to nullif(regexp_extract(str, regexp, 0), ''), so an empty match also returns NULL. Available since 3.4.0.
Both arguments are implicitly cast to STRING. Result type is the type of str (STRING; collation-aware in 4.0+). NULL if either argument is NULL. There are no position / occurrence / flags arguments (unlike some other engines' regexp_substr).
Examples
SELECT regexp_substr('Steven Jones and Stephen Smith are the best players', 'Ste(v|ph)en');
-- Steven
SELECT regexp_substr('Steven Jones and Stephen Smith are the best players', 'Jeck');
-- NULL
SELECT regexp_substr('1a 2b 14m', '\\d+');
-- 1
SELECT regexp_substr('1a 2b 14m', '\\d+(a|b|m)');
-- 1a
SELECT regexp_substr('1a 2b 14m', '\\d{2}(a|b|m)');
-- 14m
SELECT regexp_substr('1a 2b 14m', '');
-- NULL
SELECT regexp_substr('Spark', null);
-- NULL
Edge cases to test
- NULL
stror NULLregexp, literal and column: NULL. - Empty pattern returns NULL (the first match is the empty string at position 0, which
nullifturns into NULL). - A pattern whose first match is empty returns NULL even if a later match is non-empty:
regexp_substr('abc', 'b*')matches''at position 0, so the result is NULL. - No match returns NULL (not
''asregexp_extractdoes). - Invalid pattern:
INVALID_PARAMETER_VALUE.PATTERN. Because of the rewrite, thefunctionNamein the error is`regexp_extract`. - Column patterns that differ per row.
spark.sql.parser.escapedStringLiterals(default false) only affects SQL literal parsing before the function. In.slt, DataFusion keeps backslashes literal ('\d+').- Java vs Rust divergences to decline or test: lookaround / backreferences / atomic / possessive (Java only); ASCII
\d\w\sin Java vs Unicode in Rust (regexp_substr('\u0663 1', '\\d')is1in Spark; U+0663 ARABIC-INDIC DIGIT THREE);.excludes\r,\u0085,\u2028,\u2029in Java (regexp_substr('a\rb', 'a.b')is NULL in Spark);$matches before a final line terminator in Java;(?i)ASCII-only in Java; inline flag lettersU/u/d; Java-only\Q..\E,\h,\R,\Z, octal; Rust-only(?P<n>),\<,[[:alpha:]]. Leftmost-first alternation is the same on both sides (regexp_substr('ab', 'a|ab')isa). - Unicode: matches containing multi-byte and supplementary characters are returned whole.
UTF8_LCASEcollation (4.0+) matches case-insensitively.
Differences across Spark versions
- 4.0: collation-aware inputs; the
nullifliteral is created withstr's type. Otherwise none found.
Implementation notes
- Spark:
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/regexpExpressions.scala,RegExpSubStr(replacement isNullIf(RegExpExtract(left, right, 0), "")). - Because of the rewrite, Spark plans never contain
RegExpSubStr; an engine translating Spark plans seesnullif(regexp_extract(...), '').regexp_extractis not indatafusion-sparkeither; implementing it with the same core (group-index checks as inRegExpExtractBase.checkGroupIndex) would serve both. A directregexp_substrUDF is still useful for SQL users. - DataFusion core has no
regexp_substr.regexp_matchreturns capture groups of the first match as a list and uses Rust syntax. - Use the shared Java-regex compatibility helper proposed for
rlike(verified subset, decline otherwise, decided at planning time for literal patterns). - Belongs in
crates/spark/src/function/string/. Addcrates/sqllogictest/test_files/string/regexp_substr.sltand document 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 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
apache/datafusion-spark 的其他 Issue
-
enhancement
难度 2/5 1-3 小时 新手友好度 70/100
apache/datafusion-spark#287 ·
维护者通常 1 天内回复
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 80/100
apache/datafusion-spark#266 ·
维护者通常 1 天内回复
-
[Bug] make_dt_interval returns NULL for more than about 1.49 million days, Spark returns the interval可能已有人在做 @Subodh-17 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
apache/datafusion-spark#109 ·
维护者通常 1 天内回复
-
enhancement
难度 5/5 一周以上 新手友好度 18/100
apache/datafusion-spark#299 ·
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 35/100
apache/datafusion-spark#298 ·
维护者通常 1 天内回复
查看 apache/datafusion-spark 的全部 Issue
相似的 Issue
-
comp-rbac
难度 2/5 1-3 小时 新手友好度 68/100
ClickHouse/ClickHouse#131875 ·
维护者通常 1 天内回复
-
bug(python): read_transaction raises TypeError on a Rewrite with rewritten indices可能已有人在做 @Borg93 今天认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 75/100
lance-format/lance#11117 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
storytold/photocraft#15232 · 1 条评论 ·
维护者通常 1 天内回复
-
forge: fork preflight reads still send `requireCanonical: false`, which Rootstock rejects (-32603)可能已有人在做 @Ynyesto 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 72/100
foundry-rs/foundry#18485 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
bondybondbond/rushcut#238 · 1 条评论 ·