#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace DB { namespace ErrorCodes { extern const int UNSUPPORTED_JOIN_KEYS; extern const int LOGICAL_ERROR; extern const int SET_SIZE_LIMIT_EXCEEDED; extern const int TYPE_MISMATCH; extern const int ILLEGAL_COLUMN; } static void convertColumnToNullable(ColumnWithTypeAndName & column) { if (column.type->isNullable() || !column.type->canBeInsideNullable()) return; column.type = makeNullable(column.type); if (column.column) column.column = makeNullable(column.column); } /// Converts column to nullable if needed. No backward convertion. static ColumnWithTypeAndName correctNullability(ColumnWithTypeAndName && column, bool nullable) { if (nullable) convertColumnToNullable(column); return std::move(column); } static ColumnWithTypeAndName correctNullability(ColumnWithTypeAndName && column, bool nullable, const ColumnUInt8 & negative_null_map) { if (nullable) { convertColumnToNullable(column); if (column.type->isNullable() && negative_null_map.size()) { MutableColumnPtr mutable_column = (*std::move(column.column)).mutate(); assert_cast(*mutable_column).applyNegatedNullMap(negative_null_map); column.column = std::move(mutable_column); } } return std::move(column); } Join::Join(const AnalyzedJoin & join_options_, const Block & right_sample_block, bool any_take_last_row_) : join_options(join_options_) , kind(join_options_.kind()) , strictness(join_options_.strictness()) , key_names_right(join_options_.keyNamesRight()) , required_right_keys(join_options_.requiredRightKeys()) , use_nulls(join_options_.joinUseNulls()) , any_take_last_row(any_take_last_row_) , log(&Logger::get("Join")) { setSampleBlock(right_sample_block); } Join::Type Join::chooseMethod(const ColumnRawPtrs & key_columns, Sizes & key_sizes) { size_t keys_size = key_columns.size(); if (keys_size == 0) return Type::CROSS; bool all_fixed = true; size_t keys_bytes = 0; key_sizes.resize(keys_size); for (size_t j = 0; j < keys_size; ++j) { if (!key_columns[j]->isFixedAndContiguous()) { all_fixed = false; break; } key_sizes[j] = key_columns[j]->sizeOfValueIfFixed(); keys_bytes += key_sizes[j]; } /// If there is one numeric key that fits in 64 bits if (keys_size == 1 && key_columns[0]->isNumeric()) { size_t size_of_field = key_columns[0]->sizeOfValueIfFixed(); if (size_of_field == 1) return Type::key8; if (size_of_field == 2) return Type::key16; if (size_of_field == 4) return Type::key32; if (size_of_field == 8) return Type::key64; if (size_of_field == 16) return Type::keys128; throw Exception("Logical error: numeric column has sizeOfField not in 1, 2, 4, 8, 16.", ErrorCodes::LOGICAL_ERROR); } /// If the keys fit in N bits, we will use a hash table for N-bit-packed keys if (all_fixed && keys_bytes <= 16) return Type::keys128; if (all_fixed && keys_bytes <= 32) return Type::keys256; /// If there is single string key, use hash table of it's values. if (keys_size == 1 && (typeid_cast(key_columns[0]) || (isColumnConst(*key_columns[0]) && typeid_cast(&assert_cast(key_columns[0])->getDataColumn())))) return Type::key_string; if (keys_size == 1 && typeid_cast(key_columns[0])) return Type::key_fixed_string; /// Otherwise, will use set of cryptographic hashes of unambiguously serialized values. return Type::hashed; } static const IColumn * extractAsofColumn(const ColumnRawPtrs & key_columns) { return key_columns.back(); } template static KeyGetter createKeyGetter(const ColumnRawPtrs & key_columns, const Sizes & key_sizes) { if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) { auto key_column_copy = key_columns; auto key_size_copy = key_sizes; key_column_copy.pop_back(); key_size_copy.pop_back(); return KeyGetter(key_column_copy, key_size_copy, nullptr); } else return KeyGetter(key_columns, key_sizes, nullptr); } template struct KeyGetterForTypeImpl; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodOneNumber; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodOneNumber; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodOneNumber; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodOneNumber; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodString; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodFixedString; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodKeysFixed; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodKeysFixed; }; template struct KeyGetterForTypeImpl { using Type = ColumnsHashing::HashMethodHashed; }; template struct KeyGetterForType { using Value = typename Data::value_type; using Mapped_t = typename Data::mapped_type; using Mapped = std::conditional_t, const Mapped_t, Mapped_t>; using Type = typename KeyGetterForTypeImpl::Type; }; void Join::init(Type type_) { type = type_; if (kind == ASTTableJoin::Kind::Cross) return; joinDispatchInit(kind, strictness, maps); joinDispatch(kind, strictness, maps, [&](auto, auto, auto & map) { map.create(type); }); } size_t Join::getTotalRowCount() const { size_t res = 0; if (type == Type::CROSS) { for (const auto & block : blocks) res += block.rows(); } else { joinDispatch(kind, strictness, maps, [&](auto, auto, auto & map) { res += map.getTotalRowCount(type); }); } return res; } size_t Join::getTotalByteCount() const { size_t res = 0; if (type == Type::CROSS) { for (const auto & block : blocks) res += block.bytes(); } else { joinDispatch(kind, strictness, maps, [&](auto, auto, auto & map) { res += map.getTotalByteCountImpl(type); }); res += pool.size(); } return res; } void Join::setSampleBlock(const Block & block) { //std::unique_lock lock(rwlock); LOG_DEBUG(log, "setSampleBlock: " << block.dumpStructure()); if (!empty()) return; ColumnRawPtrs key_columns = extractKeysForJoin(key_names_right, block, right_table_keys, sample_block_with_columns_to_add); if (strictness == ASTTableJoin::Strictness::Asof) { if (kind != ASTTableJoin::Kind::Left and kind != ASTTableJoin::Kind::Inner) throw Exception("ASOF only supports LEFT and INNER as base joins", ErrorCodes::NOT_IMPLEMENTED); const IColumn * asof_column = key_columns.back(); size_t asof_size; asof_type = AsofRowRefs::getTypeSize(asof_column, asof_size); if (!asof_type) { std::string msg = "ASOF join not supported for type"; msg += asof_column->getFamilyName(); throw Exception(msg, ErrorCodes::BAD_TYPE_OF_FIELD); } key_columns.pop_back(); if (key_columns.empty()) throw Exception("ASOF join cannot be done without a joining column", ErrorCodes::LOGICAL_ERROR); /// this is going to set up the appropriate hash table for the direct lookup part of the join /// However, this does not depend on the size of the asof join key (as that goes into the BST) /// Therefore, add it back in such that it can be extracted appropriately from the full stored /// key_columns and key_sizes init(chooseMethod(key_columns, key_sizes)); key_sizes.push_back(asof_size); } else { /// Choose data structure to use for JOIN. init(chooseMethod(key_columns, key_sizes)); } blocklist_sample = Block(block.getColumnsWithTypeAndName()); prepareBlockListStructure(blocklist_sample); createMissedColumns(sample_block_with_columns_to_add); /// In case of LEFT and FULL joins, if use_nulls, convert joined columns to Nullable. if (use_nulls && isLeftOrFull(kind)) { size_t num_columns_to_add = sample_block_with_columns_to_add.columns(); for (size_t i = 0; i < num_columns_to_add; ++i) convertColumnToNullable(sample_block_with_columns_to_add.getByPosition(i)); } } namespace { /// Inserting an element into a hash table of the form `key -> reference to a string`, which will then be used by JOIN. template struct Inserter { static void insert(const Join &, Map & map, KeyGetter & key_getter, Block * stored_block, size_t i, Arena & pool); }; template struct Inserter { static ALWAYS_INLINE void insert(const Join & join, Map & map, KeyGetter & key_getter, Block * stored_block, size_t i, Arena & pool) { auto emplace_result = key_getter.emplaceKey(map, i, pool); if (emplace_result.isInserted() || join.anyTakeLastRow()) new (&emplace_result.getMapped()) typename Map::mapped_type(stored_block, i); } }; template struct Inserter { static ALWAYS_INLINE void insert(const Join &, Map & map, KeyGetter & key_getter, Block * stored_block, size_t i, Arena & pool) { auto emplace_result = key_getter.emplaceKey(map, i, pool); if (emplace_result.isInserted()) new (&emplace_result.getMapped()) typename Map::mapped_type(stored_block, i); else { /// The first element of the list is stored in the value of the hash table, the rest in the pool. emplace_result.getMapped().insert({stored_block, i}, pool); } } }; template struct Inserter { static ALWAYS_INLINE void insert(Join & join, Map & map, KeyGetter & key_getter, Block * stored_block, size_t i, Arena & pool, const IColumn * asof_column) { auto emplace_result = key_getter.emplaceKey(map, i, pool); typename Map::mapped_type * time_series_map = &emplace_result.getMapped(); if (emplace_result.isInserted()) time_series_map = new (time_series_map) typename Map::mapped_type(join.getAsofType()); time_series_map->insert(join.getAsofType(), asof_column, stored_block, i); } }; template void NO_INLINE insertFromBlockImplTypeCase( Join & join, Map & map, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, Block * stored_block, ConstNullMapPtr null_map, Arena & pool) { const IColumn * asof_column [[maybe_unused]] = nullptr; if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) asof_column = extractAsofColumn(key_columns); auto key_getter = createKeyGetter(key_columns, key_sizes); for (size_t i = 0; i < rows; ++i) { if (has_null_map && (*null_map)[i]) continue; if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) Inserter::insert(join, map, key_getter, stored_block, i, pool, asof_column); else Inserter::insert(join, map, key_getter, stored_block, i, pool); } } template void insertFromBlockImplType( Join & join, Map & map, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, Block * stored_block, ConstNullMapPtr null_map, Arena & pool) { if (null_map) insertFromBlockImplTypeCase(join, map, rows, key_columns, key_sizes, stored_block, null_map, pool); else insertFromBlockImplTypeCase(join, map, rows, key_columns, key_sizes, stored_block, null_map, pool); } template void insertFromBlockImpl( Join & join, Join::Type type, Maps & maps, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, Block * stored_block, ConstNullMapPtr null_map, Arena & pool) { switch (type) { case Join::Type::EMPTY: break; case Join::Type::CROSS: break; /// Do nothing. We have already saved block, and it is enough. #define M(TYPE) \ case Join::Type::TYPE: \ insertFromBlockImplType>::Type>(\ join, *maps.TYPE, rows, key_columns, key_sizes, stored_block, null_map, pool); \ break; APPLY_FOR_JOIN_VARIANTS(M) #undef M } } } void Join::prepareBlockListStructure(Block & stored_block) { if (isRightOrFull(kind)) { /** Move the key columns to the beginning of the block. * This is where NonJoinedBlockInputStream will expect. */ size_t key_num = 0; for (const auto & name : key_names_right) { size_t pos = stored_block.getPositionByName(name); ColumnWithTypeAndName col = stored_block.safeGetByPosition(pos); stored_block.erase(pos); stored_block.insert(key_num, std::move(col)); ++key_num; } } else { NameSet erased; /// HOTFIX: there could be duplicates in JOIN ON section /// Remove the key columns from stored_block, as they are not needed. /// However, do not erase the ASOF column if this is an asof join for (const auto & name : key_names_right) { if (strictness == ASTTableJoin::Strictness::Asof && name == key_names_right.back()) break; // this is the last column so break is OK if (!erased.count(name)) stored_block.erase(stored_block.getPositionByName(name)); erased.insert(name); } } } bool Join::addJoinedBlock(const Block & block) { std::unique_lock lock(rwlock); if (empty()) throw Exception("Logical error: Join was not initialized", ErrorCodes::LOGICAL_ERROR); size_t keys_size = key_names_right.size(); ColumnRawPtrs key_columns(keys_size); /// Rare case, when keys are constant. To avoid code bloat, simply materialize them. Columns materialized_columns; materialized_columns.reserve(keys_size); /// Memoize key columns to work. for (size_t i = 0; i < keys_size; ++i) { materialized_columns.emplace_back(recursiveRemoveLowCardinality(block.getByName(key_names_right[i]).column->convertToFullColumnIfConst())); key_columns[i] = materialized_columns.back().get(); } /// We will insert to the map only keys, where all components are not NULL. ConstNullMapPtr null_map{}; ColumnPtr null_map_holder = extractNestedColumnsAndNullMap(key_columns, null_map); size_t rows = block.rows(); blocks.push_back(block); Block * stored_block = &blocks.back(); prepareBlockListStructure(*stored_block); size_t size = stored_block->columns(); /// Rare case, when joined columns are constant. To avoid code bloat, simply materialize them. for (size_t i = 0; i < size; ++i) stored_block->safeGetByPosition(i).column = stored_block->safeGetByPosition(i).column->convertToFullColumnIfConst(); /// In case of LEFT and FULL joins, if use_nulls, convert joined columns to Nullable. if (use_nulls && isLeftOrFull(kind)) { for (size_t i = isFull(kind) ? keys_size : 0; i < size; ++i) { convertColumnToNullable(stored_block->getByPosition(i)); } } if (kind != ASTTableJoin::Kind::Cross) { joinDispatch(kind, strictness, maps, [&](auto, auto strictness_, auto & map) { insertFromBlockImpl(*this, type, map, rows, key_columns, key_sizes, stored_block, null_map, pool); }); } /// If RIGHT or FULL save blocks with nulls for NonJoinedBlockInputStream if (isRightOrFull(kind) && null_map) { UInt8 has_null = 0; for (size_t i = 0; !has_null && i < null_map->size(); ++i) has_null |= (*null_map)[i]; if (has_null) blocks_nullmaps.emplace_back(stored_block, null_map_holder); } return join_options.sizeLimits().check(getTotalRowCount(), getTotalByteCount(), "JOIN", ErrorCodes::SET_SIZE_LIMIT_EXCEEDED); } namespace { class AddedColumns { public: using TypeAndNames = std::vector>; AddedColumns(const Block & sample_block_with_columns_to_add, const Block & block_with_columns_to_add, const Block & block, const Block & blocklist_sample, const ColumnsWithTypeAndName & extras) { size_t num_columns_to_add = sample_block_with_columns_to_add.columns(); columns.reserve(num_columns_to_add); type_name.reserve(num_columns_to_add); right_indexes.reserve(num_columns_to_add); for (size_t i = 0; i < num_columns_to_add; ++i) { const ColumnWithTypeAndName & src_column = sample_block_with_columns_to_add.safeGetByPosition(i); /// Don't insert column if it's in left block or not explicitly required. if (!block.has(src_column.name) && block_with_columns_to_add.has(src_column.name)) addColumn(src_column); } for (auto & extra : extras) addColumn(extra); for (auto & tn : type_name) right_indexes.push_back(blocklist_sample.getPositionByName(tn.second)); } size_t size() const { return columns.size(); } ColumnWithTypeAndName moveColumn(size_t i) { return ColumnWithTypeAndName(std::move(columns[i]), type_name[i].first, type_name[i].second); } void appendFromBlock(const Block & block, size_t row_num) { for (size_t j = 0; j < right_indexes.size(); ++j) columns[j]->insertFrom(*block.getByPosition(right_indexes[j]).column, row_num); } void appendDefaultRow() { for (size_t j = 0; j < right_indexes.size(); ++j) columns[j]->insertDefault(); } private: TypeAndNames type_name; MutableColumns columns; std::vector right_indexes; void addColumn(const ColumnWithTypeAndName & src_column) { columns.push_back(src_column.column->cloneEmpty()); columns.back()->reserve(src_column.column->size()); type_name.emplace_back(src_column.type, src_column.name); } }; template void addFoundRow(const typename Map::mapped_type & mapped, AddedColumns & added, IColumn::Offset & current_offset [[maybe_unused]]) { if constexpr (STRICTNESS == ASTTableJoin::Strictness::Any) { added.appendFromBlock(*mapped.block, mapped.row_num); } if constexpr (STRICTNESS == ASTTableJoin::Strictness::All) { for (auto it = mapped.begin(); it.ok(); ++it) { added.appendFromBlock(*it->block, it->row_num); ++current_offset; } } }; template void addNotFoundRow(AddedColumns & added [[maybe_unused]], IColumn::Offset & current_offset [[maybe_unused]]) { if constexpr (_add_missing) { added.appendDefaultRow(); ++current_offset; } } /// Joins right table columns which indexes are present in right_indexes using specified map. /// Makes filter (1 if row presented in right table) and returns offsets to replicate (for ALL JOINS). template std::unique_ptr NO_INLINE joinRightIndexedColumns( const Join & join, const Map & map, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, AddedColumns & added_columns, ConstNullMapPtr null_map, IColumn::Filter & filter) { std::unique_ptr offsets_to_replicate; if constexpr (STRICTNESS == ASTTableJoin::Strictness::All) offsets_to_replicate = std::make_unique(rows); Arena pool; const IColumn * asof_column [[maybe_unused]] = nullptr; if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) asof_column = extractAsofColumn(key_columns); auto key_getter = createKeyGetter(key_columns, key_sizes); IColumn::Offset current_offset = 0; for (size_t i = 0; i < rows; ++i) { if (_has_null_map && (*null_map)[i]) { addNotFoundRow<_add_missing>(added_columns, current_offset); } else { auto find_result = key_getter.findKey(map, i, pool); if (find_result.isFound()) { auto & mapped = find_result.getMapped(); if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) { if (const RowRef * found = mapped.findAsof(join.getAsofType(), asof_column, i)) { filter[i] = 1; mapped.setUsed(); added_columns.appendFromBlock(*found->block, found->row_num); } else addNotFoundRow<_add_missing>(added_columns, current_offset); } else { filter[i] = 1; mapped.setUsed(); addFoundRow(mapped, added_columns, current_offset); } } else addNotFoundRow<_add_missing>(added_columns, current_offset); } if constexpr (STRICTNESS == ASTTableJoin::Strictness::All) (*offsets_to_replicate)[i] = current_offset; } return offsets_to_replicate; } template IColumn::Filter joinRightColumns( const Join & join, const Map & map, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, AddedColumns & added_columns, ConstNullMapPtr null_map, std::unique_ptr & offsets_to_replicate) { constexpr bool left_or_full = static_in_v; IColumn::Filter filter(rows, 0); if (null_map) offsets_to_replicate = joinRightIndexedColumns( join, map, rows, key_columns, key_sizes, added_columns, null_map, filter); else offsets_to_replicate = joinRightIndexedColumns( join, map, rows, key_columns, key_sizes, added_columns, null_map, filter); return filter; } template IColumn::Filter switchJoinRightColumns( Join::Type type, const Join & join, const Maps & maps_, size_t rows, const ColumnRawPtrs & key_columns, const Sizes & key_sizes, AddedColumns & added_columns, ConstNullMapPtr null_map, std::unique_ptr & offsets_to_replicate) { switch (type) { #define M(TYPE) \ case Join::Type::TYPE: \ return joinRightColumns>::Type>(\ join, *maps_.TYPE, rows, key_columns, key_sizes, added_columns, null_map, offsets_to_replicate); APPLY_FOR_JOIN_VARIANTS(M) #undef M default: throw Exception("Unsupported JOIN keys. Type: " + toString(static_cast(type)), ErrorCodes::UNSUPPORTED_JOIN_KEYS); } } } /// nameless template void Join::joinBlockImpl( Block & block, const Names & key_names_left, const Block & block_with_columns_to_add, const Maps & maps_) const { size_t keys_size = key_names_left.size(); ColumnRawPtrs key_columns(keys_size); /// Rare case, when keys are constant. To avoid code bloat, simply materialize them. Columns materialized_columns; materialized_columns.reserve(keys_size); /// Memoize key columns to work with. for (size_t i = 0; i < keys_size; ++i) { materialized_columns.emplace_back(recursiveRemoveLowCardinality(block.getByName(key_names_left[i]).column->convertToFullColumnIfConst())); key_columns[i] = materialized_columns.back().get(); } /// Keys with NULL value in any column won't join to anything. ConstNullMapPtr null_map{}; ColumnPtr null_map_holder = extractNestedColumnsAndNullMap(key_columns, null_map); size_t existing_columns = block.columns(); /** If you use FULL or RIGHT JOIN, then the columns from the "left" table must be materialized. * Because if they are constants, then in the "not joined" rows, they may have different values * - default values, which can differ from the values of these constants. */ constexpr bool right_or_full = static_in_v; if constexpr (right_or_full) { for (size_t i = 0; i < existing_columns; ++i) { block.getByPosition(i).column = block.getByPosition(i).column->convertToFullColumnIfConst(); if (use_nulls) convertColumnToNullable(block.getByPosition(i)); } } /** For LEFT/INNER JOIN, the saved blocks do not contain keys. * For FULL/RIGHT JOIN, the saved blocks contain keys; * but they will not be used at this stage of joining (and will be in `AdderNonJoined`), and they need to be skipped. * For ASOF, the last column is used as the ASOF column */ ColumnsWithTypeAndName extras; if constexpr (STRICTNESS == ASTTableJoin::Strictness::Asof) extras.push_back(right_table_keys.getByName(key_names_right.back())); AddedColumns added(sample_block_with_columns_to_add, block_with_columns_to_add, block, blocklist_sample, extras); std::unique_ptr offsets_to_replicate; IColumn::Filter row_filter = switchJoinRightColumns( type, *this, maps_, block.rows(), key_columns, key_sizes, added, null_map, offsets_to_replicate); for (size_t i = 0; i < added.size(); ++i) block.insert(added.moveColumn(i)); /// Filter & insert missing rows constexpr bool is_all_join = STRICTNESS == ASTTableJoin::Strictness::All; constexpr bool inner_or_right = static_in_v; constexpr bool left_or_full = static_in_v; std::vector right_keys_to_replicate [[maybe_unused]]; if constexpr (!is_all_join && inner_or_right) { /// If ANY INNER | RIGHT JOIN - filter all the columns except the new ones. for (size_t i = 0; i < existing_columns; ++i) block.safeGetByPosition(i).column = block.safeGetByPosition(i).column->filter(row_filter, -1); /// Add join key columns from right block if they has different name. for (size_t i = 0; i < right_table_keys.columns(); ++i) { const auto & right_key = right_table_keys.getByPosition(i); auto & left_name = key_names_left[i]; if (required_right_keys.count(right_key.name) && !block.has(right_key.name)) { const auto & col = block.getByName(left_name); bool is_nullable = (use_nulls && left_or_full) || right_key.type->isNullable(); block.insert(correctNullability({col.column, col.type, right_key.name}, is_nullable)); } } } else { /// Some trash to represent IColumn::Filter as ColumnUInt8 needed for ColumnNullable::applyNullMap() auto null_map_filter_ptr = ColumnUInt8::create(); ColumnUInt8 & null_map_filter = assert_cast(*null_map_filter_ptr); null_map_filter.getData().swap(row_filter); const IColumn::Filter & filter = null_map_filter.getData(); /// Add join key columns from right block if they has different name. for (size_t i = 0; i < right_table_keys.columns(); ++i) { const auto & right_key = right_table_keys.getByPosition(i); auto & left_name = key_names_left[i]; if (required_right_keys.count(right_key.name) && !block.has(right_key.name)) { const auto & col = block.getByName(left_name); ColumnPtr column = col.column->convertToFullColumnIfConst(); MutableColumnPtr mut_column = column->cloneEmpty(); mut_column->reserve(column->size()); for (size_t row = 0; row < filter.size(); ++row) { if (filter[row]) mut_column->insertFrom(*column, row); else mut_column->insertDefault(); } bool is_nullable = (use_nulls && left_or_full) || right_key.type->isNullable(); block.insert(correctNullability({std::move(mut_column), col.type, right_key.name}, is_nullable, null_map_filter)); if constexpr (is_all_join) right_keys_to_replicate.push_back(block.getPositionByName(right_key.name)); } } } if constexpr (is_all_join) { if (!offsets_to_replicate) throw Exception("No data to filter columns", ErrorCodes::LOGICAL_ERROR); /// If ALL ... JOIN - we replicate all the columns except the new ones. for (size_t i = 0; i < existing_columns; ++i) block.safeGetByPosition(i).column = block.safeGetByPosition(i).column->replicate(*offsets_to_replicate); /// Replicate additional right keys for (size_t pos : right_keys_to_replicate) block.safeGetByPosition(pos).column = block.safeGetByPosition(pos).column->replicate(*offsets_to_replicate); } } void Join::joinBlockImplCross(Block & block) const { /// Add new columns to the block. size_t num_existing_columns = block.columns(); size_t num_columns_to_add = sample_block_with_columns_to_add.columns(); size_t rows_left = block.rows(); ColumnRawPtrs src_left_columns(num_existing_columns); MutableColumns dst_columns(num_existing_columns + num_columns_to_add); for (size_t i = 0; i < num_existing_columns; ++i) { src_left_columns[i] = block.getByPosition(i).column.get(); dst_columns[i] = src_left_columns[i]->cloneEmpty(); } for (size_t i = 0; i < num_columns_to_add; ++i) { const ColumnWithTypeAndName & src_column = sample_block_with_columns_to_add.getByPosition(i); dst_columns[num_existing_columns + i] = src_column.column->cloneEmpty(); block.insert(src_column); } /// NOTE It would be better to use `reserve`, as well as `replicate` methods to duplicate the values of the left block. for (size_t i = 0; i < rows_left; ++i) { for (const Block & block_right : blocks) { size_t rows_right = block_right.rows(); for (size_t col_num = 0; col_num < num_existing_columns; ++col_num) for (size_t j = 0; j < rows_right; ++j) dst_columns[col_num]->insertFrom(*src_left_columns[col_num], i); for (size_t col_num = 0; col_num < num_columns_to_add; ++col_num) { const IColumn * column_right = block_right.getByPosition(col_num).column.get(); for (size_t j = 0; j < rows_right; ++j) dst_columns[num_existing_columns + col_num]->insertFrom(*column_right, j); } } } block = block.cloneWithColumns(std::move(dst_columns)); } void Join::checkTypesOfKeys(const Block & block_left, const Names & key_names_left, const Block & block_right) const { size_t keys_size = key_names_left.size(); for (size_t i = 0; i < keys_size; ++i) { /// Compare up to Nullability. DataTypePtr left_type = removeNullable(recursiveRemoveLowCardinality(block_left.getByName(key_names_left[i]).type)); DataTypePtr right_type = removeNullable(recursiveRemoveLowCardinality(block_right.getByName(key_names_right[i]).type)); if (!left_type->equals(*right_type)) throw Exception("Type mismatch of columns to JOIN by: " + key_names_left[i] + " " + left_type->getName() + " at left, " + key_names_right[i] + " " + right_type->getName() + " at right", ErrorCodes::TYPE_MISMATCH); } } static void checkTypeOfKey(const Block & block_left, const Block & block_right) { auto & [c1, left_type_origin, left_name] = block_left.safeGetByPosition(0); auto & [c2, right_type_origin, right_name] = block_right.safeGetByPosition(0); auto left_type = removeNullable(left_type_origin); auto right_type = removeNullable(right_type_origin); if (!left_type->equals(*right_type)) throw Exception("Type mismatch of columns to joinGet by: " + left_name + " " + left_type->getName() + " at left, " + right_name + " " + right_type->getName() + " at right", ErrorCodes::TYPE_MISMATCH); } DataTypePtr Join::joinGetReturnType(const String & column_name) const { std::shared_lock lock(rwlock); if (!sample_block_with_columns_to_add.has(column_name)) throw Exception("StorageJoin doesn't contain column " + column_name, ErrorCodes::LOGICAL_ERROR); return sample_block_with_columns_to_add.getByName(column_name).type; } template void Join::joinGetImpl(Block & block, const String & column_name, const Maps & maps_) const { joinBlockImpl( block, {block.getByPosition(0).name}, {sample_block_with_columns_to_add.getByName(column_name)}, maps_); } // TODO: support composite key // TODO: return multiple columns as named tuple // TODO: return array of values when strictness == ASTTableJoin::Strictness::All void Join::joinGet(Block & block, const String & column_name) const { std::shared_lock lock(rwlock); if (key_names_right.size() != 1) throw Exception("joinGet only supports StorageJoin containing exactly one key", ErrorCodes::LOGICAL_ERROR); checkTypeOfKey(block, right_table_keys); if (kind == ASTTableJoin::Kind::Left && strictness == ASTTableJoin::Strictness::Any) { joinGetImpl(block, column_name, std::get(maps)); } else throw Exception("joinGet only supports StorageJoin of type Left Any", ErrorCodes::LOGICAL_ERROR); } void Join::joinBlock(Block & block) { const Names & key_names_left = join_options.keyNamesLeft(); std::shared_lock lock(rwlock); checkTypesOfKeys(block, key_names_left, right_table_keys); if (joinDispatch(kind, strictness, maps, [&](auto kind_, auto strictness_, auto & map) { joinBlockImpl(block, key_names_left, sample_block_with_columns_to_add, map); })) { /// Joined } else if (kind == ASTTableJoin::Kind::Cross) joinBlockImplCross(block); else throw Exception("Logical error: unknown combination of JOIN", ErrorCodes::LOGICAL_ERROR); } void Join::joinTotals(Block & block) const { Block totals_without_keys = totals; if (totals_without_keys) { for (const auto & name : key_names_right) totals_without_keys.erase(totals_without_keys.getPositionByName(name)); for (size_t i = 0; i < totals_without_keys.columns(); ++i) block.insert(totals_without_keys.safeGetByPosition(i)); } else { /// We will join empty `totals` - from one row with the default values. for (size_t i = 0; i < sample_block_with_columns_to_add.columns(); ++i) { const auto & col = sample_block_with_columns_to_add.getByPosition(i); block.insert({ col.type->createColumnConstWithDefaultValue(1)->convertToFullColumnIfConst(), col.type, col.name}); } } } template struct AdderNonJoined; template struct AdderNonJoined { static void add(const Mapped & mapped, size_t & rows_added, MutableColumns & columns_right) { for (size_t j = 0; j < columns_right.size(); ++j) { const auto & mapped_column = mapped.block->getByPosition(j).column; #ifndef NDEBUG if (columns_right[j]->isNullable() != mapped_column->isNullable()) throw Exception("Wrong columns nullability", ErrorCodes::LOGICAL_ERROR); #endif columns_right[j]->insertFrom(*mapped_column, mapped.row_num); } ++rows_added; } }; template struct AdderNonJoined { static void add(const Mapped & mapped, size_t & rows_added, MutableColumns & columns_right) { for (auto it = mapped.begin(); it.ok(); ++it) { for (size_t j = 0; j < columns_right.size(); ++j) { const auto & mapped_column = it->block->getByPosition(j).column; #ifndef NDEBUG if (columns_right[j]->isNullable() != mapped_column->isNullable()) throw Exception("Wrong columns nullability", ErrorCodes::LOGICAL_ERROR); #endif columns_right[j]->insertFrom(*mapped_column, it->row_num); } ++rows_added; } } }; template struct AdderNonJoined { static void add(const Mapped & /*mapped*/, size_t & /*rows_added*/, MutableColumns & /*columns_right*/) { // If we have a leftover match in the right hand side, not required to join because we are only support asof left/inner } }; /// Stream from not joined earlier rows of the right table. class NonJoinedBlockInputStream : public IBlockInputStream { public: NonJoinedBlockInputStream(const Join & parent_, const Block & left_sample_block, UInt64 max_block_size_) : parent(parent_) , max_block_size(max_block_size_) { const Names & key_names_left = parent_.join_options.keyNamesLeft(); /** left_sample_block contains keys and "left" columns. * result_sample_block - keys, "left" columns, and "right" columns. */ std::vector is_left_key(left_sample_block.columns(), false); std::vector key_positions_left; key_positions_left.reserve(key_names_left.size()); for (const std::string & key : key_names_left) { size_t key_pos = left_sample_block.getPositionByName(key); key_positions_left.push_back(key_pos); is_left_key[key_pos] = true; } const Block & right_sample_block = parent.sample_block_with_columns_to_add; std::unordered_map left_to_right_key_map; makeResultSampleBlock(left_sample_block, right_sample_block, key_positions_left, left_to_right_key_map); auto nullability_changes = getNullabilityChanges(parent.right_table_keys, result_sample_block, key_positions_left, left_to_right_key_map); column_indices_left.reserve(left_sample_block.columns() - key_names_left.size()); column_indices_keys_and_right.reserve(key_names_left.size() + right_sample_block.columns()); key_nullability_changes.reserve(key_positions_left.size()); /// Use right key columns if present. @note left & right key columns could have different nullability. for (size_t key_pos : key_positions_left) { /// Here we establish the mapping between key columns of the left- and right-side tables. /// key_pos index is inserted in the position corresponding to key column in parent.blocks /// (saved blocks of the right-side table) and points to the same key column /// in the left_sample_block and thus in the result_sample_block. auto it = left_to_right_key_map.find(key_pos); if (it != left_to_right_key_map.end()) { column_indices_left.push_back(key_pos); key_pos = it->second; } column_indices_keys_and_right.push_back(key_pos); key_nullability_changes.push_back(nullability_changes.count(key_pos)); } for (size_t i = 0; i < left_sample_block.columns(); ++i) if (!is_left_key[i]) column_indices_left.emplace_back(i); size_t num_additional_keys = left_to_right_key_map.size(); for (size_t i = left_sample_block.columns(); i < result_sample_block.columns() - num_additional_keys; ++i) column_indices_keys_and_right.emplace_back(i); } String getName() const override { return "NonJoined"; } Block getHeader() const override { return result_sample_block; } protected: Block readImpl() override { if (parent.blocks.empty()) return Block(); return createBlock(); } private: const Join & parent; UInt64 max_block_size; Block result_sample_block; /// Indices of columns in result_sample_block that come from the left-side table (except shared right+left key columns). ColumnNumbers column_indices_left; /// Indices of key columns in result_sample_block or columns that come from the right-side table. /// Order is significant: it is the same as the order of columns in the blocks of the right-side table that are saved in parent.blocks. ColumnNumbers column_indices_keys_and_right; /// Which key columns need change nullability (right is nullable and left is not or vice versa) std::vector key_nullability_changes; std::any position; std::optional nulls_position; void makeResultSampleBlock(const Block & left_sample_block, const Block & right_sample_block, const std::vector & key_positions_left, std::unordered_map & left_to_right_key_map) { result_sample_block = materializeBlock(left_sample_block); /// Convert left columns to Nullable if allowed if (parent.use_nulls) for (size_t i = 0; i < result_sample_block.columns(); ++i) convertColumnToNullable(result_sample_block.getByPosition(i)); /// Add columns from the right-side table to the block. for (size_t i = 0; i < right_sample_block.columns(); ++i) { const ColumnWithTypeAndName & src_column = right_sample_block.getByPosition(i); if (!result_sample_block.has(src_column.name)) result_sample_block.insert(src_column.cloneEmpty()); } /// Add join key columns from right block if they has different name. for (size_t i = 0; i < parent.right_table_keys.columns(); ++i) { const auto & right_key = parent.right_table_keys.getByPosition(i); size_t left_key_pos = key_positions_left[i]; if (parent.required_right_keys.count(right_key.name) && !result_sample_block.has(right_key.name)) { const auto & col = result_sample_block.getByPosition(left_key_pos); bool is_nullable = (parent.use_nulls && isFull(parent.kind)) || right_key.type->isNullable(); result_sample_block.insert(correctNullability({col.column, col.type, right_key.name}, is_nullable)); size_t right_key_pos = result_sample_block.getPositionByName(right_key.name); left_to_right_key_map[left_key_pos] = right_key_pos; } } } Block createBlock() { MutableColumns columns_left = columnsForIndex(result_sample_block, column_indices_left); MutableColumns columns_keys_and_right = columnsForIndex(result_sample_block, column_indices_keys_and_right); /// Temporary change destination key columns' nullability according to mapped block changeNullability(columns_keys_and_right, key_nullability_changes); size_t rows_added = 0; auto fill_callback = [&](auto, auto strictness, auto & map) { rows_added = fillColumnsFromMap(map, columns_keys_and_right); }; if (!joinDispatch(parent.kind, parent.strictness, parent.maps, fill_callback)) throw Exception("Logical error: unknown JOIN strictness (must be on of: ANY, ALL, ASOF)", ErrorCodes::LOGICAL_ERROR); fillNullsFromBlocks(columns_keys_and_right, rows_added); if (!rows_added) return {}; /// Revert columns nullability changeNullability(columns_keys_and_right, key_nullability_changes); Block res = result_sample_block.cloneEmpty(); /// @note it's possible to make ColumnConst here and materialize it later for (size_t i = 0; i < columns_left.size(); ++i) res.getByPosition(column_indices_left[i]).column = columns_left[i]->cloneResized(rows_added); for (size_t i = 0; i < columns_keys_and_right.size(); ++i) res.getByPosition(column_indices_keys_and_right[i]).column = std::move(columns_keys_and_right[i]); return res; } static MutableColumns columnsForIndex(const Block & block, const ColumnNumbers & indices) { size_t num_columns = indices.size(); MutableColumns columns; columns.resize(num_columns); for (size_t i = 0; i < num_columns; ++i) { const auto & src_col = block.safeGetByPosition(indices[i]); columns[i] = src_col.type->createColumn(); } return columns; } template size_t fillColumnsFromMap(const Maps & maps, MutableColumns & columns_keys_and_right) { switch (parent.type) { #define M(TYPE) \ case Join::Type::TYPE: \ return fillColumns(*maps.TYPE, columns_keys_and_right); APPLY_FOR_JOIN_VARIANTS(M) #undef M default: throw Exception("Unsupported JOIN keys. Type: " + toString(static_cast(parent.type)), ErrorCodes::UNSUPPORTED_JOIN_KEYS); } __builtin_unreachable(); } template size_t fillColumns(const Map & map, MutableColumns & columns_keys_and_right) { using Mapped = typename Map::mapped_type; using Iterator = typename Map::const_iterator; size_t rows_added = 0; if (!position.has_value()) position = std::make_any(map.begin()); Iterator & it = std::any_cast(position); auto end = map.end(); for (; it != end; ++it) { const Mapped & mapped = it->getSecond(); if (mapped.getUsed()) continue; AdderNonJoined::add(mapped, rows_added, columns_keys_and_right); if (rows_added >= max_block_size) { ++it; break; } } return rows_added; } void fillNullsFromBlocks(MutableColumns & columns_keys_and_right, size_t & rows_added) { if (!nulls_position.has_value()) nulls_position = parent.blocks_nullmaps.begin(); auto end = parent.blocks_nullmaps.end(); for (auto & it = *nulls_position; it != end && rows_added < max_block_size; ++it) { const Block * block = it->first; const NullMap & nullmap = assert_cast(*it->second).getData(); for (size_t row = 0; row < nullmap.size(); ++row) { if (nullmap[row]) { for (size_t col = 0; col < columns_keys_and_right.size(); ++col) columns_keys_and_right[col]->insertFrom(*block->getByPosition(col).column, row); ++rows_added; } } } } static std::unordered_set getNullabilityChanges(const Block & right_table_keys, const Block & out_block, const std::vector & key_positions, const std::unordered_map & left_to_right_key_map) { std::unordered_set nullability_changes; for (size_t i = 0; i < key_positions.size(); ++i) { size_t key_pos = key_positions[i]; auto it = left_to_right_key_map.find(key_pos); if (it != left_to_right_key_map.end()) key_pos = it->second; const auto & dst = out_block.getByPosition(key_pos).column; const auto & src = right_table_keys.getByPosition(i).column; if (dst->isNullable() != src->isNullable()) nullability_changes.insert(key_pos); } return nullability_changes; } static void changeNullability(MutableColumns & columns, const std::vector & changes_bitmap) { /// @note changes_bitmap.size() <= columns.size() for (size_t i = 0; i < changes_bitmap.size(); ++i) { if (changes_bitmap[i]) { ColumnPtr column = std::move(columns[i]); if (auto * nullable = checkAndGetColumn(*column)) column = nullable->getNestedColumnPtr(); else column = makeNullable(column); columns[i] = (*std::move(column)).mutate(); } } } }; BlockInputStreamPtr Join::createStreamWithNonJoinedRows(const Block & left_sample_block, UInt64 max_block_size) const { return std::make_shared(*this, left_sample_block, max_block_size); } }