给定索引项 p 和查询值 q，此函数确定索引项是否与查询““consistent””，即谓语““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 声明针对 query 参数使用 opclass 的索引数据类型，即使实际类型可能根据算子而有所不同。

此方法合并树中的信息。给定一组条目后，此函数会生成一个新索引条目来表示所有给定的条目。

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) 的。通过在此支持方法中实现适当的 union 算法，可以轻松支持并非如此的数据类型。GiSTsupport 方法。

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 实现是实现高性能GiST索引面临的挑战。

如果两个索引条目相同，则返回 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 值，只要结果值的相对顺序与排序运算符返回的顺序匹配即可。（无穷大（Infinity）和负无穷大（minus infinity）在内部用于处理空值等情况，因此不建议 distance 函数返回这些值。）

对于仅索引扫描，将数据的压缩索引表示转换为原始数据类型。所返回的数据必须是最初索引值的精确无损拷贝。

TheSQL该函数的声明看上去类似以下内容

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

参数是指向 GISTENTRY 结构的指针。在进入时，它的 key 字段以压缩形式包含一个非 NULL 叶子数据。返回值是另一个 GISTENTRY 结构，其 key 字段以其原始的未压缩形式包含相同的数据。如果 opclass 的压缩函数不对叶子项执行任何操作，则 fetch 方法可以按原样返回参数。或者，如果 opclass 没有压缩函数，也可以省略 fetch 方法，因为它必然是无操作（no-op）。

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 函数。

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

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 函数将每个元组插入树中来生成索引，而这要慢得多。

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

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();
}