給定索引條目 p 和查詢值 q，此函數確定索引條目是否與查詢「一致」；也就是說，對於索引條目表示的任何行，謂詞 「indexed_column indexable_operator q」是否可能為真？對於葉子索引條目，這相當於測試可索引條件，而對於內部樹節點，這確定是否需要掃描樹節點表示的索引子樹。當結果為 true 時，也必須傳回 recheck 旗標。這表示謂詞是肯定為真還是僅可能為真。如果 recheck = false，則索引已準確地測試了謂詞條件，而如果 recheck = true，則該行僅是候選符合項。在這種情況下，系統將自動針對實際行值評估 indexable_operator，以查看它是否真的是符合項。此慣例允許GiST支援無損和有損索引結構。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_consistent(internal, data_type, smallint, oid, internal)
RETURNS bool
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_consistent);

Datum
my_consistent(PG_FUNCTION_ARGS)
{
    GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
    data_type  *query = PG_GETARG_DATA_TYPE_P(1);
    StrategyNumber strategy = (StrategyNumber) PG_GETARG_UINT16(2);
    /* Oid subtype = PG_GETARG_OID(3); */
    bool       *recheck = (bool *) PG_GETARG_POINTER(4);
    data_type  *key = DatumGetDataType(entry->key);
    bool        retval;

    /*
     * determine return value as a function of strategy, key and query.
     *
     * Use GIST_LEAF(entry) to know where you're called in the index tree,
     * which comes handy when supporting the = operator for example (you could
     * check for non empty union() in non-leaf nodes and equality in leaf
     * nodes).
     */

    *recheck = true;        /* or false if check is exact */

    PG_RETURN_BOOL(retval);
}

在這裡，key 是索引中的元素，而 query 是在索引中查找到的值。StrategyNumber 參數表示正在應用您的運算符類別的哪個運算符 - 它與 CREATE OPERATOR CLASS 命令中的運算符編號之一相符。

根據您在類別中包含的運算符，query 的資料類型可能會因運算符而異，因為它將是運算符右側的任何類型，這可能與出現在左側的索引資料類型不同。（上面的程式碼框架假設只有一種類型是可能的；如果不是，則獲取 query 引數值必須取決於運算符。）建議 consistent 函數的 SQL 宣告使用 opclass 的索引資料類型作為 query 引數，即使實際類型可能是其他類型，具體取決於運算符。

這個方法會整合樹狀結構中的資訊。給定一組條目，這個函數會產生一個新的索引條目，代表所有給定的條目。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_union(internal, internal)
RETURNS storage_type
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_union);

Datum
my_union(PG_FUNCTION_ARGS)
{
    GistEntryVector *entryvec = (GistEntryVector *) PG_GETARG_POINTER(0);
    GISTENTRY  *ent = entryvec->vector;
    data_type  *out,
               *tmp,
               *old;
    int         numranges,
                i = 0;

    numranges = entryvec->n;
    tmp = DatumGetDataType(ent[0].key);
    out = tmp;

    if (numranges == 1)
    {
        out = data_type_deep_copy(tmp);

        PG_RETURN_DATA_TYPE_P(out);
    }

    for (i = 1; i < numranges; i++)
    {
        old = out;
        tmp = DatumGetDataType(ent[i].key);
        out = my_union_implementation(out, tmp);
    }

    PG_RETURN_DATA_TYPE_P(out);
}

正如你所看到的，在這個骨架中，我們處理的是一種資料類型，其中 union(X, Y, Z) = union(union(X, Y), Z)。透過在這個函式中實作適當的 union 演算法，可以很容易地支援這種情況不成立的資料類型GiST支援方法。

union 函數的結果必須是索引儲存類型的值，無論它是什麼（它可能與索引欄位的類型相同或不同）。union 函數應該傳回一個指向新 palloc()配置記憶體的指標。你不能直接傳回輸入值，即使沒有類型更改。

如上所示，union 函數的第一個 internal 參數實際上是一個 GistEntryVector 指標。第二個參數是指向整數變數的指標，可以忽略。（過去需要 union 函數將其結果值的大小儲存到該變數中，但現在已不再需要。）

