CREATE AGGREGATE

Устаревший синтаксис:

CREATE AGGREGATE определяет новую агрегатную функцию. В Greengage DB уже предусмотрены некоторые базовые и часто используемые агрегатные функции, такие как count, min, max, sum, avg и другие. Если вы определяете новые типы или требуется агрегатная функция, которая еще не предусмотрена, вы можете использовать CREATE AGGREGATE для создания необходимых функций.

Если указано имя схемы (например, CREATE AGGREGATE myschema.myagg …​), то агрегатная функция создается в указанной схеме. В противном случае она создается в текущей схеме.

Агрегатная функция идентифицируется своим именем и типами входных данных. Две агрегатные функции в одной схеме могут иметь одинаковое имя, если они работают с разными входными типами. Имя и типы входных данных агрегатной функции также должны отличаться от имени и типов входных данных каждой обычной функции в той же схеме. Такое поведение идентично перегрузке имен обычных функций. См. CREATE FUNCTION.

Простая агрегатная функция состоит из одной, двух или трех обычных функций (которые должны быть помечены как IMMUTABLE):

Эти функции используются следующим образом:

Greengage DB создает временную переменную типа данных state_data_type для хранения текущего внутреннего состояния агрегатной функции. Для каждой входной строки вычисляются значения аргументов агрегата, и вызывается функция перехода состояния с текущим значением состояния и новыми значениями аргументов для вычисления нового значения внутреннего состояния. После обработки всех строк один раз вызывается финальная функция для вычисления возвращаемого значения агрегата. Если финальная функция отсутствует, то конечное значение состояния возвращается как есть.

Вы можете указать combinefunc как метод для оптимизации выполнения агрегатной функции. Указав combinefunc, агрегатную функцию можно запускать параллельно сначала на сегментах, а затем на мастере. При выполнении двухуровневого выполнения statefunc запускается на сегментах для генерации частичных результатов агрегации, а combinefunc запускается на мастере для агрегации частичных результатов с сегментов. Если выполняется одноуровневая агрегация, все строки отправляются на мастер, и к строкам применяется statefunc.

Одноуровневая агрегация и двухуровневая агрегация являются эквивалентными стратегиями выполнения. Любой тип агрегации может быть реализован в плане запроса. Когда вы реализуете функции combinefunc и statefunc, вы должны гарантировать, что вызов statefunc на экземплярах сегментов с последующим вызовом combinefunc на мастере дает тот же результат, что и одноуровневая агрегация, которая отправляет все строки на мастер, а затем применяет к строкам только statefunc.

Агрегатная функция может предоставлять необязательное начальное условие — начальное значение для внутреннего значения состояния. Оно указывается и хранится в базе данных как значение типа text, но должно быть допустимым внешним представлением константы типа данных значения состояния. Если оно не указано, значение состояния изначально равно NULL.

Если функция statefunc объявлена как STRICT, то она не может быть вызвана с входными значениями NULL. С такой функцией перехода выполнение агрегатной функции ведет себя следующим образом. Строки с любыми входными значениями NULL игнорируются (функция не вызывается, и сохраняется предыдущее значение состояния). Если начальное значение состояния равно NULL, то при первой строке со всеми значениями, отличными от NULL, первое значение аргумента заменяет значение состояния, и функция перехода вызывается для последующих строк со всеми значениями, отличными от NULL. Это полезно для реализации агрегатов, таких как max. Обратите внимание, что такое поведение доступно только тогда, когда state_data_type совпадает с первым arg_data_type. Когда эти типы различаются, вы должны предоставить начальное условие, отличное от NULL, или использовать нестрогую (nonstrict) функцию перехода.

Если функция statefunc не объявлена как STRICT, то она будет вызываться безусловно для каждой входной строки и должна самостоятельно обрабатывать входные значения NULL и значения состояния NULL. Это позволяет автору агрегатной функции иметь полный контроль над обработкой значений NULL в агрегате.

Если финальная функция (ffunc) объявлена как STRICT, то она не будет вызвана, когда конечное значение состояния равно NULL; вместо этого результат NULL будет возвращен автоматически. Это нормальное поведение функций STRICT. В любом случае финальная функция имеет возможность вернуть значение NULL. Например, финальная функция для avg возвращает NULL, когда видит, что было ноль входных строк.

