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

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

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 引數，即使實際類型可能會因為運算子而有所不同。

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

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

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)。透過在此方法中實現適當的聯集演算法，可以很容易地支援不是這種情況的資料類型。GiSTsupport method (支援方法)。

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

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

將資料項目轉換為適合在索引頁面中進行實體儲存的格式。如果省略 compress 方法，則資料項目將在索引中儲存而不進行修改。

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

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 方法可能不需要完全重建資料。）

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

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 傳回的值應為非負數。如果傳回負值，則將其視為零。

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

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 函數對於索引的良好效能至關重要。它將在插入時使用，以確定在選擇將新條目新增到樹狀結構中的哪個分支。在查詢時，索引越平衡，查找速度就越快。

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

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

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 實作是實現高效能索引的挑戰所在。GiSTindexes (索引) lies (所在)。

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

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

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，此函數確定索引條目與查詢值的 “距離”。如果運算子類別包含任何排序運算子，則必須提供此函數。使用排序運算子的查詢將透過首先傳回具有最小 “距離”值的索引條目來實現，因此結果必須與運算子的語義一致。對於葉索引條目，結果僅代表到索引條目的距離；對於內部樹狀節點，結果必須是任何子條目可能具有的最小距離。

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

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 值，只要結果值的相對順序與排序運算子回傳的順序一致即可。（無限大和負無限大在內部用於處理 null 等情況，因此不建議 distance 函數回傳這些值。）

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

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

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

此引數是指向 GISTENTRY 結構的指標。在輸入時，其 key 欄位包含壓縮形式的非 NULL 葉節點資料。回傳值是另一個 GISTENTRY 結構，其 key 欄位包含其原始、未壓縮形式的相同資料。如果 opclass 的 compress 函數對葉節點條目沒有執行任何操作，則 fetch 方法可以按原樣回傳引數。或者，如果 opclass 沒有 compress 函數，也可以省略 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);
}

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

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

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

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 */
}

由於金鑰的表示形式在GiST具有彈性，它可能取決於使用者指定的參數。例如，可以指定金鑰簽章的長度。有關範例，請參閱 gtsvector_options()。

回傳一個比較器函數，以以一種保留局部性的方式對資料進行排序。它由 CREATE INDEX 和 REINDEX 命令使用。建立的索引的品質取決於比較器函數確定的排序順序在多大程度上保留了輸入的局部性。

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

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

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-tree 等效功能

用於多維立方體的索引

用於儲存 (key, value) 配對的模組

用於 int4 值的一維陣列的 RD-Tree

用於樹狀結構的索引

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

用於「float 範圍」的索引