將資料項目轉換為適合在索引頁面中進行物理儲存的格式。 如果省略 compress 方法，則資料項目將未經修改地儲存在索引中。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_compress(internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_compress);

Datum
my_compress(PG_FUNCTION_ARGS)
{
    GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
    GISTENTRY  *retval;

    if (entry->leafkey)
    {
        /* replace entry->key with a compressed version */
        compressed_data_type *compressed_data = palloc(sizeof(compressed_data_type));

        /* fill *compressed_data from entry->key ... */

        retval = palloc(sizeof(GISTENTRY));
        gistentryinit(*retval, PointerGetDatum(compressed_data),
                      entry->rel, entry->page, entry->offset, FALSE);
    }
    else
    {
        /* typically we needn't do anything with non-leaf entries */
        retval = entry;
    }

    PG_RETURN_POINTER(retval);
}

您必須調整 compressed_data_type 以適應您要轉換成的特定類型，以便壓縮您的葉節點，這是當然的。

將資料項目的儲存表示形式轉換為可以被運算符類別中其他 GiST 方法操作的格式。 如果省略 decompress 方法，則假定其他 GiST 方法可以直接處理儲存的資料格式。（decompress 不一定是 compress 方法的逆運算；特別是，如果 compress 是有損的，則 decompress 就不可能完全重建原始資料。decompress 也不一定等同於 fetch，因為其他 GiST 方法可能不需要完全重建資料。）

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_decompress(internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_decompress);

Datum
my_decompress(PG_FUNCTION_ARGS)
{
    PG_RETURN_POINTER(PG_GETARG_POINTER(0));
}

上面的骨架適用於不需要解壓縮的情況。（但是，當然，完全省略該方法更容易，並且在這種情況下建議使用。）

傳回一個值，指示將新條目插入樹的特定分支的 “成本”。 項目將沿著樹中最小 penalty 的路徑插入。 penalty 傳回的值應為非負數。 如果傳回負值，則將其視為零。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_penalty(internal, internal, internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;  -- in some cases penalty functions need not be strict

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_penalty);

Datum
my_penalty(PG_FUNCTION_ARGS)
{
    GISTENTRY  *origentry = (GISTENTRY *) PG_GETARG_POINTER(0);
    GISTENTRY  *newentry = (GISTENTRY *) PG_GETARG_POINTER(1);
    float      *penalty = (float *) PG_GETARG_POINTER(2);
    data_type  *orig = DatumGetDataType(origentry->key);
    data_type  *new = DatumGetDataType(newentry->key);

    *penalty = my_penalty_implementation(orig, new);
    PG_RETURN_POINTER(penalty);
}

由於歷史原因，penalty 函數不僅僅傳回 float 結果；而是必須將該值儲存在第三個參數指示的位置。 就其本身而言，傳回值將被忽略，儘管通常會傳回該參數的地址。

penalty 函數對於索引的良好性能至關重要。 在插入時，它將用於確定在選擇將新條目添加到樹中的哪個分支時要遵循哪個分支。 在查詢時，索引越平衡，查找就越快。

當需要分割索引頁面時，此函數決定頁面上的哪些條目保留在舊頁面上，以及哪些條目要移動到新頁面上。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_picksplit(internal, internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_picksplit);

