mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-22 09:40:49 +00:00
73 lines
3.0 KiB
C++
73 lines
3.0 KiB
C++
#pragma once
|
||
|
||
#include <memory>
|
||
|
||
#include <Poco/SharedPtr.h>
|
||
|
||
#include <DB/Core/Row.h>
|
||
#include <DB/DataTypes/IDataType.h>
|
||
|
||
|
||
namespace DB
|
||
{
|
||
|
||
/** Интерфейс для агрегатных функций.
|
||
* Агрегатные функции аккумулируют значения, которые в них передают, держа в себе некоторое состояние.
|
||
* Поэтому, в отличие от обычных функций, вам необходимо при каждой агрегации, создавать новый экземпляр класса.
|
||
*/
|
||
class IAggregateFunction
|
||
{
|
||
public:
|
||
/// Получить основное имя функции.
|
||
virtual String getName() const = 0;
|
||
|
||
/// Получить строку, по которой можно потом будет создать объект того же типа (с помощью AggregateFunctionFactory)
|
||
virtual String getTypeID() const = 0;
|
||
|
||
/// Создать новую агрегатную функцию того же типа.
|
||
virtual IAggregateFunction* cloneEmpty() const = 0;
|
||
|
||
/** Указать типы аргументов. Если функция неприменима для данных аргументов - кинуть исключение.
|
||
* Необходимо вызывать перед остальными вызовами.
|
||
*/
|
||
virtual void setArguments(const DataTypes & arguments) = 0;
|
||
|
||
/** Указать параметры - для параметрических агрегатных функций.
|
||
* Если параметры не предусмотрены или переданные параметры недопустимы - кинуть исключение.
|
||
* Если параметры есть - необходимо вызывать перед остальными вызовами, иначе - не вызывать.
|
||
*/
|
||
virtual void setParameters(const Row & params)
|
||
{
|
||
throw Exception("Aggregate function " + getName() + " doesn't allow parameters.", ErrorCodes::AGGREGATE_FUNCTION_DOESNT_ALLOW_PARAMETERS);
|
||
}
|
||
|
||
/// Получить тип результата.
|
||
virtual DataTypePtr getReturnType() const = 0;
|
||
|
||
/// Добавить значение.
|
||
virtual void add(const Row & row) = 0;
|
||
|
||
/// Объединить состояние с другой агрегатной функцией.
|
||
virtual void merge(const IAggregateFunction & rhs) = 0;
|
||
|
||
/// Сериализовать состояние (например, для передачи по сети).
|
||
virtual void serialize(WriteBuffer & buf) const = 0;
|
||
|
||
/// Десериализовать состояние и объединить своё состояние с ним.
|
||
virtual void deserializeMerge(ReadBuffer & buf) = 0;
|
||
|
||
/// Получить результат
|
||
virtual Field getResult() const = 0;
|
||
|
||
virtual ~IAggregateFunction() {};
|
||
};
|
||
|
||
|
||
using Poco::SharedPtr;
|
||
|
||
typedef SharedPtr<IAggregateFunction> AggregateFunctionPtr;
|
||
typedef IAggregateFunction* AggregateFunctionPlainPtr;
|
||
typedef AutoArray<AggregateFunctionPlainPtr> AggregateFunctionsPlainPtrs;
|
||
|
||
}
|