CREATE AGGREGATE(7)

NAME
CREATE AGGREGATE - 定義一個新的聚集函數

SYNOPSIS

CREATE AGGREGATE name (
    BASETYPE = input_data_type,
    SFUNC = sfunc,
    STYPE = state_data_type
    [ , FINALFUNC = ffunc ]
    [ , INITCOND = initial_condition ]
)

DESCRIPTION 描述

CREATE AGGREGATE 定義一個新的聚集函數。 一些用於基本類型的聚集函數如 min(integer) 和 avg(double precision) 等已經包含在基礎軟件包裏了。 如果你需要定義一個新類型或需要一個還沒有提供的聚集函數，這時便可用 CREATE AGGREGATE 來提供我們所需要的特性。

如果給出了一個模式的名字（比如，CREATE AGGREGATE myschema.myagg ...），那麼該聚集函數是在指定模式中創建的。 否則它是在當前模式中創建的。

一個聚集函數是用它的名字和輸入數據類型來標識的。 同一模式中如果兩個聚集處理的輸入數據不同，它們可以有相同的名字。 一個聚集函數的輸入數據類型必須和所有同一模式中的普通函數的名字和輸入類型不同。

一個聚集函數是用一個或兩個普通函數做成的： 一個狀態轉換函數 sfunc, 和一個可選的終計算函數 ffunc. 它們是這樣使用的：

sfunc( internal-state, next-data-item ) ---> next-internal-state
ffunc( internal-state ) ---> aggregate-value

PostgreSQL 創建一個類型爲 stype的臨時變量。 它保存這個聚集的當前內部狀態。 對於每個輸入數據條目， 都調用狀態轉換函數計算內部狀態值的新數值。 在處理完所有數據後，調用一次最終處理函數以計算聚集的返回值。 如果沒有最終處理函數，那麼將最後的狀態值當做返回值。

一個聚集函數還可能提供一個初始條件，也就是說，所用的該內部狀態值的初始值。 這個值是作爲一個類型爲 text 的字段存儲在數據庫裏的， 不過它們必須是狀態值數據類型的合法的外部表現形式的常量。 如果沒有提供狀態，那麼狀態值初始化爲 NULL。

如果該狀態轉換函數被定義爲 "strict"， 那麼就不能用 NULL 輸入調用它。這個時候，帶有這樣的轉換函數的聚集執行起來的現象如下所述。 NULL 輸入的值被忽略（不調用此函數並且保留前一個狀態值）。如果初始狀態值是 NULL，那麼由第一個非 NULL 值替換該狀態值， 而狀態轉換函數從第二個非 NULL 的輸入值開始調用。這樣做讓我們比較容易實現象 max 這樣的聚集。 請注意這種行爲只是當 state_type 與 input_data_type 相同的時候才表現出來。 如果這些類型不同，你必須提供一個非 NULL 的初始條件或者使用一個非strice的狀態轉換函數。

如果狀態轉換函數不是 strict（嚴格）的， 那麼它將無條件地爲每個輸入值調用， 並且必須自行處理 NULL 輸入和 NULL 轉換值， 這樣就允許聚集的作者對聚集中的空值有完全的控制。

如果終轉換函數定義爲"strict"，則如果最終狀態值是 NULL 時就不會調用它； 而是自動輸出一個NULL的結果。（當然，這纔是 strict 函數的正常特徵。） 不管是那種情況，終處理函數可以選擇返回 NULL。比如， avg 的終處理函數在零輸入記錄時就會返回 NULL。

PARAMETERS 參數

name
    要創建的聚集函數名（可以有模式修飾的）。

input_data_type
    本聚集函數要處理的基本數據類型。 對於不檢查輸入類型的聚集來說，這個參數可以聲明爲"ANY"。 （比如 count(*)）。

sfunc
    用於處理源數據列裏的每一個輸入數據的狀態轉換函數名稱。 它通常是一個雙參數的函數，第一個參數的類型是 state_data_type 而第二個參數的類型是 input_data_type. 另外，對於一個不檢查輸入數據的聚集，該函數只接受一個類型爲 state_data_type 的參數。 不管是哪種情況，此函數必須返回一個類型爲 state_data_type的值。 這個函數接受當前狀態值和當前輸入數據條目，而返回下個狀態值。

state_data_type
    聚集的狀態值的數據類型。

ffunc
    在轉換完所有輸入域/字段後調用的最終處理函數。它計算聚集的結果。 此函數必須接受一個類型爲 state_data_type 的參數。 聚集的輸出數據類型被定義爲此函數的返回類型。 如果沒有聲明 ffunc 則使用聚集結果的狀態值作爲聚集的結果，而輸出類型爲 state_data_type。

initial_condition
    狀態值的初始設置（值）。它必須是一個數據類型 state_data_type 可以接受的文本常量值。 如果沒有聲明，狀態值初始爲 NULL。

CREATE AGGREGATE 的參數可以以任何順序書寫，而不只是上面顯示的順序。

EXAMPLES 例子

參閱 ``User-defined Aggregates''

COMPATIBILITY 兼容性

CREATE AGGREGATE 是 PostgreSQL 語言的擴展。 在 SQL 標準裏沒有 CREATE AGGREGATE。

SEE ALSO 參見
ALTER AGGREGATE [alter_aggregate(7)], DROP AGGREGATE [drop_aggregate(l)]

譯者
Postgresql 中文網站 何偉平 <laser@pgsqldb.org>

跋
本頁面中文版由中文 man 手冊頁計劃提供。
中文 man 手冊頁計劃：https://github.com/man-pages-zh/manpages-zh