Datum
my_picksplit(PG_FUNCTION_ARGS)
{
    GistEntryVector *entryvec = (GistEntryVector *) PG_GETARG_POINTER(0);
    GIST_SPLITVEC *v = (GIST_SPLITVEC *) PG_GETARG_POINTER(1);
    OffsetNumber maxoff = entryvec->n - 1;
    GISTENTRY  *ent = entryvec->vector;
    int         i,
                nbytes;
    OffsetNumber *left,
               *right;
    data_type  *tmp_union;
    data_type  *unionL;
    data_type  *unionR;
    GISTENTRY **raw_entryvec;

    maxoff = entryvec->n - 1;
    nbytes = (maxoff + 1) * sizeof(OffsetNumber);

    v->spl_left = (OffsetNumber *) palloc(nbytes);
    left = v->spl_left;
    v->spl_nleft = 0;

    v->spl_right = (OffsetNumber *) palloc(nbytes);
    right = v->spl_right;
    v->spl_nright = 0;

    unionL = NULL;
    unionR = NULL;

    /* Initialize the raw entry vector. */
    raw_entryvec = (GISTENTRY **) malloc(entryvec->n * sizeof(void *));
    for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i))
        raw_entryvec[i] = &(entryvec->vector[i]);

    for (i = FirstOffsetNumber; i <= maxoff; i = OffsetNumberNext(i))
    {
        int         real_index = raw_entryvec[i] - entryvec->vector;

        tmp_union = DatumGetDataType(entryvec->vector[real_index].key);
        Assert(tmp_union != NULL);

        /*
         * Choose where to put the index entries and update unionL and unionR
         * accordingly. Append the entries to either v->spl_left or
         * v->spl_right, and care about the counters.
         */

        if (my_choice_is_left(unionL, curl, unionR, curr))
        {
            if (unionL == NULL)
                unionL = tmp_union;
            else
                unionL = my_union_implementation(unionL, tmp_union);

            *left = real_index;
            ++left;
            ++(v->spl_nleft);
        }
        else
        {
            /*
             * Same on the right
             */
        }
    }

    v->spl_ldatum = DataTypeGetDatum(unionL);
    v->spl_rdatum = DataTypeGetDatum(unionR);
    PG_RETURN_POINTER(v);
}

請注意，picksplit 函數的結果是透過修改傳入的 v 結構來傳遞的。 就其本身而言，傳回值將被忽略，儘管通常會傳回 v 的地址。

與 penalty 類似，picksplit 函數對於索引的良好性能至關重要。 設計合適的 penalty 和 picksplit 實現是實現良好性能GiST索引的挑戰所在。

如果兩個索引條目相同，則傳回 true，否則傳回 false。（“索引條目”是索引儲存類型的值，不一定是原始索引欄位的類型。）

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_same(storage_type, storage_type, internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_same);

Datum
my_same(PG_FUNCTION_ARGS)
{
    prefix_range *v1 = PG_GETARG_PREFIX_RANGE_P(0);
    prefix_range *v2 = PG_GETARG_PREFIX_RANGE_P(1);
    bool       *result = (bool *) PG_GETARG_POINTER(2);

    *result = my_eq(v1, v2);
    PG_RETURN_POINTER(result);
}

由於歷史原因，same 函數不僅僅傳回布林值結果；而是必須將該標誌儲存在第三個參數指示的位置。 就其本身而言，傳回值將被忽略，儘管通常會傳回該參數的地址。

給定一個索引條目 p 和一個查詢值 q，此函數確定索引條目與查詢值的 “距離”。 如果運算符類別包含任何排序運算符，則必須提供此函數。 使用排序運算符的查詢將透過首先傳回具有最小 “距離” 值的索引條目來實現，因此結果必須與運算符的語意一致。 對於葉索引條目，結果僅表示到索引條目的距離；對於內部樹節點，結果必須是任何子條目可能具有的最小距離。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_distance(internal, data_type, smallint, oid, internal)
RETURNS float8
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

C 模組中對應的程式碼可以遵循以下框架

PG_FUNCTION_INFO_V1(my_distance);

Datum
my_distance(PG_FUNCTION_ARGS)
{
    GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
    data_type  *query = PG_GETARG_DATA_TYPE_P(1);
    StrategyNumber strategy = (StrategyNumber) PG_GETARG_UINT16(2);
    /* Oid subtype = PG_GETARG_OID(3); */
    /* bool *recheck = (bool *) PG_GETARG_POINTER(4); */
    data_type  *key = DatumGetDataType(entry->key);
    double      retval;

    /*
     * determine return value as a function of strategy, key and query.
     */

    PG_RETURN_FLOAT8(retval);
}

distance 函數的參數與 consistent 函數的參數相同。

在確定距離時允許進行一些近似，只要結果永遠不大於條目的實際距離即可。 因此，例如，在幾何應用中，到邊界框的距離通常就足夠了。 對於內部樹節點，傳回的距離不得大於到任何子節點的距離。 如果傳回的距離不準確，則該函數必須將 *recheck 設定為 true。（對於內部樹節點，這不是必需的；對於它們，始終假定計算是不精確的。）在這種情況下，執行器將在從堆中提取元組後計算準確的距離，並在必要時重新排序元組。

