Skip to content
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.

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

Storages: Refine build filters in StorageDeltaMerge #9104

Merged
merged 7 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
197 changes: 197 additions & 0 deletions dbms/src/Storages/DeltaMerge/Filter/PushDownFilter.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
// Copyright 2023 PingCAP, Inc.
JaySon-Huang marked this conversation as resolved.
Show resolved Hide resolved
//
// 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.

#include <DataStreams/GeneratedColumnPlaceholderBlockInputStream.h>
#include <Flash/Coprocessor/DAGExpressionAnalyzer.h>
#include <Flash/Coprocessor/DAGUtils.h>
#include <Flash/Coprocessor/InterpreterUtils.h>
#include <Interpreters/Context.h>
#include <Storages/DeltaMerge/Filter/PushDownFilter.h>
#include <Storages/SelectQueryInfo.h>
#include <TiDB/Decode/TypeMapping.h>

namespace DB::DM
{
PushDownFilterPtr PushDownFilter::build(
const RSOperatorPtr & rs_operator,
const ColumnInfos & table_scan_column_info,
const google::protobuf::RepeatedPtrField<tipb::Expr> & pushed_down_filters,
const ColumnDefines & columns_to_read,
const Context & context,
const LoggerPtr & tracing_logger)
{
if (pushed_down_filters.empty())
{
LOG_DEBUG(tracing_logger, "Push down filter is empty");
return std::make_shared<PushDownFilter>(rs_operator);
}
std::unordered_map<ColumnID, ColumnDefine> columns_to_read_map;
for (const auto & column : columns_to_read)
columns_to_read_map.emplace(column.id, column);

// Get the columns of the filter, is a subset of columns_to_read
std::unordered_set<ColumnID> filter_col_id_set;
for (const auto & expr : pushed_down_filters)
{
getColumnIDsFromExpr(expr, table_scan_column_info, filter_col_id_set);
}
auto filter_columns = std::make_shared<DM::ColumnDefines>();
filter_columns->reserve(filter_col_id_set.size());
for (const auto & cid : filter_col_id_set)
{
RUNTIME_CHECK_MSG(
columns_to_read_map.contains(cid),
"Filter ColumnID({}) not found in columns_to_read_map",
cid);
filter_columns->emplace_back(columns_to_read_map.at(cid));
}

// The source_columns_of_analyzer should be the same as the size of table_scan_column_info
// The columns_to_read is a subset of table_scan_column_info, when there are generated columns and extra table id column.
NamesAndTypes source_columns_of_analyzer;
source_columns_of_analyzer.reserve(table_scan_column_info.size());
for (size_t i = 0; i < table_scan_column_info.size(); ++i)
{
auto const & ci = table_scan_column_info[i];
const auto cid = ci.id;
if (ci.hasGeneratedColumnFlag())
{
const auto & col_name = GeneratedColumnPlaceholderBlockInputStream::getColumnName(i);
const auto & data_type = getDataTypeByColumnInfoForComputingLayer(ci);
source_columns_of_analyzer.emplace_back(col_name, data_type);
continue;
}
if (cid == EXTRA_TABLE_ID_COLUMN_ID)
{
source_columns_of_analyzer.emplace_back(EXTRA_TABLE_ID_COLUMN_NAME, EXTRA_TABLE_ID_COLUMN_TYPE);
continue;
}
RUNTIME_CHECK_MSG(columns_to_read_map.contains(cid), "ColumnID({}) not found in columns_to_read_map", cid);
source_columns_of_analyzer.emplace_back(columns_to_read_map.at(cid).name, columns_to_read_map.at(cid).type);
}
auto analyzer = std::make_unique<DAGExpressionAnalyzer>(source_columns_of_analyzer, context);

// Build the extra cast
ExpressionActionsPtr extra_cast = nullptr;
// need_cast_column should be the same size as table_scan_column_info and source_columns_of_analyzer
std::vector<UInt8> may_need_add_cast_column;
may_need_add_cast_column.reserve(table_scan_column_info.size());
for (const auto & col : table_scan_column_info)
may_need_add_cast_column.push_back(
!col.hasGeneratedColumnFlag() && filter_col_id_set.contains(col.id) && col.id != -1);
ExpressionActionsChain chain;
auto & step = analyzer->initAndGetLastStep(chain);
auto & actions = step.actions;
if (auto [has_cast, casted_columns]
= analyzer->buildExtraCastsAfterTS(actions, may_need_add_cast_column, table_scan_column_info);
has_cast)
{
NamesWithAliases project_cols;
for (size_t i = 0; i < columns_to_read.size(); ++i)
{
if (filter_col_id_set.contains(columns_to_read[i].id))
project_cols.emplace_back(casted_columns[i], columns_to_read[i].name);
}
actions->add(ExpressionAction::project(project_cols));

for (const auto & col : *filter_columns)
step.required_output.push_back(col.name);

extra_cast = chain.getLastActions();
chain.finalize();
chain.clear();
LOG_DEBUG(tracing_logger, "Extra cast for filter columns: {}", extra_cast->dumpActions());
}

// build filter expression actions
auto [before_where, filter_column_name, project_after_where]
= ::DB::buildPushDownFilter(pushed_down_filters, *analyzer);
LOG_DEBUG(tracing_logger, "Push down filter: {}", before_where->dumpActions());

// record current column defines
auto columns_after_cast = std::make_shared<ColumnDefines>();
if (extra_cast != nullptr)
{
columns_after_cast->reserve(columns_to_read.size());
const auto & current_names_and_types = analyzer->getCurrentInputColumns();
for (size_t i = 0; i < table_scan_column_info.size(); ++i)
{
if (table_scan_column_info[i].hasGeneratedColumnFlag()
|| table_scan_column_info[i].id == EXTRA_TABLE_ID_COLUMN_ID)
continue;
auto col = columns_to_read_map.at(table_scan_column_info[i].id);
RUNTIME_CHECK_MSG(
col.name == current_names_and_types[i].name,
"Column name mismatch, expect: {}, actual: {}",
col.name,
current_names_and_types[i].name);
columns_after_cast->push_back(col);
columns_after_cast->back().type = current_names_and_types[i].type;
}
}

return std::make_shared<PushDownFilter>(
rs_operator,
before_where,
project_after_where,
filter_columns,
filter_column_name,
extra_cast,
columns_after_cast);
}

PushDownFilterPtr PushDownFilter::build(
const SelectQueryInfo & query_info,
const ColumnDefines & columns_to_read,
const ColumnDefines & table_column_defines,
const Context & context,
const LoggerPtr & tracing_logger)
{
const auto & dag_query = query_info.dag_query;
if (unlikely(dag_query == nullptr))
return EMPTY_FILTER;

// build rough set operator
const auto rs_operator = RSOperator::build(
dag_query,
columns_to_read,
table_column_defines,
context.getSettingsRef().dt_enable_rough_set_filter,
tracing_logger);
// build push down filter
const auto & columns_to_read_info = dag_query->source_columns;
const auto & pushed_down_filters = dag_query->pushed_down_filters;
if (unlikely(context.getSettingsRef().force_push_down_all_filters_to_scan) && !dag_query->filters.empty())
{
google::protobuf::RepeatedPtrField<tipb::Expr> merged_filters{
pushed_down_filters.begin(),
pushed_down_filters.end()};
merged_filters.MergeFrom(dag_query->filters);
return PushDownFilter::build(
rs_operator,
columns_to_read_info,
merged_filters,
columns_to_read,
context,
tracing_logger);
}
return PushDownFilter::build(
rs_operator,
columns_to_read_info,
pushed_down_filters,
columns_to_read,
context,
tracing_logger);
}
} // namespace DB::DM
22 changes: 22 additions & 0 deletions dbms/src/Storages/DeltaMerge/Filter/PushDownFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
#include <Interpreters/ExpressionActions.h>
#include <Storages/DeltaMerge/Filter/RSOperator.h>

