blob: 2350570341d490bc240a8f2c9df60f2ea99ab557 [file] [log] [blame]
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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.
#include "vec/functions/match.h"
#include <hs/hs.h>
#include "olap/rowset/segment_v2/index_reader_helper.h"
#include "olap/rowset/segment_v2/inverted_index/analyzer/analyzer.h"
#include "runtime/query_context.h"
#include "runtime/runtime_state.h"
#include "util/debug_points.h"
namespace doris::vectorized {
#include "common/compile_check_begin.h"
namespace {
const InvertedIndexAnalyzerCtx* get_match_analyzer_ctx(FunctionContext* context) {
if (context == nullptr) {
return nullptr;
}
auto* analyzer_ctx = reinterpret_cast<const InvertedIndexAnalyzerCtx*>(
context->get_function_state(FunctionContext::THREAD_LOCAL));
if (analyzer_ctx == nullptr) {
analyzer_ctx = reinterpret_cast<const InvertedIndexAnalyzerCtx*>(
context->get_function_state(FunctionContext::FRAGMENT_LOCAL));
}
return analyzer_ctx;
}
} // namespace
Status FunctionMatchBase::evaluate_inverted_index(
const ColumnsWithTypeAndName& arguments,
const std::vector<vectorized::IndexFieldNameAndTypePair>& data_type_with_names,
std::vector<segment_v2::IndexIterator*> iterators, uint32_t num_rows,
const InvertedIndexAnalyzerCtx* analyzer_ctx,
segment_v2::InvertedIndexResultBitmap& bitmap_result) const {
DCHECK(arguments.size() == 1);
DCHECK(data_type_with_names.size() == 1);
DCHECK(iterators.size() == 1);
auto* iter = iterators[0];
auto data_type_with_name = data_type_with_names[0];
if (iter == nullptr) {
return Status::OK();
}
const std::string& function_name = get_name();
if (function_name == MATCH_PHRASE_FUNCTION || function_name == MATCH_PHRASE_PREFIX_FUNCTION ||
function_name == MATCH_PHRASE_EDGE_FUNCTION) {
auto reader = iter->get_reader(InvertedIndexReaderType::FULLTEXT);
if (reader && !segment_v2::IndexReaderHelper::is_support_phrase(reader)) {
return Status::Error<ErrorCode::INDEX_INVALID_PARAMETERS>(
"phrase queries require setting support_phrase = true");
}
}
Field param_value;
arguments[0].column->get(0, param_value);
if (param_value.is_null()) {
// if query value is null, skip evaluate inverted index
return Status::OK();
}
auto param_type = arguments[0].type->get_primitive_type();
if (!is_string_type(param_type)) {
return Status::Error<ErrorCode::INDEX_INVALID_PARAMETERS>(
"arguments for match must be string");
}
std::unique_ptr<InvertedIndexQueryParamFactory> query_param = nullptr;
RETURN_IF_ERROR(InvertedIndexQueryParamFactory::create_query_value(param_type, &param_value,
query_param));
InvertedIndexParam param;
param.column_name = data_type_with_name.first;
param.column_type = data_type_with_name.second;
param.query_value = query_param->get_value();
param.query_type = get_query_type_from_fn_name();
param.num_rows = num_rows;
param.roaring = std::make_shared<roaring::Roaring>();
param.analyzer_ctx = analyzer_ctx;
RETURN_IF_ERROR(iter->read_from_index(segment_v2::IndexParam {&param}));
std::shared_ptr<roaring::Roaring> null_bitmap = std::make_shared<roaring::Roaring>();
if (iter->has_null()) {
segment_v2::InvertedIndexQueryCacheHandle null_bitmap_cache_handle;
RETURN_IF_ERROR(iter->read_null_bitmap(&null_bitmap_cache_handle));
null_bitmap = null_bitmap_cache_handle.get_bitmap();
}
segment_v2::InvertedIndexResultBitmap result(param.roaring, null_bitmap);
bitmap_result = result;
bitmap_result.mask_out_null();
return Status::OK();
}
Status FunctionMatchBase::execute_impl(FunctionContext* context, Block& block,
const ColumnNumbers& arguments, uint32_t result,
size_t input_rows_count) const {
ColumnPtr& column_ptr = block.get_by_position(arguments[1]).column;
DataTypePtr& type_ptr = block.get_by_position(arguments[1]).type;
auto format_options = DataTypeSerDe::get_default_format_options();
auto time_zone = cctz::utc_time_zone();
format_options.timezone =
(context && context->state()) ? &context->state()->timezone_obj() : &time_zone;
auto match_query_str = type_ptr->to_string(*column_ptr, 0, format_options);
std::string column_name = block.get_by_position(arguments[0]).name;
VLOG_DEBUG << "begin to execute match directly, column_name=" << column_name
<< ", match_query_str=" << match_query_str;
auto* analyzer_ctx = get_match_analyzer_ctx(context);
const ColumnPtr source_col =
block.get_by_position(arguments[0]).column->convert_to_full_column_if_const();
const auto* values = check_and_get_column<ColumnString>(source_col.get());
const ColumnArray* array_col = nullptr;
if (is_column<vectorized::ColumnArray>(source_col.get())) {
array_col = check_and_get_column<ColumnArray>(source_col.get());
if (array_col && !array_col->get_data().is_column_string()) {
return Status::NotSupported(fmt::format(
"unsupported nested array of type {} for function {}",
is_column_nullable(array_col->get_data()) ? array_col->get_data().get_name()
: array_col->get_data().get_name(),
get_name()));
}
if (is_column_nullable(array_col->get_data())) {
const auto& array_nested_null_column =
reinterpret_cast<const ColumnNullable&>(array_col->get_data());
values = check_and_get_column<ColumnString>(
*(array_nested_null_column.get_nested_column_ptr()));
} else {
// array column element is always set Nullable for now.
values = check_and_get_column<ColumnString>(*(array_col->get_data_ptr()));
}
} else if (const auto* nullable = check_and_get_column<ColumnNullable>(source_col.get())) {
values = check_and_get_column<ColumnString>(*nullable->get_nested_column_ptr());
}
if (!values) {
LOG(WARNING) << "Illegal column " << source_col->get_name();
return Status::InternalError("Not supported input column types");
}
// result column
auto res = ColumnUInt8::create();
ColumnUInt8::Container& vec_res = res->get_data();
// set default value to 0, and match functions only need to set 1/true
vec_res.resize_fill(input_rows_count);
RETURN_IF_ERROR(execute_match(context, column_name, match_query_str, input_rows_count, values,
analyzer_ctx, (array_col ? &(array_col->get_offsets()) : nullptr),
vec_res));
block.replace_by_position(result, std::move(res));
return Status::OK();
}
inline doris::segment_v2::InvertedIndexQueryType FunctionMatchBase::get_query_type_from_fn_name()
const {
std::string fn_name = get_name();
if (fn_name == MATCH_ANY_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_ANY_QUERY;
} else if (fn_name == MATCH_ALL_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_ALL_QUERY;
} else if (fn_name == MATCH_PHRASE_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_PHRASE_QUERY;
} else if (fn_name == MATCH_PHRASE_PREFIX_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_PHRASE_PREFIX_QUERY;
} else if (fn_name == MATCH_PHRASE_REGEXP_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_REGEXP_QUERY;
} else if (fn_name == MATCH_PHRASE_EDGE_FUNCTION) {
return doris::segment_v2::InvertedIndexQueryType::MATCH_PHRASE_EDGE_QUERY;
}
return doris::segment_v2::InvertedIndexQueryType::UNKNOWN_QUERY;
}
std::vector<TermInfo> FunctionMatchBase::analyse_query_str_token(
const InvertedIndexAnalyzerCtx* analyzer_ctx, const std::string& match_query_str,
const std::string& column_name) const {
std::vector<TermInfo> query_tokens;
if (analyzer_ctx == nullptr) {
return query_tokens;
}
VLOG_DEBUG << "begin to run " << get_name() << ", parser_type: "
<< inverted_index_parser_type_to_string(analyzer_ctx->parser_type);
if (!analyzer_ctx->should_tokenize()) {
query_tokens.emplace_back(match_query_str);
return query_tokens;
}
auto reader = doris::segment_v2::inverted_index::InvertedIndexAnalyzer::create_reader(
analyzer_ctx->char_filter_map);
reader->init(match_query_str.data(), (int)match_query_str.size(), true);
query_tokens = doris::segment_v2::inverted_index::InvertedIndexAnalyzer::get_analyse_result(
reader, analyzer_ctx->analyzer);
return query_tokens;
}
inline std::vector<TermInfo> FunctionMatchBase::analyse_data_token(
const std::string& column_name, const InvertedIndexAnalyzerCtx* analyzer_ctx,
const ColumnString* string_col, int32_t current_block_row_idx,
const ColumnArray::Offsets64* array_offsets, int32_t& current_src_array_offset) const {
std::vector<TermInfo> data_tokens;
if (analyzer_ctx == nullptr) {
return data_tokens;
}
if (array_offsets) {
for (auto next_src_array_offset = (*array_offsets)[current_block_row_idx];
current_src_array_offset < next_src_array_offset; ++current_src_array_offset) {
const auto& str_ref = string_col->get_data_at(current_src_array_offset);
if (!analyzer_ctx->should_tokenize()) {
data_tokens.emplace_back(str_ref.to_string());
continue;
}
auto reader = doris::segment_v2::inverted_index::InvertedIndexAnalyzer::create_reader(
analyzer_ctx->char_filter_map);
reader->init(str_ref.data, (int)str_ref.size, true);
data_tokens =
doris::segment_v2::inverted_index::InvertedIndexAnalyzer::get_analyse_result(
reader, analyzer_ctx->analyzer);
}
} else {
const auto& str_ref = string_col->get_data_at(current_block_row_idx);
if (!analyzer_ctx->should_tokenize()) {
data_tokens.emplace_back(str_ref.to_string());
} else {
auto reader = doris::segment_v2::inverted_index::InvertedIndexAnalyzer::create_reader(
analyzer_ctx->char_filter_map);
reader->init(str_ref.data, (int)str_ref.size, true);
data_tokens =
doris::segment_v2::inverted_index::InvertedIndexAnalyzer::get_analyse_result(
reader, analyzer_ctx->analyzer);
}
}
return data_tokens;
}
Status FunctionMatchBase::check(FunctionContext* context, const std::string& function_name) const {
if (!context->state()->query_options().enable_match_without_inverted_index) {
return Status::Error<ErrorCode::INVERTED_INDEX_NOT_SUPPORTED>(
"{} not support execute_match", function_name);
}
DBUG_EXECUTE_IF("match.invert_index_not_support_execute_match", {
return Status::Error<ErrorCode::INVERTED_INDEX_NOT_SUPPORTED>(
"debug point: {} not support execute_match", function_name);
});
return Status::OK();
}
Status FunctionMatchAny::execute_match(FunctionContext* context, const std::string& column_name,
const std::string& match_query_str, size_t input_rows_count,
const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx,
const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
auto query_tokens = analyse_query_str_token(analyzer_ctx, match_query_str, column_name);
if (query_tokens.empty()) {
VLOG_DEBUG << fmt::format(
"token parser result is empty for query, "
"please check your query: '{}' and index parser: '{}'",
match_query_str,
analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
return Status::OK();
}
auto current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
// TODO: more efficient impl
for (auto& term_info : query_tokens) {
auto it =
std::find_if(data_tokens.begin(), data_tokens.end(), [&](const TermInfo& info) {
return info.get_single_term() == term_info.get_single_term();
});
if (it != data_tokens.end()) {
result[i] = true;
break;
}
}
}
return Status::OK();
}
Status FunctionMatchAll::execute_match(FunctionContext* context, const std::string& column_name,
const std::string& match_query_str, size_t input_rows_count,
const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx,
const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
auto query_tokens = analyse_query_str_token(analyzer_ctx, match_query_str, column_name);
if (query_tokens.empty()) {
VLOG_DEBUG << fmt::format(
"token parser result is empty for query, "
"please check your query: '{}' and index parser: '{}'",
match_query_str,
analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
return Status::OK();
}
auto current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
// TODO: more efficient impl
auto find_count = 0;
for (auto& term_info : query_tokens) {
auto it =
std::find_if(data_tokens.begin(), data_tokens.end(), [&](const TermInfo& info) {
return info.get_single_term() == term_info.get_single_term();
});
if (it != data_tokens.end()) {
++find_count;
} else {
break;
}
}
if (find_count == query_tokens.size()) {
result[i] = true;
}
}
return Status::OK();
}
Status FunctionMatchPhrase::execute_match(FunctionContext* context, const std::string& column_name,
const std::string& match_query_str,
size_t input_rows_count, const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx,
const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
auto query_tokens = analyse_query_str_token(analyzer_ctx, match_query_str, column_name);
if (query_tokens.empty()) {
VLOG_DEBUG << fmt::format(
"token parser result is empty for query, "
"please check your query: '{}' and index parser: '{}'",
match_query_str,
analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
return Status::OK();
}
auto current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
// TODO: more efficient impl
bool matched = false;
auto data_it = data_tokens.begin();
while (data_it != data_tokens.end()) {
// find position of first token
data_it = std::find_if(data_it, data_tokens.end(), [&](const TermInfo& info) {
return info.get_single_term() == query_tokens[0].get_single_term();
});
if (data_it != data_tokens.end()) {
matched = true;
auto data_it_next = ++data_it;
auto query_it = query_tokens.begin() + 1;
// compare query_tokens after the first to data_tokens one by one
while (query_it != query_tokens.end()) {
if (data_it_next == data_tokens.end() ||
data_it_next->get_single_term() != query_it->get_single_term()) {
matched = false;
break;
}
query_it++;
data_it_next++;
}
if (matched) {
break;
}
}
}
// check matched
if (matched) {
result[i] = true;
}
}
return Status::OK();
}
Status FunctionMatchPhrasePrefix::execute_match(
FunctionContext* context, const std::string& column_name,
const std::string& match_query_str, size_t input_rows_count, const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx, const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
auto query_tokens = analyse_query_str_token(analyzer_ctx, match_query_str, column_name);
if (query_tokens.empty()) {
VLOG_DEBUG << fmt::format(
"token parser result is empty for query, "
"please check your query: '{}' and index parser: '{}'",
match_query_str,
analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
return Status::OK();
}
int32_t current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
int64_t dis_count = data_tokens.size() - query_tokens.size();
if (dis_count < 0) {
continue;
}
for (size_t j = 0; j < dis_count + 1; j++) {
if (data_tokens[j].get_single_term() == query_tokens[0].get_single_term() ||
query_tokens.size() == 1) {
bool match = true;
for (size_t k = 0; k < query_tokens.size(); k++) {
const std::string& data_token = data_tokens[j + k].get_single_term();
const std::string& query_token = query_tokens[k].get_single_term();
if (k == query_tokens.size() - 1) {
if (data_token.compare(0, query_token.size(), query_token) != 0) {
match = false;
break;
}
} else {
if (data_token != query_token) {
match = false;
break;
}
}
}
if (match) {
result[i] = true;
break;
}
}
}
}
return Status::OK();
}
Status FunctionMatchRegexp::execute_match(FunctionContext* context, const std::string& column_name,
const std::string& match_query_str,
size_t input_rows_count, const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx,
const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
VLOG_DEBUG << "begin to run FunctionMatchRegexp::execute_match, parser_type: "
<< (analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
const std::string& pattern = match_query_str;
hs_database_t* database = nullptr;
hs_compile_error_t* compile_err = nullptr;
hs_scratch_t* scratch = nullptr;
if (hs_compile(pattern.data(), HS_FLAG_DOTALL | HS_FLAG_ALLOWEMPTY | HS_FLAG_UTF8,
HS_MODE_BLOCK, nullptr, &database, &compile_err) != HS_SUCCESS) {
std::string err_message = "hyperscan compilation failed: ";
err_message.append(compile_err->message);
LOG(ERROR) << err_message;
hs_free_compile_error(compile_err);
return Status::Error<ErrorCode::INDEX_INVALID_PARAMETERS>(err_message);
}
if (hs_alloc_scratch(database, &scratch) != HS_SUCCESS) {
LOG(ERROR) << "hyperscan could not allocate scratch space.";
hs_free_database(database);
return Status::Error<ErrorCode::INDEX_INVALID_PARAMETERS>(
"hyperscan could not allocate scratch space.");
}
auto on_match = [](unsigned int id, unsigned long long from, unsigned long long to,
unsigned int flags, void* context) -> int {
*((bool*)context) = true;
return 0;
};
try {
auto current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
for (auto& input : data_tokens) {
bool is_match = false;
const auto& input_str = input.get_single_term();
if (hs_scan(database, input_str.data(), (uint32_t)input_str.size(), 0, scratch,
on_match, (void*)&is_match) != HS_SUCCESS) {
LOG(ERROR) << "hyperscan match failed: " << input_str;
break;
}
if (is_match) {
result[i] = true;
break;
}
}
}
}
_CLFINALLY({
hs_free_scratch(scratch);
hs_free_database(database);
})
return Status::OK();
}
Status FunctionMatchPhraseEdge::execute_match(
FunctionContext* context, const std::string& column_name,
const std::string& match_query_str, size_t input_rows_count, const ColumnString* string_col,
const InvertedIndexAnalyzerCtx* analyzer_ctx, const ColumnArray::Offsets64* array_offsets,
ColumnUInt8::Container& result) const {
RETURN_IF_ERROR(check(context, name));
auto query_tokens = analyse_query_str_token(analyzer_ctx, match_query_str, column_name);
if (query_tokens.empty()) {
VLOG_DEBUG << fmt::format(
"token parser result is empty for query, "
"please check your query: '{}' and index parser: '{}'",
match_query_str,
analyzer_ctx ? inverted_index_parser_type_to_string(analyzer_ctx->parser_type)
: "unknown");
return Status::OK();
}
int32_t current_src_array_offset = 0;
for (int i = 0; i < input_rows_count; i++) {
auto data_tokens = analyse_data_token(column_name, analyzer_ctx, string_col, i,
array_offsets, current_src_array_offset);
int64_t dis_count = data_tokens.size() - query_tokens.size();
if (dis_count < 0) {
continue;
}
for (size_t j = 0; j < dis_count + 1; j++) {
bool match = true;
if (query_tokens.size() == 1) {
if (data_tokens[j].get_single_term().find(query_tokens[0].get_single_term()) ==
std::string::npos) {
match = false;
}
} else {
for (size_t k = 0; k < query_tokens.size(); k++) {
const std::string& data_token = data_tokens[j + k].get_single_term();
const std::string& query_token = query_tokens[k].get_single_term();
if (k == 0) {
if (!data_token.ends_with(query_token)) {
match = false;
break;
}
} else if (k == query_tokens.size() - 1) {
if (!data_token.starts_with(query_token)) {
match = false;
break;
}
} else {
if (data_token != query_token) {
match = false;
break;
}
}
}
}
if (match) {
result[i] = true;
break;
}
}
}
return Status::OK();
}
void register_function_match(SimpleFunctionFactory& factory) {
factory.register_function<FunctionMatchAny>();
factory.register_function<FunctionMatchAll>();
factory.register_function<FunctionMatchPhrase>();
factory.register_function<FunctionMatchPhrasePrefix>();
factory.register_function<FunctionMatchRegexp>();
factory.register_function<FunctionMatchPhraseEdge>();
}
#include "common/compile_check_end.h"
} // namespace doris::vectorized