如果距離函數為任何葉節點傳回 *recheck = true，則原始排序運算符的傳回類型必須為 float8 或 float4，並且距離函數的結果值必須與原始排序運算符的結果值進行比較，因為執行器將使用距離函數結果和重新計算的排序運算符結果進行排序。 否則，距離函數的結果值可以是任何有限的 float8 值，只要結果值的相對順序與排序運算符傳回的順序相符即可。（無窮大和負無窮大在內部用於處理空值等情況，因此不建議 distance 函數傳回這些值。）

將資料項目的壓縮索引表示形式轉換為原始資料類型，用於僅索引掃描。傳回的資料必須是原始索引值的精確、無損副本。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_fetch(internal)
RETURNS internal
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

參數是指向 GISTENTRY 結構的指標。在進入時，其 key 欄位包含以壓縮形式表示的非 NULL 葉節點資料。傳回值是另一個 GISTENTRY 結構，其 key 欄位包含相同資料的原始、未壓縮形式。如果運算子類別的壓縮函數對葉節點條目沒有執行任何操作，則 fetch 方法可以原樣傳回引數。或者，如果運算子類別沒有壓縮函數，則也可以省略 fetch 方法，因為它必然是一個空操作。

C 模組中匹配的程式碼可以遵循以下骨架：

PG_FUNCTION_INFO_V1(my_fetch);

Datum
my_fetch(PG_FUNCTION_ARGS)
{
    GISTENTRY  *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
    input_data_type *in = DatumGetPointer(entry->key);
    fetched_data_type *fetched_data;
    GISTENTRY  *retval;

    retval = palloc(sizeof(GISTENTRY));
    fetched_data = palloc(sizeof(fetched_data_type));

    /*
     * Convert 'fetched_data' into the a Datum of the original datatype.
     */

    /* fill *retval from fetched_data. */
    gistentryinit(*retval, PointerGetDatum(converted_datum),
                  entry->rel, entry->page, entry->offset, FALSE);

    PG_RETURN_POINTER(retval);
}

如果壓縮方法對葉節點條目是有損的，則運算子類別無法支援僅索引掃描，並且不得定義 fetch 函數。

允許定義使用者可見的參數，以控制運算子類別的行為。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_options(internal)
RETURNS void
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

該函數會被傳遞一個指向 local_relopts 結構的指標，該結構需要填寫一組特定於運算子類別的選項。可以使用 PG_HAS_OPCLASS_OPTIONS() 和 PG_GET_OPCLASS_OPTIONS() 巨集從其他支援函數存取這些選項。

下面給出了 my_options() 的示例實作以及其他支援函數使用的參數。

typedef enum MyEnumType
{
    MY_ENUM_ON,
    MY_ENUM_OFF,
    MY_ENUM_AUTO
} MyEnumType;

typedef struct
{
    int32   vl_len_;    /* varlena header (do not touch directly!) */
    int     int_param;  /* integer parameter */
    double  real_param; /* real parameter */
    MyEnumType enum_param; /* enum parameter */
    int     str_param;  /* string parameter */
} MyOptionsStruct;

/* String representation of enum values */
static relopt_enum_elt_def myEnumValues[] =
{
    {"on", MY_ENUM_ON},
    {"off", MY_ENUM_OFF},
    {"auto", MY_ENUM_AUTO},
    {(const char *) NULL}   /* list terminator */
};

static char *str_param_default = "default";

/*
 * Sample validator: checks that string is not longer than 8 bytes.
 */
static void
validate_my_string_relopt(const char *value)
{
    if (strlen(value) > 8)
        ereport(ERROR,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("str_param must be at most 8 bytes")));
}

/*
 * Sample filler: switches characters to lower case.
 */
static Size
fill_my_string_relopt(const char *value, void *ptr)
{
    char   *tmp = str_tolower(value, strlen(value), DEFAULT_COLLATION_OID);
    int     len = strlen(tmp);

    if (ptr)
        strcpy((char *) ptr, tmp);

    pfree(tmp);
    return len + 1;
}