namespace DB
{
struct SelectQueryInfo;
}

namespace DB::DM
{

Expand Down Expand Up @@ -48,6 +53,23 @@ class PushDownFilter
: rs_operator(rs_operator_)
{}

// Use by StorageDisaggregated.
static PushDownFilterPtr build(
const DM::RSOperatorPtr & rs_operator,
const ColumnInfos & table_scan_column_info,
const google::protobuf::RepeatedPtrField<tipb::Expr> & pushed_down_filters,
const ColumnDefines & columns_to_read,
const Context & context,
const LoggerPtr & tracing_logger);

// Use by StorageDeltaMerge.
static DM::PushDownFilterPtr build(
const SelectQueryInfo & query_info,
const ColumnDefines & columns_to_read,
const ColumnDefines & table_column_defines,
const Context & context,
const LoggerPtr & tracing_logger);

// Rough set operator
RSOperatorPtr rs_operator;
// Filter expression actions and the name of the tmp filter column
Expand Down
39 changes: 39 additions & 0 deletions dbms/src/Storages/DeltaMerge/Filter/RSOperator.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

#include <Interpreters/Context.h>
#include <Storages/DeltaMerge/Filter/And.h>
#include <Storages/DeltaMerge/Filter/Equal.h>
#include <Storages/DeltaMerge/Filter/Greater.h>
Expand All @@ -26,6 +27,7 @@
#include <Storages/DeltaMerge/Filter/Or.h>
#include <Storages/DeltaMerge/Filter/RSOperator.h>
#include <Storages/DeltaMerge/Filter/Unsupported.h>
#include <Storages/DeltaMerge/FilterParser/FilterParser.h>

namespace DB::DM
{
Expand All @@ -46,4 +48,41 @@ RSOperatorPtr createIsNull(const Attr & attr)
RSOperatorPtr createUnsupported(const String & content, const String & reason) { return std::make_shared<Unsupported>(content, reason); }
// clang-format on

RSOperatorPtr RSOperator::build(
const std::unique_ptr<DAGQueryInfo> & dag_query,
const ColumnDefines & columns_to_read,
const ColumnDefines & table_column_defines,
bool enable_rs_filter,
const LoggerPtr & tracing_logger)
{
RUNTIME_CHECK(dag_query != nullptr);
// build rough set operator
DM::RSOperatorPtr rs_operator = DM::EMPTY_RS_OPERATOR;
if (likely(enable_rs_filter))
{
/// Query from TiDB / TiSpark
auto create_attr_by_column_id = [&table_column_defines](ColumnID column_id) -> Attr {
auto iter = std::find_if(
table_column_defines.begin(),
table_column_defines.end(),
[column_id](const ColumnDefine & d) -> bool { return d.id == column_id; });
if (iter != table_column_defines.end())
return Attr{.col_name = iter->name, .col_id = iter->id, .type = iter->type};
// Maybe throw an exception? Or check if `type` is nullptr before creating filter?
return Attr{.col_name = "", .col_id = column_id, .type = DataTypePtr{}};
};
rs_operator = FilterParser::parseDAGQuery(
*dag_query,
columns_to_read,
std::move(create_attr_by_column_id),
tracing_logger);
if (likely(rs_operator != DM::EMPTY_RS_OPERATOR))
LOG_DEBUG(tracing_logger, "Rough set filter: {}", rs_operator->toDebugString());
}
else
LOG_DEBUG(tracing_logger, "Rough set filter is disabled.");

return rs_operator;
}

} // namespace DB::DM
8 changes: 8 additions & 0 deletions dbms/src/Storages/DeltaMerge/Filter/RSOperator.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
#pragma once

#include <Common/FieldVisitors.h>
#include <Flash/Coprocessor/DAGQueryInfo.h>
#include <Storages/DeltaMerge/DeltaMergeDefines.h>
#include <Storages/DeltaMerge/Index/RSIndex.h>
#include <Storages/DeltaMerge/Index/RSResult.h>
Expand Down Expand Up @@ -48,6 +49,13 @@ class RSOperator
virtual RSResults roughCheck(size_t start_pack, size_t pack_count, const RSCheckParam & param) = 0;

virtual ColIds getColumnIDs() = 0;

static RSOperatorPtr build(
const std::unique_ptr<DAGQueryInfo> & dag_query,
const ColumnDefines & columns_to_read,
const ColumnDefines & table_column_defines,
bool enable_rs_filter,
const LoggerPtr & tracing_logger);
};

class ColCmpVal : public RSOperator
Expand Down
Loading