ClickHouse/dbms/include/DB/Functions/IFunction.h

47 lines
2.1 KiB
C
Raw Normal View History

2011-08-09 15:57:33 +00:00
#pragma once
2011-08-09 19:19:00 +00:00
#include <Poco/SharedPtr.h>
2011-08-09 15:57:33 +00:00
#include <DB/Core/Names.h>
#include <DB/Core/Block.h>
#include <DB/Core/ColumnNumbers.h>
#include <DB/DataTypes/IDataType.h>
namespace DB
{
/** Интерфейс для обычных функций.
* Обычные функции - это функции, которые не меняют количество строк в таблице,
* и результат работы которых для каждой строчки не зависит от других строк.
*
* Функция может принимать произвольное количество аргументов и возвращать произвольное количество значений.
* Типы и количество значений результата зависят от типов и количества аргументов.
*
* Функция диспетчеризуется для целого блока. Это позволяет производить всевозможные проверки редко,
* и делать основную работу в виде эффективного цикла.
*
* Функция применяется к одному или нескольким столбцам блока, и записывает свой результат,
* добавляя новые столбцы к блоку. Функция не модифицирует свои агрументы.
*/
class IFunction
{
public:
/// Получить основное имя функции.
2011-08-13 21:05:18 +00:00
virtual String getName() const = 0;
2011-08-09 15:57:33 +00:00
2011-09-24 20:32:41 +00:00
/// Получить тип результата по типам аргументов. Если функция неприменима для данных аргументов - кинуть исключение.
virtual DataTypePtr getReturnType(const DataTypes & arguments) const = 0;
2011-08-09 15:57:33 +00:00
/// Выполнить функцию над блоком.
2011-09-24 20:32:41 +00:00
virtual void execute(Block & block, const ColumnNumbers & arguments, size_t result) = 0;
2011-08-09 15:57:33 +00:00
};
2011-08-09 19:19:00 +00:00
using Poco::SharedPtr;
typedef SharedPtr<IFunction> FunctionPtr;
2011-08-09 15:57:33 +00:00
}