#pragma once #include #include #include #include #include #include #include namespace DB { namespace ErrorCodes { extern const int LOGICAL_ERROR; extern const int NUMBER_OF_ARGUMENTS_DOESNT_MATCH; } /// This class implements a wrapper around an aggregate function. Despite its name, /// this is an adapter. It is used to handle aggregate functions that are called with /// at least one nullable argument. It implements the logic according to which any /// row that contains at least one NULL is skipped. /// If all rows had NULL, the behaviour is determined by "result_is_nullable" template parameter. /// true - return NULL; false - return value from empty aggregation state of nested function. template class AggregateFunctionNullBase : public IAggregateFunctionHelper { protected: AggregateFunctionPtr nested_function; size_t prefix_size; /** In addition to data for nested aggregate function, we keep a flag * indicating - was there at least one non-NULL value accumulated. * In case of no not-NULL values, the function will return NULL. * * We use prefix_size bytes for flag to satisfy the alignment requirement of nested state. */ AggregateDataPtr nestedPlace(AggregateDataPtr place) const noexcept { return place + prefix_size; } ConstAggregateDataPtr nestedPlace(ConstAggregateDataPtr place) const noexcept { return place + prefix_size; } static void initFlag(AggregateDataPtr place) noexcept { if (result_is_nullable) place[0] = 0; } static void setFlag(AggregateDataPtr place) noexcept { if (result_is_nullable) place[0] = 1; } static bool getFlag(ConstAggregateDataPtr place) noexcept { return result_is_nullable ? place[0] : 1; } public: AggregateFunctionNullBase(AggregateFunctionPtr nested_function_, const DataTypes & arguments, const Array & params) : IAggregateFunctionHelper(arguments, params), nested_function{nested_function_} { if (result_is_nullable) prefix_size = nested_function->alignOfData(); else prefix_size = 0; } String getName() const override { /// This is just a wrapper. The function for Nullable arguments is named the same as the nested function itself. return nested_function->getName(); } DataTypePtr getReturnType() const override { return result_is_nullable ? makeNullable(nested_function->getReturnType()) : nested_function->getReturnType(); } void create(AggregateDataPtr place) const override { initFlag(place); nested_function->create(nestedPlace(place)); } void destroy(AggregateDataPtr place) const noexcept override { nested_function->destroy(nestedPlace(place)); } bool hasTrivialDestructor() const override { return nested_function->hasTrivialDestructor(); } size_t sizeOfData() const override { return prefix_size + nested_function->sizeOfData(); } size_t alignOfData() const override { return nested_function->alignOfData(); } void merge(AggregateDataPtr place, ConstAggregateDataPtr rhs, Arena * arena) const override { if (result_is_nullable && getFlag(rhs)) setFlag(place); nested_function->merge(nestedPlace(place), nestedPlace(rhs), arena); } void serialize(ConstAggregateDataPtr place, WriteBuffer & buf) const override { bool flag = getFlag(place); if (result_is_nullable) writeBinary(flag, buf); if (flag) nested_function->serialize(nestedPlace(place), buf); } void deserialize(AggregateDataPtr place, ReadBuffer & buf, Arena * arena) const override { bool flag = 1; if (result_is_nullable) readBinary(flag, buf); if (flag) { setFlag(place); nested_function->deserialize(nestedPlace(place), buf, arena); } } void insertResultInto(ConstAggregateDataPtr place, IColumn & to) const override { if (result_is_nullable) { ColumnNullable & to_concrete = assert_cast(to); if (getFlag(place)) { nested_function->insertResultInto(nestedPlace(place), to_concrete.getNestedColumn()); to_concrete.getNullMapData().push_back(0); } else { to_concrete.insertDefault(); } } else { nested_function->insertResultInto(nestedPlace(place), to); } } bool allocatesMemoryInArena() const override { return nested_function->allocatesMemoryInArena(); } bool isState() const override { return nested_function->isState(); } }; /** There are two cases: for single argument and variadic. * Code for single argument is much more efficient. */ template class AggregateFunctionNullUnary final : public AggregateFunctionNullBase> { public: AggregateFunctionNullUnary(AggregateFunctionPtr nested_function_, const DataTypes & arguments, const Array & params) : AggregateFunctionNullBase>(std::move(nested_function_), arguments, params) { } void add(AggregateDataPtr place, const IColumn ** columns, size_t row_num, Arena * arena) const override { const ColumnNullable * column = assert_cast(columns[0]); if (!column->isNullAt(row_num)) { this->setFlag(place); const IColumn * nested_column = &column->getNestedColumn(); this->nested_function->add(this->nestedPlace(place), &nested_column, row_num, arena); } } }; template class AggregateFunctionNullVariadic final : public AggregateFunctionNullBase> { public: AggregateFunctionNullVariadic(AggregateFunctionPtr nested_function_, const DataTypes & arguments, const Array & params) : AggregateFunctionNullBase>(std::move(nested_function_), arguments, params), number_of_arguments(arguments.size()) { if (number_of_arguments == 1) throw Exception("Logical error: single argument is passed to AggregateFunctionNullVariadic", ErrorCodes::LOGICAL_ERROR); if (number_of_arguments > MAX_ARGS) throw Exception("Maximum number of arguments for aggregate function with Nullable types is " + toString(size_t(MAX_ARGS)), ErrorCodes::NUMBER_OF_ARGUMENTS_DOESNT_MATCH); for (size_t i = 0; i < number_of_arguments; ++i) is_nullable[i] = arguments[i]->isNullable(); } void add(AggregateDataPtr place, const IColumn ** columns, size_t row_num, Arena * arena) const override { /// This container stores the columns we really pass to the nested function. const IColumn * nested_columns[number_of_arguments]; for (size_t i = 0; i < number_of_arguments; ++i) { if (is_nullable[i]) { const ColumnNullable & nullable_col = assert_cast(*columns[i]); if (null_is_skipped && nullable_col.isNullAt(row_num)) { /// If at least one column has a null value in the current row, /// we don't process this row. return; } nested_columns[i] = &nullable_col.getNestedColumn(); } else nested_columns[i] = columns[i]; } this->setFlag(place); this->nested_function->add(this->nestedPlace(place), nested_columns, row_num, arena); } bool allocatesMemoryInArena() const override { return this->nested_function->allocatesMemoryInArena(); } private: enum { MAX_ARGS = 8 }; size_t number_of_arguments = 0; std::array is_nullable; /// Plain array is better than std::vector due to one indirection less. }; }