PG_FUNCTION_INFO_V1(my_options);

Datum
my_options(PG_FUNCTION_ARGS)
{
    local_relopts *relopts = (local_relopts *) PG_GETARG_POINTER(0);

    init_local_reloptions(relopts, sizeof(MyOptionsStruct));
    add_local_int_reloption(relopts, "int_param", "integer parameter",
                            100, 0, 1000000,
                            offsetof(MyOptionsStruct, int_param));
    add_local_real_reloption(relopts, "real_param", "real parameter",
                             1.0, 0.0, 1000000.0,
                             offsetof(MyOptionsStruct, real_param));
    add_local_enum_reloption(relopts, "enum_param", "enum parameter",
                             myEnumValues, MY_ENUM_ON,
                             "Valid values are: \"on\", \"off\" and \"auto\".",
                             offsetof(MyOptionsStruct, enum_param));
    add_local_string_reloption(relopts, "str_param", "string parameter",
                               str_param_default,
                               &validate_my_string_relopt,
                               &fill_my_string_relopt,
                               offsetof(MyOptionsStruct, str_param));

    PG_RETURN_VOID();
}

PG_FUNCTION_INFO_V1(my_compress);

Datum
my_compress(PG_FUNCTION_ARGS)
{
    int     int_param = 100;
    double  real_param = 1.0;
    MyEnumType enum_param = MY_ENUM_ON;
    char   *str_param = str_param_default;

    /*
     * Normally, when opclass contains 'options' method, then options are always
     * passed to support functions.  However, if you add 'options' method to
     * existing opclass, previously defined indexes have no options, so the
     * check is required.
     */
    if (PG_HAS_OPCLASS_OPTIONS())
    {
        MyOptionsStruct *options = (MyOptionsStruct *) PG_GET_OPCLASS_OPTIONS();

        int_param = options->int_param;
        real_param = options->real_param;
        enum_param = options->enum_param;
        str_param = GET_STRING_RELOPTION(options, str_param);
    }

    /* the rest implementation of support function */
}

由於索引中 key 的表示形式GiST具有彈性，因此可能取決於使用者指定的參數。例如，可以指定 key 簽章的長度。請參閱 gtsvector_options() 取得範例。

傳回一個比較器函數，以一種保留區域性的方式對資料進行排序。它被 CREATE INDEX 和 REINDEX 命令使用。所建立索引的品質取決於比較器函數確定的排序如何良好地保留輸入的區域性。

sortsupport 方法是可選的。如果未提供，則 CREATE INDEX 會使用 penalty 和 picksplit 函數將每個元組插入到樹中來建立索引，這會慢得多。

的SQL函數宣告必須如下所示

CREATE OR REPLACE FUNCTION my_sortsupport(internal)
RETURNS void
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;

參數是指向 SortSupport 結構的指標。至少，該函數必須填寫其 comparator 欄位。比較器採用三個參數：兩個要比較的 Datums，以及指向 SortSupport 結構的指標。Datums 是以儲存在索引中的格式表示的兩個索引值；也就是說，以 compress 方法傳回的格式表示。完整的 API 定義在 src/include/utils/sortsupport.h 中。

C 模組中匹配的程式碼可以遵循以下骨架：

PG_FUNCTION_INFO_V1(my_sortsupport);

static int
my_fastcmp(Datum x, Datum y, SortSupport ssup)
{
  /* establish order between x and y by computing some sorting value z */

  int z1 = ComputeSpatialCode(x);
  int z2 = ComputeSpatialCode(y);

  return z1 == z2 ? 0 : z1 > z2 ? 1 : -1;
}

Datum
my_sortsupport(PG_FUNCTION_ARGS)
{
  SortSupport ssup = (SortSupport) PG_GETARG_POINTER(0);

  ssup->comparator = my_fastcmp;
  PG_RETURN_VOID();
}

多種資料類型的 B 樹等效功能

多維立方體的索引

用於儲存（鍵、值）對的模組

int4 值的一維陣列的 RD-Tree

樹狀結構的索引

使用三字母組匹配的文字相似性

“浮點範圍”的索引