#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace DB { namespace ErrorCodes { extern const int ILLEGAL_TYPE_OF_ARGUMENT; extern const int BAD_ARGUMENTS; extern const int NUMBER_OF_ARGUMENTS_DOESNT_MATCH; extern const int ILLEGAL_COLUMN; extern const int LOGICAL_ERROR; } namespace { /** transform(x, [from...], [to...], default) * - converts the values according to the explicitly specified mapping. * * x - what to transform. * from - a constant array of values for the transformation. * to - a constant array of values into which values from `from` must be transformed. * default - what value to use if x is not equal to any of the values in `from`. * `from` and `to` - arrays of the same size. * * Types: * transform(T, Array(T), Array(U), U) -> U * * transform(x, [from...], [to...]) * - if `default` is not specified, then for values of `x` for which there is no corresponding element in `from`, the unchanged value of `x` is returned. * * Types: * transform(T, Array(T), Array(T)) -> T * * Note: the implementation is rather cumbersome. */ class FunctionTransform : public IFunction { public: static constexpr auto name = "transform"; static FunctionPtr create(ContextPtr) { return std::make_shared(); } String getName() const override { return name; } bool isVariadic() const override { return true; } bool isSuitableForShortCircuitArgumentsExecution(const DataTypesWithConstInfo & /*arguments*/) const override { return true; } size_t getNumberOfArguments() const override { return 0; } bool useDefaultImplementationForConstants() const override { return false; } bool useDefaultImplementationForNulls() const override { return false; } bool useDefaultImplementationForNothing() const override { return false; } ColumnNumbers getArgumentsThatAreAlwaysConstant() const override { return {1, 2}; } DataTypePtr getReturnTypeImpl(const DataTypes & arguments) const override { const auto args_size = arguments.size(); if (args_size != 3 && args_size != 4) throw Exception( ErrorCodes::NUMBER_OF_ARGUMENTS_DOESNT_MATCH, "Number of arguments for function {} doesn't match: " "passed {}, should be 3 or 4", getName(), args_size); const DataTypePtr & type_x = arguments[0]; const DataTypeArray * type_arr_from = checkAndGetDataType(arguments[1].get()); if (!type_arr_from) throw Exception( ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT, "Second argument of function {}, must be array of source values to transform from.", getName()); const auto type_arr_from_nested = type_arr_from->getNestedType(); const DataTypeArray * type_arr_to = checkAndGetDataType(arguments[2].get()); if (!type_arr_to) throw Exception( ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT, "Third argument of function {}, must be array of destination values to transform to.", getName()); const DataTypePtr & type_arr_to_nested = type_arr_to->getNestedType(); if (args_size == 3) { if ((type_x->isValueRepresentedByNumber() != type_arr_to_nested->isValueRepresentedByNumber()) || (isString(type_x) != isString(type_arr_to_nested))) throw Exception( ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT, "Function {} has signature: " "transform(T, Array(T), Array(U), U) -> U; " "or transform(T, Array(T), Array(T)) -> T; where T and U are types.", getName()); auto ret = tryGetLeastSupertype(DataTypes{type_arr_to_nested, type_x}); if (!ret) throw Exception( ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT, "Function {} has signature: " "transform(T, Array(T), Array(U), U) -> U; " "or transform(T, Array(T), Array(T)) -> T; where T and U are types.", getName()); checkAllowedType(ret); return ret; } else { auto ret = tryGetLeastSupertype(DataTypes{type_arr_to_nested, arguments[3]}); if (!ret) throw Exception( ErrorCodes::ILLEGAL_TYPE_OF_ARGUMENT, "Function {} have signature: " "transform(T, Array(T), Array(U), U) -> U; " "or transform(T, Array(T), Array(T)) -> T; where T and U are types.", getName()); checkAllowedType(ret); return ret; } } ColumnPtr executeImpl( const ColumnsWithTypeAndName & arguments, const DataTypePtr & result_type, size_t input_rows_count) const override { std::call_once(once, [&] { initialize(arguments, result_type); }); const auto * in = arguments[0].column.get(); if (isColumnConst(*in)) return executeConst(arguments, result_type, input_rows_count); ColumnPtr default_non_const; if (!cache.default_column && arguments.size() == 4) { default_non_const = castColumn(arguments[3], result_type); if (in->size() > default_non_const->size()) { throw Exception( ErrorCodes::LOGICAL_ERROR, "Fourth argument of function {} must be a constant or a column at least as big as the second and third arguments", getName()); } } ColumnPtr in_casted = arguments[0].column; if (arguments.size() == 3) in_casted = castColumn(arguments[0], result_type); auto column_result = result_type->createColumn(); if (cache.is_empty) { return default_non_const ? default_non_const : castColumn(arguments[0], result_type); } else if (cache.table_num_to_idx) { if (!executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted) && !executeNum>(in, *column_result, default_non_const, *in_casted)) { throw Exception(ErrorCodes::ILLEGAL_COLUMN, "Illegal column {} of first argument of function {}", in->getName(), getName()); } } else if (cache.table_string_to_idx) { if (!executeString(in, *column_result, default_non_const, *in_casted)) executeContiguous(in, *column_result, default_non_const, *in_casted); } else if (cache.table_anything_to_idx) { executeAnything(in, *column_result, default_non_const, *in_casted); } else throw Exception(ErrorCodes::LOGICAL_ERROR, "State of the function `transform` is not initialized"); return column_result; } private: static ColumnPtr executeConst(const ColumnsWithTypeAndName & arguments, const DataTypePtr & result_type, size_t input_rows_count) { /// Materialize the input column and compute the function as usual. ColumnsWithTypeAndName args = arguments; args[0].column = args[0].column->cloneResized(input_rows_count)->convertToFullColumnIfConst(); auto impl = FunctionToOverloadResolverAdaptor(std::make_shared()).build(args); return impl->execute(args, result_type, input_rows_count); } void executeAnything(const IColumn * in, IColumn & column_result, const ColumnPtr default_non_const, const IColumn & in_casted) const { const size_t size = in->size(); const auto & table = *cache.table_anything_to_idx; column_result.reserve(size); for (size_t i = 0; i < size; ++i) { SipHash hash; in->updateHashWithValue(i, hash); const auto * it = table.find(hash.get128()); if (it) column_result.insertFrom(*cache.to_column, it->getMapped()); else if (cache.default_column) column_result.insertFrom(*cache.default_column, 0); else if (default_non_const) column_result.insertFrom(*default_non_const, i); else column_result.insertFrom(in_casted, i); } } void executeContiguous(const IColumn * in, IColumn & column_result, const ColumnPtr default_non_const, const IColumn & in_casted) const { const size_t size = in->size(); const auto & table = *cache.table_string_to_idx; column_result.reserve(size); for (size_t i = 0; i < size; ++i) { const auto * it = table.find(in->getDataAt(i)); if (it) column_result.insertFrom(*cache.to_column, it->getMapped()); else if (cache.default_column) column_result.insertFrom(*cache.default_column, 0); else if (default_non_const) column_result.insertFrom(*default_non_const, i); else column_result.insertFrom(in_casted, i); } } template bool executeNum(const IColumn * in_untyped, IColumn & column_result, const ColumnPtr default_non_const, const IColumn & in_casted) const { const auto * const in = checkAndGetColumn(in_untyped); if (!in) return false; const auto & pod = in->getData(); UInt32 in_scale = 0; if constexpr (std::is_same_v, T> || std::is_same_v, T>) in_scale = in->getScale(); if (!executeNumToString(pod, column_result, default_non_const) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale) && !executeNumToNum>(pod, column_result, default_non_const, in_scale)) { const size_t size = pod.size(); const auto & table = *cache.table_num_to_idx; column_result.reserve(size); for (size_t i = 0; i < size; ++i) { const auto * it = table.find(bit_cast(pod[i])); if (it) column_result.insertFrom(*cache.to_column, it->getMapped()); else if (cache.default_column) column_result.insertFrom(*cache.default_column, 0); else if (default_non_const) column_result.insertFrom(*default_non_const, i); else column_result.insertFrom(in_casted, i); } } return true; } template bool executeNumToString(const PaddedPODArray & pod, IColumn & column_result, const ColumnPtr default_non_const) const { auto * out = typeid_cast(&column_result); if (!out) return false; auto & out_offs = out->getOffsets(); const size_t size = pod.size(); out_offs.resize(size); auto & out_chars = out->getChars(); const auto * to_col = assert_cast(cache.to_column.get()); const auto & to_chars = to_col->getChars(); const auto & to_offs = to_col->getOffsets(); const auto & table = *cache.table_num_to_idx; if (cache.default_column) { const auto * def = assert_cast(cache.default_column.get()); const auto & def_chars = def->getChars(); const auto & def_offs = def->getOffsets(); const auto * def_data = def_chars.data(); auto def_size = def_offs[0]; executeNumToStringHelper(table, pod, out_chars, out_offs, to_chars, to_offs, def_data, def_size, size); } else { const auto * def = assert_cast(default_non_const.get()); const auto & def_chars = def->getChars(); const auto & def_offs = def->getOffsets(); executeNumToStringHelper(table, pod, out_chars, out_offs, to_chars, to_offs, def_chars, def_offs, size); } return true; } template void executeNumToStringHelper( const Table & table, const PaddedPODArray & pod, ColumnString::Chars & out_data, ColumnString::Offsets & out_offsets, const ColumnString::Chars & to_data, const ColumnString::Offsets & to_offsets, const DefData & def_data, const DefOffs & def_offsets, const size_t size) const { size_t out_cur_off = 0; for (size_t i = 0; i < size; ++i) { const char8_t * to = nullptr; size_t to_size = 0; const auto * it = table.find(bit_cast(pod[i])); if (it) { const auto idx = it->getMapped(); const auto start = to_offsets[idx - 1]; to = &to_data[start]; to_size = to_offsets[idx] - start; } else if constexpr (std::is_same_v) { const auto start = def_offsets[i - 1]; to = &def_data[start]; to_size = def_offsets[i] - start; } else { to = def_data; to_size = def_offsets; } out_data.resize(out_cur_off + to_size); memcpy(&out_data[out_cur_off], to, to_size); out_cur_off += to_size; out_offsets[i] = out_cur_off; } } template bool executeNumToNum( const PaddedPODArray & pod, IColumn & column_result, const ColumnPtr default_non_const, const UInt32 in_scale) const { auto * out = typeid_cast(&column_result); if (!out) return false; auto & out_pod = out->getData(); const size_t size = pod.size(); out_pod.resize(size); UInt32 out_scale = 0; if constexpr (std::is_same_v, T> || std::is_same_v, T>) out_scale = out->getScale(); const auto & to_pod = assert_cast(cache.to_column.get())->getData(); const auto & table = *cache.table_num_to_idx; if (cache.default_column) { const auto const_def = assert_cast(cache.default_column.get())->getData()[0]; executeNumToNumHelper(table, pod, out_pod, to_pod, const_def, size, out_scale, out_scale); } else if (default_non_const) { const auto & nconst_def = assert_cast(default_non_const.get())->getData(); executeNumToNumHelper(table, pod, out_pod, to_pod, nconst_def, size, out_scale, out_scale); } else executeNumToNumHelper(table, pod, out_pod, to_pod, pod, size, out_scale, in_scale); return true; } template void executeNumToNumHelper( const Table & table, const PaddedPODArray & pod, PaddedPODArray & out_pod, const PaddedPODArray & to_pod, const Def & def, const size_t size, const UInt32 out_scale, const UInt32 def_scale) const { for (size_t i = 0; i < size; ++i) { const auto * it = table.find(bit_cast(pod[i])); if (it) { const auto idx = it->getMapped(); out_pod[i] = to_pod[idx]; } else if constexpr (std::is_same_v) out_pod[i] = def; else if constexpr (is_decimal && !is_decimal) out_pod[i] = DecimalUtils::decimalFromComponents(static_cast(def[i]), 0, out_scale); else if constexpr (is_decimal) { if (def_scale == out_scale) out_pod[i] = static_cast(def[i]); else { const auto whole = static_cast(DecimalUtils::getWholePart(def[i], def_scale)); const auto fract = static_cast(DecimalUtils::getFractionalPart(def[i], def_scale)); out_pod[i] = DecimalUtils::decimalFromComponents(whole, fract, out_scale); } } else out_pod[i] = static_cast(def[i]); // NOLINT(bugprone-signed-char-misuse,cert-str34-c) } } bool executeString(const IColumn * in_untyped, IColumn & column_result, const ColumnPtr default_non_const, const IColumn & in_casted) const { const auto * const in = checkAndGetColumn(in_untyped); if (!in) return false; const auto & data = in->getChars(); const auto & offsets = in->getOffsets(); if (!executeStringToString(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const) && !executeStringToNum>(data, offsets, column_result, default_non_const)) { const size_t size = offsets.size(); const auto & table = *cache.table_string_to_idx; ColumnString::Offset current_offset = 0; for (size_t i = 0; i < size; ++i) { const StringRef ref{&data[current_offset], offsets[i] - current_offset - 1}; current_offset = offsets[i]; const auto * it = table.find(ref); if (it) column_result.insertFrom(*cache.to_column, it->getMapped()); else if (cache.default_column) column_result.insertFrom(*cache.default_column, 0); else if (default_non_const) column_result.insertFrom(*default_non_const, i); else column_result.insertFrom(in_casted, i); } } return true; } bool executeStringToString( const ColumnString::Chars & data, const ColumnString::Offsets & offsets, IColumn & column_result, const ColumnPtr default_non_const) const { auto * out = typeid_cast(&column_result); if (!out) return false; auto & out_offs = out->getOffsets(); const size_t size = offsets.size(); out_offs.resize(size); auto & out_chars = out->getChars(); const auto * to_col = assert_cast(cache.to_column.get()); const auto & to_chars = to_col->getChars(); const auto & to_offs = to_col->getOffsets(); const auto & table = *cache.table_string_to_idx; if (cache.default_column) { const auto * def = assert_cast(cache.default_column.get()); const auto & def_chars = def->getChars(); const auto & def_offs = def->getOffsets(); const auto * def_data = def_chars.data(); auto def_size = def_offs[0]; executeStringToStringHelper(table, data, offsets, out_chars, out_offs, to_chars, to_offs, def_data, def_size, size); } else if (default_non_const) { const auto * def = assert_cast(default_non_const.get()); const auto & def_chars = def->getChars(); const auto & def_offs = def->getOffsets(); executeStringToStringHelper(table, data, offsets, out_chars, out_offs, to_chars, to_offs, def_chars, def_offs, size); } else { executeStringToStringHelper(table, data, offsets, out_chars, out_offs, to_chars, to_offs, data, offsets, size); } return true; } template void executeStringToStringHelper( const Table & table, const ColumnString::Chars & data, const ColumnString::Offsets & offsets, ColumnString::Chars & out_data, ColumnString::Offsets & out_offsets, const ColumnString::Chars & to_data, const ColumnString::Offsets & to_offsets, const DefData & def_data, const DefOffs & def_offsets, const size_t size) const { ColumnString::Offset current_offset = 0; size_t out_cur_off = 0; for (size_t i = 0; i < size; ++i) { const char8_t * to = nullptr; size_t to_size = 0; const StringRef ref{&data[current_offset], offsets[i] - current_offset - 1}; current_offset = offsets[i]; const auto * it = table.find(ref); if (it) { const auto idx = it->getMapped(); const auto start = to_offsets[idx - 1]; to = &to_data[start]; to_size = to_offsets[idx] - start; } else if constexpr (std::is_same_v) { const auto start = def_offsets[i - 1]; to = &def_data[start]; to_size = def_offsets[i] - start; } else { to = def_data; to_size = def_offsets; } out_data.resize(out_cur_off + to_size); memcpy(&out_data[out_cur_off], to, to_size); out_cur_off += to_size; out_offsets[i] = out_cur_off; } } template bool executeStringToNum( const ColumnString::Chars & data, const ColumnString::Offsets & offsets, IColumn & column_result, const ColumnPtr default_non_const) const { auto * out = typeid_cast(&column_result); if (!out) return false; auto & out_pod = out->getData(); const size_t size = offsets.size(); out_pod.resize(size); const auto & to_pod = assert_cast(cache.to_column.get())->getData(); const auto & table = *cache.table_string_to_idx; if (cache.default_column) { const auto const_def = assert_cast(cache.default_column.get())->getData()[0]; executeStringToNumHelper(table, data, offsets, out_pod, to_pod, const_def, size); } else { const auto & nconst_def = assert_cast(default_non_const.get())->getData(); executeStringToNumHelper(table, data, offsets, out_pod, to_pod, nconst_def, size); } return true; } template void executeStringToNumHelper( const Table & table, const ColumnString::Chars & data, const ColumnString::Offsets & offsets, PaddedPODArray & out_pod, const PaddedPODArray & to_pod, const Def & def, const size_t size) const { ColumnString::Offset current_offset = 0; for (size_t i = 0; i < size; ++i) { const StringRef ref{&data[current_offset], offsets[i] - current_offset - 1}; current_offset = offsets[i]; const auto * it = table.find(ref); if (it) { const auto idx = it->getMapped(); out_pod[i] = to_pod[idx]; } else if constexpr (std::is_same_v) out_pod[i] = def; else if constexpr (is_decimal) out_pod[i] = static_cast(def[i]); else out_pod[i] = static_cast(def[i]); // NOLINT(bugprone-signed-char-misuse,cert-str34-c) } } /// Different versions of the hash tables to implement the mapping. struct Cache { using NumToIdx = HashMap>; using StringToIdx = HashMap; using AnythingToIdx = HashMap; std::unique_ptr table_num_to_idx; std::unique_ptr table_string_to_idx; std::unique_ptr table_anything_to_idx; ColumnPtr from_column; ColumnPtr to_column; ColumnPtr default_column; bool is_empty = false; }; mutable std::once_flag once; mutable Cache cache; static void checkAllowedType(const DataTypePtr & type) { if (type->isNullable()) checkAllowedTypeHelper(static_cast(type.get())->getNestedType()); else checkAllowedTypeHelper(type); } static void checkAllowedTypeHelper(const DataTypePtr & type) { if (isStringOrFixedString(type)) return; if (type->haveMaximumSizeOfValue()) { auto data_type_size = type->getMaximumSizeOfValueInMemory(); if (data_type_size <= sizeof(UInt64)) return; } throw Exception(ErrorCodes::BAD_ARGUMENTS, "Unexpected type {} in function 'transform'", type->getName()); } /// Can be called from different threads. It works only on the first call. void initialize(const ColumnsWithTypeAndName & arguments, const DataTypePtr & result_type) const { const DataTypePtr & from_type = arguments[0].type; if (from_type->onlyNull()) { cache.is_empty = true; return; } const ColumnArray * array_from = checkAndGetColumnConstData(arguments[1].column.get()); const ColumnArray * array_to = checkAndGetColumnConstData(arguments[2].column.get()); if (!array_from || !array_to) throw Exception( ErrorCodes::ILLEGAL_COLUMN, "Second and third arguments of function {} must be constant arrays.", getName()); const ColumnPtr & from_column_uncasted = array_from->getDataPtr(); cache.from_column = castColumn( { from_column_uncasted, typeid_cast(*arguments[1].type).getNestedType(), arguments[1].name }, from_type); cache.to_column = castColumn( { array_to->getDataPtr(), typeid_cast(*arguments[2].type).getNestedType(), arguments[2].name }, result_type); const size_t size = cache.from_column->size(); if (0 == size) { cache.is_empty = true; return; } if (cache.to_column->size() != size) throw Exception( ErrorCodes::BAD_ARGUMENTS, "Second and third arguments of function {} must be arrays of same size", getName()); /// Whether the default value is set. if (arguments.size() == 4) { const IColumn * default_col = arguments[3].column.get(); if (default_col && isColumnConst(*default_col)) { auto default_column = result_type->createColumn(); if (!default_col->onlyNull()) { Field f = convertFieldToType((*default_col)[0], *result_type); default_column->insert(f); } else default_column->insertDefault(); cache.default_column = std::move(default_column); } } WhichDataType which(from_type); /// Note: Doesn't check the duplicates in the `from` array. /// Field may be of Float type, but for the purpose of bitwise equality we can treat them as UInt64 if (isNativeNumber(which) || which.isDecimal32() || which.isDecimal64() || which.isEnum()) { cache.table_num_to_idx = std::make_unique(); auto & table = *cache.table_num_to_idx; for (size_t i = 0; i < size; ++i) { if (which.isEnum() /// The correctness of strings are already checked by casting them to the Enum type. || applyVisitor(FieldVisitorAccurateEquals(), (*cache.from_column)[i], (*from_column_uncasted)[i])) { UInt64 key = 0; auto * dst = reinterpret_cast(&key); const auto ref = cache.from_column->getDataAt(i); #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wunreachable-code" if constexpr (std::endian::native == std::endian::big) dst += sizeof(key) - ref.size; #pragma clang diagnostic pop memcpy(dst, ref.data, ref.size); table[key] = i; } } } else if (from_type->isValueUnambiguouslyRepresentedInContiguousMemoryRegion()) { cache.table_string_to_idx = std::make_unique(); auto & table = *cache.table_string_to_idx; for (size_t i = 0; i < size; ++i) { if (applyVisitor(FieldVisitorAccurateEquals(), (*cache.from_column)[i], (*from_column_uncasted)[i])) { StringRef ref = cache.from_column->getDataAt(i); table[ref] = i; } } } else { cache.table_anything_to_idx = std::make_unique(); auto & table = *cache.table_anything_to_idx; for (size_t i = 0; i < size; ++i) { if (applyVisitor(FieldVisitorAccurateEquals(), (*cache.from_column)[i], (*from_column_uncasted)[i])) { SipHash hash; cache.from_column->updateHashWithValue(i, hash); table[hash.get128()] = i; } } } } }; } REGISTER_FUNCTION(Transform) { factory.registerFunction(); } }