#include "RangeHashedDictionary.h" #include #include #include #include #include "DictionaryFactory.h" #include "RangeDictionaryBlockInputStream.h" #include #include namespace { using RangeStorageType = DB::RangeHashedDictionary::RangeStorageType; // Null values mean that specified boundary, either min or max is not set on range. // To simplify comparison, null value of min bound should be bigger than any other value, // and null value of maxbound - less than any value. const RangeStorageType RANGE_MIN_NULL_VALUE = std::numeric_limits::max(); const RangeStorageType RANGE_MAX_NULL_VALUE = std::numeric_limits::lowest(); // Handle both kinds of null values: explicit nulls of NullableColumn and 'implicit' nulls of Date type. RangeStorageType getColumnIntValueOrDefault(const DB::IColumn & column, size_t index, bool isDate, const RangeStorageType & default_value) { if (column.isNullAt(index)) return default_value; const RangeStorageType result = static_cast(column.getInt(index)); if (isDate && !DB::RangeHashedDictionary::Range::isCorrectDate(result)) return default_value; return result; } const DB::IColumn & unwrapNullableColumn(const DB::IColumn & column) { if (const auto * m = DB::checkAndGetColumn(&column)) { return m->getNestedColumn(); } return column; } } namespace DB { namespace ErrorCodes { extern const int LOGICAL_ERROR; extern const int BAD_ARGUMENTS; extern const int DICTIONARY_IS_EMPTY; extern const int TYPE_MISMATCH; extern const int UNSUPPORTED_METHOD; } bool RangeHashedDictionary::Range::isCorrectDate(const RangeStorageType & date) { return 0 < date && date <= DATE_LUT_MAX_DAY_NUM; } bool RangeHashedDictionary::Range::contains(const RangeStorageType & value) const { return left <= value && value <= right; } static bool operator<(const RangeHashedDictionary::Range & left, const RangeHashedDictionary::Range & right) { return std::tie(left.left, left.right) < std::tie(right.left, right.right); } RangeHashedDictionary::RangeHashedDictionary( const StorageID & dict_id_, const DictionaryStructure & dict_struct_, DictionarySourcePtr source_ptr_, const DictionaryLifetime dict_lifetime_, bool require_nonempty_) : IDictionaryBase(dict_id_) , dict_struct(dict_struct_) , source_ptr{std::move(source_ptr_)} , dict_lifetime(dict_lifetime_) , require_nonempty(require_nonempty_) { createAttributes(); loadData(); calculateBytesAllocated(); } ColumnPtr RangeHashedDictionary::getColumn( const std::string & attribute_name, const DataTypePtr & result_type, const Columns & key_columns, const DataTypes & key_types, const ColumnPtr & default_values_column) const { ColumnPtr result; const auto & attribute = getAttribute(attribute_name); const auto & dictionary_attribute = dict_struct.getAttribute(attribute_name, result_type); auto keys_size = key_columns.front()->size(); /// Cast second column to storage type Columns modified_key_columns = key_columns; auto range_storage_column = key_columns[1]; ColumnWithTypeAndName column_to_cast = {range_storage_column->convertToFullColumnIfConst(), key_types[1], ""}; auto range_column_storage_type = std::make_shared(); modified_key_columns[1] = castColumnAccurate(column_to_cast, range_column_storage_type); ColumnUInt8::MutablePtr col_null_map_to; ColumnUInt8::Container * vec_null_map_to = nullptr; if (attribute.is_nullable) { col_null_map_to = ColumnUInt8::create(keys_size, false); vec_null_map_to = &col_null_map_to->getData(); } auto type_call = [&](const auto &dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; using ValueType = DictionaryValueType; using ColumnProvider = DictionaryAttributeColumnProvider; const auto attribute_null_value = std::get(attribute.null_values); AttributeType null_value = static_cast(attribute_null_value); DictionaryDefaultValueExtractor default_value_extractor(std::move(null_value), default_values_column); auto column = ColumnProvider::getColumn(dictionary_attribute, keys_size); if constexpr (std::is_same_v) { auto * out = column.get(); getItemsImpl( attribute, modified_key_columns, [&](const size_t row, const StringRef value, bool is_null) { if (attribute.is_nullable) (*vec_null_map_to)[row] = is_null; out->insertData(value.data, value.size); }, default_value_extractor); } else { auto & out = column->getData(); getItemsImpl( attribute, modified_key_columns, [&](const size_t row, const auto value, bool is_null) { if (attribute.is_nullable) (*vec_null_map_to)[row] = is_null; out[row] = value; }, default_value_extractor); } result = std::move(column); }; callOnDictionaryAttributeType(attribute.type, type_call); if (attribute.is_nullable) { result = ColumnNullable::create(result, std::move(col_null_map_to)); } return result; } ColumnUInt8::Ptr RangeHashedDictionary::hasKeys(const Columns & key_columns, const DataTypes & key_types) const { auto range_storage_column = key_columns[1]; ColumnWithTypeAndName column_to_cast = {range_storage_column->convertToFullColumnIfConst(), key_types[1], ""}; auto range_column_storage_type = std::make_shared(); auto range_column_updated = castColumnAccurate(column_to_cast, range_column_storage_type); PaddedPODArray key_backup_storage; PaddedPODArray range_backup_storage; const PaddedPODArray & ids = getColumnVectorData(this, key_columns[0], key_backup_storage); const PaddedPODArray & dates = getColumnVectorData(this, range_column_updated, range_backup_storage); const auto & attribute = attributes.front(); ColumnUInt8::Ptr result; auto type_call = [&](const auto & dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; using ValueType = DictionaryValueType; result = hasKeysImpl(attribute, ids, dates); }; callOnDictionaryAttributeType(attribute.type, type_call); query_count.fetch_add(ids.size(), std::memory_order_relaxed); return result; } template ColumnUInt8::Ptr RangeHashedDictionary::hasKeysImpl( const Attribute & attribute, const PaddedPODArray & ids, const PaddedPODArray & dates) const { auto result = ColumnUInt8::create(ids.size()); auto& out = result->getData(); const auto & attr = *std::get>(attribute.maps); for (const auto row : ext::range(0, ids.size())) { const auto it = attr.find(ids[row]); if (it) { const auto date = dates[row]; const auto & ranges_and_values = it->getMapped(); const auto val_it = std::find_if( std::begin(ranges_and_values), std::end(ranges_and_values), [date](const Value & v) { return v.range.contains(date); }); if (val_it != std::end(ranges_and_values)) out[row] = true; else out[row] = false; } else out[row] = false; } return result; } void RangeHashedDictionary::createAttributes() { const auto size = dict_struct.attributes.size(); attributes.reserve(size); for (const auto & attribute : dict_struct.attributes) { attribute_index_by_name.emplace(attribute.name, attributes.size()); attributes.push_back(createAttribute(attribute, attribute.null_value)); if (attribute.hierarchical) throw Exception{ErrorCodes::BAD_ARGUMENTS, "Hierarchical attributes not supported by {} dictionary.", getDictionaryID().getNameForLogs()}; } } void RangeHashedDictionary::loadData() { auto stream = source_ptr->loadAll(); stream->readPrefix(); while (const auto block = stream->read()) { const auto & id_column = *block.safeGetByPosition(0).column; // Support old behaviour, where invalid date means 'open range'. const bool is_date = isDate(dict_struct.range_min->type); const auto & min_range_column = unwrapNullableColumn(*block.safeGetByPosition(1).column); const auto & max_range_column = unwrapNullableColumn(*block.safeGetByPosition(2).column); element_count += id_column.size(); for (const auto attribute_idx : ext::range(0, attributes.size())) { const auto & attribute_column = *block.safeGetByPosition(attribute_idx + 3).column; auto & attribute = attributes[attribute_idx]; for (const auto row_idx : ext::range(0, id_column.size())) { RangeStorageType lower_bound; RangeStorageType upper_bound; if (is_date) { lower_bound = getColumnIntValueOrDefault(min_range_column, row_idx, is_date, 0); upper_bound = getColumnIntValueOrDefault(max_range_column, row_idx, is_date, DATE_LUT_MAX_DAY_NUM + 1); } else { lower_bound = getColumnIntValueOrDefault(min_range_column, row_idx, is_date, RANGE_MIN_NULL_VALUE); upper_bound = getColumnIntValueOrDefault(max_range_column, row_idx, is_date, RANGE_MAX_NULL_VALUE); } setAttributeValue(attribute, id_column.getUInt(row_idx), Range{lower_bound, upper_bound}, attribute_column[row_idx]); } } } stream->readSuffix(); if (require_nonempty && 0 == element_count) throw Exception{full_name + ": dictionary source is empty and 'require_nonempty' property is set.", ErrorCodes::DICTIONARY_IS_EMPTY}; } template void RangeHashedDictionary::addAttributeSize(const Attribute & attribute) { const auto & map_ref = std::get>(attribute.maps); bytes_allocated += sizeof(Collection) + map_ref->getBufferSizeInBytes(); bucket_count = map_ref->getBufferSizeInCells(); } template <> void RangeHashedDictionary::addAttributeSize(const Attribute & attribute) { addAttributeSize(attribute); bytes_allocated += sizeof(Arena) + attribute.string_arena->size(); } void RangeHashedDictionary::calculateBytesAllocated() { bytes_allocated += attributes.size() * sizeof(attributes.front()); for (const auto & attribute : attributes) { auto type_call = [&](const auto & dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; addAttributeSize(attribute); }; callOnDictionaryAttributeType(attribute.type, type_call); } } template void RangeHashedDictionary::createAttributeImpl(Attribute & attribute, const Field & null_value) { attribute.null_values = T(null_value.get>()); attribute.maps = std::make_unique>(); } template <> void RangeHashedDictionary::createAttributeImpl(Attribute & attribute, const Field & null_value) { attribute.string_arena = std::make_unique(); const String & string = null_value.get(); const char * string_in_arena = attribute.string_arena->insert(string.data(), string.size()); attribute.null_values.emplace(string_in_arena, string.size()); attribute.maps = std::make_unique>(); } RangeHashedDictionary::Attribute RangeHashedDictionary::createAttribute(const DictionaryAttribute& attribute, const Field & null_value) { Attribute attr{attribute.underlying_type, attribute.is_nullable, {}, {}, {}}; auto type_call = [&](const auto &dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; createAttributeImpl(attr, null_value); }; callOnDictionaryAttributeType(attribute.underlying_type, type_call); return attr; } template void RangeHashedDictionary::getItemsImpl( const Attribute & attribute, const Columns & key_columns, ValueSetter && set_value, DefaultValueExtractor & default_value_extractor) const { PaddedPODArray key_backup_storage; PaddedPODArray range_backup_storage; const PaddedPODArray & ids = getColumnVectorData(this, key_columns[0], key_backup_storage); const PaddedPODArray & dates = getColumnVectorData(this, key_columns[1], range_backup_storage); const auto & attr = *std::get>(attribute.maps); for (const auto row : ext::range(0, ids.size())) { const auto it = attr.find(ids[row]); if (it) { const auto date = dates[row]; const auto & ranges_and_values = it->getMapped(); const auto val_it = std::find_if( std::begin(ranges_and_values), std::end(ranges_and_values), [date](const Value & v) { return v.range.contains(date); }); if (val_it != std::end(ranges_and_values)) { auto& value = val_it->value; if (value) set_value(row, static_cast(*value), false); // NOLINT else set_value(row, default_value_extractor[row], true); } else { set_value(row, default_value_extractor[row], false); } } else { set_value(row, default_value_extractor[row], false); } } query_count.fetch_add(ids.size(), std::memory_order_relaxed); } template void RangeHashedDictionary::setAttributeValueImpl(Attribute & attribute, const Key id, const Range & range, const Field & value) { using ValueType = std::conditional_t, StringRef, T>; auto & map = *std::get>(attribute.maps); Value value_to_insert; if (attribute.is_nullable && value.isNull()) { value_to_insert = { range, {} }; } else { if constexpr (std::is_same_v) { const auto & string = value.get(); const auto * string_in_arena = attribute.string_arena->insert(string.data(), string.size()); const StringRef string_ref{string_in_arena, string.size()}; value_to_insert = Value{ range, { string_ref }}; } else { value_to_insert = Value{ range, { value.get>() }}; } } const auto it = map.find(id); if (it) { auto & values = it->getMapped(); const auto insert_it = std::lower_bound(std::begin(values), std::end(values), range, [](const Value & lhs, const Range & rhs_range) { return lhs.range < rhs_range; }); values.insert(insert_it, std::move(value_to_insert)); } else map.insert({id, Values{std::move(value_to_insert)}}); } void RangeHashedDictionary::setAttributeValue(Attribute & attribute, const Key id, const Range & range, const Field & value) { auto type_call = [&](const auto &dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; setAttributeValueImpl(attribute, id, range, value); }; callOnDictionaryAttributeType(attribute.type, type_call); } const RangeHashedDictionary::Attribute & RangeHashedDictionary::getAttribute(const std::string & attribute_name) const { const auto it = attribute_index_by_name.find(attribute_name); if (it == std::end(attribute_index_by_name)) throw Exception{full_name + ": no such attribute '" + attribute_name + "'", ErrorCodes::BAD_ARGUMENTS}; return attributes[it->second]; } const RangeHashedDictionary::Attribute & RangeHashedDictionary::getAttributeWithType(const std::string & attribute_name, const AttributeUnderlyingType type) const { const auto & attribute = getAttribute(attribute_name); if (attribute.type != type) throw Exception{attribute_name + ": type mismatch: attribute " + attribute_name + " has type " + toString(attribute.type), ErrorCodes::TYPE_MISMATCH}; return attribute; } template void RangeHashedDictionary::getIdsAndDates( PaddedPODArray & ids, PaddedPODArray & start_dates, PaddedPODArray & end_dates) const { const auto & attribute = attributes.front(); auto type_call = [&](const auto &dictionary_attribute_type) { using Type = std::decay_t; using AttributeType = typename Type::AttributeType; using ValueType = DictionaryValueType; getIdsAndDates(attribute, ids, start_dates, end_dates); }; callOnDictionaryAttributeType(attribute.type, type_call); } template void RangeHashedDictionary::getIdsAndDates( const Attribute & attribute, PaddedPODArray & ids, PaddedPODArray & start_dates, PaddedPODArray & end_dates) const { const HashMap> & attr = *std::get>(attribute.maps); ids.reserve(attr.size()); start_dates.reserve(attr.size()); end_dates.reserve(attr.size()); const bool is_date = isDate(dict_struct.range_min->type); for (const auto & key : attr) { for (const auto & value : key.getMapped()) { ids.push_back(key.getKey()); start_dates.push_back(value.range.left); end_dates.push_back(value.range.right); if (is_date && static_cast(end_dates.back()) > DATE_LUT_MAX_DAY_NUM) end_dates.back() = 0; } } } template BlockInputStreamPtr RangeHashedDictionary::getBlockInputStreamImpl(const Names & column_names, size_t max_block_size) const { PaddedPODArray ids; PaddedPODArray start_dates; PaddedPODArray end_dates; getIdsAndDates(ids, start_dates, end_dates); using BlockInputStreamType = RangeDictionaryBlockInputStream; auto stream = std::make_shared( shared_from_this(), max_block_size, column_names, std::move(ids), std::move(start_dates), std::move(end_dates)); return stream; } struct RangeHashedDictionaryCallGetBlockInputStreamImpl { BlockInputStreamPtr stream; const RangeHashedDictionary * dict; const Names * column_names; size_t max_block_size; template void operator()() { const auto & type = dict->dict_struct.range_min->type; if (!stream && dynamic_cast *>(type.get())) stream = dict->getBlockInputStreamImpl(*column_names, max_block_size); } }; BlockInputStreamPtr RangeHashedDictionary::getBlockInputStream(const Names & column_names, size_t max_block_size) const { using ListType = TypeList; RangeHashedDictionaryCallGetBlockInputStreamImpl callable; callable.dict = this; callable.column_names = &column_names; callable.max_block_size = max_block_size; ListType::forEach(callable); if (!callable.stream) throw Exception( "Unexpected range type for RangeHashed dictionary: " + dict_struct.range_min->type->getName(), ErrorCodes::LOGICAL_ERROR); return callable.stream; } void registerDictionaryRangeHashed(DictionaryFactory & factory) { auto create_layout = [=](const std::string & full_name, const DictionaryStructure & dict_struct, const Poco::Util::AbstractConfiguration & config, const std::string & config_prefix, DictionarySourcePtr source_ptr) -> DictionaryPtr { if (dict_struct.key) throw Exception{"'key' is not supported for dictionary of layout 'range_hashed'", ErrorCodes::UNSUPPORTED_METHOD}; if (!dict_struct.range_min || !dict_struct.range_max) throw Exception{full_name + ": dictionary of layout 'range_hashed' requires .structure.range_min and .structure.range_max", ErrorCodes::BAD_ARGUMENTS}; const auto dict_id = StorageID::fromDictionaryConfig(config, config_prefix); const DictionaryLifetime dict_lifetime{config, config_prefix + ".lifetime"}; const bool require_nonempty = config.getBool(config_prefix + ".require_nonempty", false); return std::make_unique(dict_id, dict_struct, std::move(source_ptr), dict_lifetime, require_nonempty); }; factory.registerLayout("range_hashed", create_layout, false); } }