Иногда полезно объявить финальную функцию, принимающую не только значение состояния, но и дополнительные параметры, соответствующие входным значениям агрегата. Основная причина для этого — если финальная функция полиморфна, и типа данных значения состояния недостаточно для определения типа результата. Эти дополнительные параметры всегда передаются как NULL (поэтому финальная функция не должна быть строгой при использовании опции FINALFUNC_EXTRA), но тем не менее они являются валидными параметрами. Финальная функция может, например, использовать get_fn_expr_argtype для идентификации фактического типа аргумента в текущем вызове.

Агрегатная функция может при необходимости поддерживать режим скользящего агрегата (moving-aggregate mode), как описано в разделе Moving-Aggregate Mode документации PostgreSQL. Для этого требуется указать функции msfunc, minvfunc и mstype, а также опционально функции mspace, mfinalfunc, mfinalfunc_extra и minitcond. За исключением minvfunc, эти функции работают как соответствующие функции простого агрегата без префикса m; они определяют отдельную реализацию агрегата, которая включает обратную функцию перехода.

Синтаксис с ORDER BY в списке параметров создает специальный тип агрегата, называемый агрегатом упорядоченного набора (ordered-set aggregate); или, если указано HYPOTHETICAL, создается агрегат гипотетического набора (hypothetical-set aggregate). Эти агрегаты работают с группами отсортированных значений зависимым от порядка способом, поэтому указание порядка сортировки входных данных является неотъемлемой частью вызова. Кроме того, они могут иметь прямые (direct) аргументы, которые оцениваются только один раз на агрегацию, а не один раз для каждой входной строки. Агрегаты гипотетического набора — это подкласс агрегатов упорядоченного набора, в котором некоторые прямые аргументы должны соответствовать по количеству и типам данных агрегируемым столбцам аргументов. Это позволяет добавлять значения этих прямых аргументов к коллекции строк ввода агрегата как дополнительную "гипотетическую" строку.

Агрегатные функции с одним аргументом, такие как min или max, иногда можно оптимизировать, обращаясь к индексу, вместо того чтобы сканировать каждую входную строку. Если данную агрегатную функцию можно так оптимизировать, укажите это, задав оператор сортировки (sort operator). Основное требование заключается в том, что агрегатная функция должна выдавать первый элемент в порядке сортировки, заданном оператором. Другими словами, выражение:

должно быть эквивалентно:

Дальнейшие предположения заключаются в том, что агрегатная функция игнорирует входные данные NULL и выдает результат NULL тогда и только тогда, когда не было входных данных, отличных от NULL. Обычно оператор < типа данных является правильным оператором сортировки для MIN, а > — правильным оператором сортировки для MAX. Обратите внимание, что оптимизация на самом деле не сработает, если указанный оператор не является членом стратегии "меньше чем" или "больше чем" класса операторов B-tree индекса.

Чтобы иметь возможность создать агрегатную функцию, вы должны иметь привилегию USAGE для типов аргументов, типаов состояния и типа возвращаемого значения, а также привилегию EXECUTE для функций перехода и финальных функций.

Обычные функции, используемые для определения новой агрегатной функции, должны быть определены первыми. Нет необходимости в том, чтобы функции statefunc, ffunc и combinefunc, используемые для создания агрегата, были определены как IMMUTABLE.

Если значение конфигурационного параметра сервера Greengage DB gp_enable_multiphase_agg равно off, выполняется только одноуровневая агрегация.

Любой скомпилированный код (файлы разделяемых библиотек) для пользовательских функций должен быть размещен в одном и том же месте на каждом хосте в кластере Greengage DB (мастер и все сегменты). Это местоположение также должно быть в LD_LIBRARY_PATH, чтобы сервер мог найти файлы.

Любую агрегатную функцию можно вызвать как упорядоченный агрегат, используя синтаксис:

Ключевое слово ORDERED принимается для обратной совместимости, но игнорируется.

В качестве синонима для COMBINEFUNC можно использовать ключевое слово PREFUNC, которое поддерживается для обратной совместимости.

Следующий пример создает агрегатную функцию, которая вычисляет сумму двух столбцов.

Перед созданием агрегатной функции создайте две функции, которые используются как функции statefunc и combinefunc агрегатной функции.

Следующая функция указывается как функция statefunc в агрегатной функции:

Следующая функция указывается как функция combinefunc в агрегатной функции:

Следующая команда CREATE AGGREGATE создает агрегатную функцию, которая суммирует два столбца:

Следующие команды создают таблицу, добавляют несколько строк и запускают агрегатную функцию:

Эта команда EXPLAIN показывает двухфазную агрегацию:

Результат:

CREATE AGGREGATE является расширением языка Greengage DB. Стандарт SQL не предусматривает пользовательских агрегатных функций.