给定一个索引条目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参数值将取决于操作符。）建议SQL声明consistent函数使用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)。很容易支持不符合此条件的数据类型，方法是在此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。（对于内部树节点，这没有必要；对于它们，计算始终假定是不精确的。）在这种情况下，执行器将在从堆中获取元组后计算准确的距离，并在必要时重新排序元组。

如果distance函数对于任何叶节点返回*recheck = true，则原始排序操作符的返回类型必须为float8或float4，并且distance函数的结果值必须与原始排序操作符的结果值可比较，因为执行器将同时使用distance函数结果和重新计算的排序操作符结果进行排序。否则，distance函数的结果值可以是任何有限的float8值，只要结果值的相对顺序与排序操作符返回的顺序匹配即可。（无穷大和负无穷大用于内部处理空值等情况，因此不建议distance函数返回这些值。）

将数据项的压缩索引表示形式转换为原始数据类型，用于仅索引扫描。返回的数据必须是原始索引值的精确、无损副本。

该SQL函数的声明必须如下所示

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

参数是指向GISTENTRY结构的指针。在输入时，其key字段包含以压缩形式表示的非空叶数据。返回值是另一个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函数。

允许定义控制操作符类行为的用户可见参数。

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

由于键在GiST中的表示是灵活的，因此它可能取决于用户指定的参数。例如，可以指定密钥签名的长度。有关示例，请参阅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结构的指针。至少，该函数必须填写其比较器字段。比较器采用三个参数：两个要比较的数据和一个指向SortSupport结构的指针。数据是以它们存储在索引中的格式表示的两个索引值；也就是说，以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 树

树状结构的索引

使用三元组匹配的文本相似性

用于““浮点范围” 的索引