-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve LIKE pushdown for ClickHouse complex expression
- Loading branch information
Showing
3 changed files
with
172 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
plugin/trino-clickhouse/src/main/java/io/trino/plugin/clickhouse/expression/RewriteLike.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
/* | ||
* Licensed 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. | ||
*/ | ||
package io.trino.plugin.clickhouse.expression; | ||
|
||
import com.google.common.collect.ImmutableList; | ||
import io.airlift.slice.Slice; | ||
import io.trino.matching.Capture; | ||
import io.trino.matching.Captures; | ||
import io.trino.matching.Pattern; | ||
import io.trino.plugin.base.expression.ConnectorExpressionRule; | ||
import io.trino.plugin.jdbc.QueryParameter; | ||
import io.trino.plugin.jdbc.expression.ParameterizedExpression; | ||
import io.trino.spi.expression.Call; | ||
import io.trino.spi.expression.Constant; | ||
import io.trino.spi.expression.Variable; | ||
import io.trino.spi.type.CharType; | ||
import io.trino.spi.type.VarcharType; | ||
|
||
import java.util.Optional; | ||
|
||
import static io.trino.matching.Capture.newCapture; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.argument; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.argumentCount; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.call; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.constant; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.functionName; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.type; | ||
import static io.trino.plugin.base.expression.ConnectorExpressionPatterns.variable; | ||
import static io.trino.plugin.clickhouse.ClickHouseClient.supportsPushdown; | ||
import static io.trino.spi.expression.StandardFunctions.LIKE_FUNCTION_NAME; | ||
import static io.trino.spi.type.BooleanType.BOOLEAN; | ||
import static java.lang.String.format; | ||
import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
||
public class RewriteLike | ||
implements ConnectorExpressionRule<Call, ParameterizedExpression> | ||
{ | ||
private static final Capture<Variable> LIKE_VALUE = newCapture(); | ||
// TODO allow Variable as a LIKE_PATTERN: "SELECT * FROM t WHERE column_a LIKE column_b" is a valid query in ClickHouse | ||
// only Constant is allowed as LIKE_PATTERN, because according to | ||
// https://clickhouse.com/docs/en/sql-reference/functions/string-search-functions#like | ||
// ClickHouse requires backslashes in strings to be quoted as well, so you would actually need to write \\%, \\_ and \\\\ to match against literal %, _ and \ | ||
// if "column_a LIKE column_b" is pushed down, it requires more thorough consideration how to process escaping. | ||
private static final Capture<Constant> LIKE_PATTERN = newCapture(); | ||
private static final Pattern<Call> PATTERN = call() | ||
.with(functionName().equalTo(LIKE_FUNCTION_NAME)) | ||
.with(type().equalTo(BOOLEAN)) | ||
.with(argumentCount().equalTo(2)) | ||
.with(argument(0).matching(variable() | ||
.with(type().matching(type -> type instanceof CharType || type instanceof VarcharType)) | ||
.matching((Variable variable, RewriteContext<ParameterizedExpression> context) -> supportsPushdown(variable, context)) | ||
.capturedAs(LIKE_VALUE))) | ||
.with(argument(1).matching(constant() | ||
.with(type().matching(type -> type instanceof CharType || type instanceof VarcharType)) | ||
.capturedAs(LIKE_PATTERN))); | ||
|
||
@Override | ||
public Pattern<Call> getPattern() | ||
{ | ||
return PATTERN; | ||
} | ||
|
||
@Override | ||
public Optional<ParameterizedExpression> rewrite(Call expression, Captures captures, RewriteContext<ParameterizedExpression> context) | ||
{ | ||
Optional<ParameterizedExpression> value = context.defaultRewrite(captures.get(LIKE_VALUE)); | ||
if (value.isEmpty()) { | ||
return Optional.empty(); | ||
} | ||
Optional<ParameterizedExpression> pattern = context.defaultRewrite(captures.get(LIKE_PATTERN)); | ||
if (pattern.isEmpty()) { | ||
return Optional.empty(); | ||
} | ||
|
||
// Capture<Constant> LIKE_PATTERN guarantees that value is a single varchar | ||
QueryParameter patternParameter = pattern.get().parameters().getFirst(); | ||
Slice slice = (Slice) patternParameter.getValue().orElseThrow(); | ||
// ClickHouse requires backslashes in strings to be quoted as well, so you would actually need to write \\%, \\_ and \\\\ to match against literal %, _ and \ | ||
String patternValue = new String(slice.byteArray(), UTF_8); | ||
if (patternValue.contains("\\")) { | ||
// TODO escape `\` appropriately and pushdown: .replace("\\", "\\\\\\\\") | ||
return Optional.empty(); | ||
} | ||
|
||
return Optional.of(new ParameterizedExpression( | ||
format("%s LIKE %s", value.get().expression(), pattern.get().expression()), | ||
ImmutableList.<QueryParameter>builder() | ||
.addAll(value.get().parameters()) | ||
.addAll(pattern.get().parameters()) | ||
.build())); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters