Datum *extractValue(Datum itemValue, int32 *nkeys, bool **nullFlags)

Datum *extractQuery(Datum query, int32 *nkeys, StrategyNumber n, bool **pmatch, Pointer **extra_data, bool **nullFlags, int32 *searchMode)

返回一个 palloc'd 的键数组，给定一个要查询的值；也就是说，query 是可索引操作符右侧的值，该操作符的左侧是索引列。n 是操作符类中操作符的策略编号（请参阅第 36.16.2 节）。通常，extractQuery 需要参考 n 来确定 query 的数据类型以及它应该使用的方法来提取键值。返回的键的数量必须存储到 *nkeys 中。如果任何键可以为空，也请 palloc 一个 *nkeys bool 字段的数组，将其地址存储在 *nullFlags 中，并根据需要设置这些空标志。如果所有键都不为空，则可以将 *nullFlags 保持为 NULL（其初始值）。如果 query 不包含键，则返回值可以为 NULL。

searchMode 是一个输出参数，允许 extractQuery 指定有关如何进行搜索的详细信息。如果 *searchMode 设置为 GIN_SEARCH_MODE_DEFAULT（这是调用之前初始化的值），则仅考虑至少匹配返回的键之一的项目作为候选匹配项。如果 *searchMode 设置为 GIN_SEARCH_MODE_INCLUDE_EMPTY，则除了包含至少一个匹配键的项目外，还会考虑根本不包含键的项目作为候选匹配项。（此模式对于实现 is-subset-of 操作符很有用，例如。）如果 *searchMode 设置为 GIN_SEARCH_MODE_ALL，则索引中的所有非空项目都被视为候选匹配项，无论它们是否与返回的键匹配。（此模式比其他两种选择慢得多，因为它需要扫描基本上整个索引，但它可能需要正确实现边界情况。在大多数情况下都需要此模式的操作符可能不是 GIN 操作符类的理想选择。）用于设置此模式的符号在 access/gin.h 中定义。

pmatch 是一个输出参数，用于在支持部分匹配时使用。要使用它，extractQuery 必须分配一个 *nkeys bool 的数组，并将其地址存储在 *pmatch 中。如果对应的键需要部分匹配，则数组的每个元素都应设置为 true，如果不需要，则设置为 false。如果 *pmatch 设置为 NULL，则 GIN 假定不需要部分匹配。变量在调用之前初始化为 NULL，因此不支持部分匹配的操作符类可以简单地忽略此参数。

如果索引项满足策略编号为 n 的查询操作符（或者可能满足，如果返回了重新检查指示），则返回 true。此函数不能直接访问索引项的值，因为GIN不显式存储项。相反，可用的是有关从查询中提取的哪些键值出现在给定索引项中的知识。check 数组的长度为 nkeys，这与先前由 extractQuery 为此 query 数据返回的键数相同。check 数组的每个元素都是 true，如果索引项包含相应的查询键，即如果 (check[i] == true)，则 extractQuery 结果数组的第 i 个键存在于索引项中。传入原始的 query 数据，以防 consistent 方法需要查阅它，queryKeys[] 和 nullFlags[] 数组也同样传入，这些数组先前由 extractQuery 返回。extra_data 是 extractQuery 返回的额外数据数组，如果没有则为 NULL。

当 extractQuery 在 queryKeys[] 中返回空键时，如果索引项包含空键，则对应的 check[] 元素为 true；也就是说，check[] 的语义类似于 IS NOT DISTINCT FROM。consistent 函数可以检查相应的 nullFlags[] 元素，如果它需要区分常规值匹配和空匹配。

成功时，如果需要根据查询操作符重新检查堆元组，则应将 *recheck 设置为 true，如果索引测试是精确的，则设置为 false。也就是说，false 的返回值保证堆元组与查询不匹配；true 的返回值，并且 *recheck 设置为 false，则保证堆元组与查询匹配；true 的返回值，并且 *recheck 设置为 true，则表示堆元组可能与查询匹配，因此需要获取该堆元组，并通过直接针对原始索引项评估查询操作符来重新检查。

triConsistent 与 consistent 类似，但在 check 向量中，每个键有三个可能的值，而不是布尔值：GIN_TRUE、GIN_FALSE 和 GIN_MAYBE。GIN_FALSE 和 GIN_TRUE 的含义与常规布尔值相同，而 GIN_MAYBE 表示该键是否存在未知。当存在 GIN_MAYBE 值时，只有当无论索引项是否包含相应的查询键，该项都肯定匹配时，函数才应返回 GIN_TRUE。同样，只有当无论是否包含 GIN_MAYBE 键，该项都肯定不匹配时，函数才必须返回 GIN_FALSE。如果结果取决于 GIN_MAYBE 条目，即不能根据已知的查询键确认或否定匹配，则函数必须返回 GIN_MAYBE。

当 check 向量中没有 GIN_MAYBE 值时，GIN_MAYBE 返回值等同于在布尔型 consistent 函数中设置 recheck 标志。

比较两个键（不是索引项！），并返回一个小于零、零或大于零的整数，表示第一个键小于、等于或大于第二个键。空键永远不会传递给此函数。

将部分匹配的查询键与索引键进行比较。返回一个整数，其符号表示结果：小于零表示索引键与查询不匹配，但应继续索引扫描；零表示索引键与查询匹配；大于零表示应停止索引扫描，因为不再可能匹配。提供了生成部分匹配查询的操作符的策略编号 n，以防需要其语义来确定何时结束扫描。此外，extra_data 是 extractQuery 创建的额外数据数组的对应元素，如果没有，则为 NULL。空键永远不会传递给此函数。

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

向 options 函数传递一个指向 local_relopts 结构的指针，该结构需要填充一组特定于操作符类的选项。可以使用 PG_HAS_OPCLASS_OPTIONS() 和 PG_GET_OPCLASS_OPTIONS() 宏从其他支持函数访问这些选项。

由于索引值的键提取和键的表示都GIN是灵活的，它们可能取决于用户指定的参数。

插入到GIN索引中可能会很慢，因为每个项目可能插入许多键。因此，对于批量插入到表中的操作，建议在完成批量插入后删除 GIN 索引并重新创建它。

当为GIN启用 fastupdate 时（详细信息请参见 第 64.4.4.1 节），惩罚会比不启用时要小。但是，对于非常大的更新，最好还是删除并重新创建索引。

构建GIN索引的时间对 maintenance_work_mem 设置非常敏感；在创建索引期间不应吝啬工作内存。

在启用 fastupdate 的现有GIN索引中进行一系列插入操作期间，当列表增长超过 gin_pending_list_limit 时，系统将清理待处理条目列表。为了避免观察到的响应时间波动，最好在后台（即通过自动清理）进行待处理列表清理。可以通过增加 gin_pending_list_limit 或使自动清理更积极来避免前台清理操作。但是，扩大清理操作的阈值意味着如果发生前台清理，它将花费更长的时间。

可以通过更改存储参数来覆盖单个 GIN 索引的 gin_pending_list_limit，这允许每个 GIN 索引具有自己的清理阈值。例如，可以仅增加可以大量更新的 GIN 索引的阈值，否则可以减少阈值。

开发GIN索引的主要目标是在 PostgreSQL 中创建对高度可扩展的全文搜索的支持，并且通常在全文搜索返回非常大的结果集时会出现这种情况。此外，当查询包含非常频繁的单词时，这种情况经常发生，因此大的结果集甚至没有用处。由于从磁盘读取许多元组并对其进行排序可能会花费大量时间，因此这对于生产是不可接受的。（请注意，索引搜索本身非常快。）

为了方便控制此类查询的执行，GIN在返回的行数上有一个可配置的软上限：gin_fuzzy_search_limit 配置参数。默认情况下将其设置为 0（表示没有限制）。如果设置了非零限制，则返回的集合是整个结果集的子集，随机选择。

“软”表示实际返回的结果数可能与指定的限制略有不同，具体取决于查询和系统随机数生成器的质量。

从经验来看，数千个值（例如，5000 — 20000）效果很好。

几个数据类型的 B 树等效功能

用于存储（键，值）对的模块

增强对 int[] 的支持

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