Postgres Pro Shardman : Документация: 18: 67.5. Индексы BRIN : Компания Postgres Professional

67.5. Индексы BRIN
Пред.	Наверх	Глава 67. Встроенные индексные методы доступа	Начало	След.

67.5. Индексы BRIN #

67.5.1. Введение
67.5.2. Встроенные классы операторов
67.5.3. Расширяемость

67.5.1. Введение #

BRIN расшифровывается как «Block Range Index» (Индекс зон блоков). BRIN предназначается для обработки очень больших таблиц, в которых определённые столбцы некоторым естественным образом коррелируют с их физическим расположением в таблице.

В BRIN используется понятие зоны блоков (или «зоны страниц»). Зоной блоков называется группа страниц, физически расположенных в таблице рядом; для каждой зоны в индексе сохраняется некоторая сводная информация. Например, в таблице заказов магазина может содержаться поле с датой добавления заказа, и практически всегда записи более ранних заказов и в таблице будут размещены ближе к началу; в таблице, содержащей столбец с почтовым индексом, также естественным образом могут группироваться записи по городам.

Индексы BRIN могут удовлетворять запросы, выполняя обычное сканирование по битовой карте, и будут возвращать все кортежи во всех страницах каждой зоны, если сводные данные, сохранённые в индексе, соответствуют условиям запроса. Исполнитель запроса должен перепроверить эти кортежи и отбросить те, что не соответствуют условиям запроса — другими словами, эти индексы неточные. Так как индекс BRIN очень маленький, сканирование индекса влечёт мизерные издержки по сравнению с последовательным сканированием, но может избавить от необходимости сканирования больших областей таблицы, которые определённо не содержат подходящие кортежи.

Конкретные данные, которые будут хранится в индексе BRIN, а также запросы, которые сможет поддержать этот индекс, зависят от класса операторов, выбранного для каждого столбца индекса. Например, типы данных с линейным порядком сортировки могут иметь классы операторов, хранящие минимальное и максимальное значение для каждой зоны блоков; для геометрических типов может храниться прямоугольник, вмещающий все объекты в зоне блоков.

Размер зоны блоков определяется в момент создания индекса параметром хранения pages_per_range. Число записей в индексе будет равняться размеру отношения в страницах, делённому на установленное значение pages_per_range. Таким образом, чем меньше это число, тем больше становится индекс (так как в нём требуется хранить больше элементов), но в то же время сводные данные могут быть более точными и большее число блоков данных может быть пропущено при сканировании индекса.

67.5.1.1. Обслуживание индекса #

Во время создания индекса сканируются все существующие страницы, и в результате в индексе создаётся сводный кортеж для каждой зоны, в том числе, возможно неполной зоны в конце. По мере того, как данными наполняются новые страницы, если они оказываются в зонах, для которых уже есть сводная информация, она будет обновлена с учётом данных из новых кортежей. Если же создаётся новая страница, не попадающая в последнюю зону, для зоны, в которую попадает новая страница, сводная запись не рассчитывается автоматически; кортежи на таких страницах остаются неучтёнными, пока не будет проведён начальный расчёт сводных данных для этой зоны.

Начальный расчёт сводки для зоны страниц может производиться несколькими способами. Во-первых, сводка рассчитывается в ходе процедуры VACUUM, запущенной вручную или из процесса autovacuum, для всех существующих зон. Во-вторых, если включён параметр autosummarize для индекса (по умолчанию он отключён), при автоочистке этой базы данных производится расчёт сводки для всех зон без сводной информации, охватывающих недавно заполненные страницы таблицы, независимо от того, выполняется ли автоочистка именно этой таблицы; подробнее см. ниже.

Наконец, можно использовать следующие функции (пока они выполняются, search_path временно меняется на pg_catalog, pg_temp):

brin_summarize_new_values(regclass), рассчитывающую сводку для зон без сводных данных;

brin_summarize_range(regclass, bigint), рассчитывающую сводку для зоны без сводных данных, содержащей указанную страницу.

Когда включён режим автопересчёта сводки, при первом добавлении данных в первую страницу новой зоны процессу autovacuum передаётся запрос на расчёт сводки для этой зоны. Этот запрос будет выполнен при следующей обработке этой базы рабочим процессом автоочистки. Если очередь запросов переполнена, запрос в неё не записывается и в журнал сервера выводится соответствующее сообщение:

LOG:  request for BRIN range summarization for index "brin_wi_idx" page 128 was not recorded

В этом случае зона останется без сводного значения, а чтобы его рассчитать, нужно вручную выполнить очистку этой таблицы или вызвать одну из вышеуказанных функций.

И наоборот, можно удалить сводное значение для зоны, вызвав функцию brin_desummarize_range(regclass, bigint), что может быть полезно, когда этот кортеж в индексе становится не очень хорошим представлением соответствующих данных, так как они изменились. За дополнительной информацией обратитесь к Подразделу 9.28.8.

67.5.2. Встроенные классы операторов #

В базовый дистрибутив Postgres Pro Shardman включены классы операторов BRIN, перечисленные в Таблице 67.4.

Классы операторов minmax хранят минимальные и максимальные значения, встречающиеся в индексированном столбце в определённой зоне. Классы операторов inclusion хранят значение, в котором содержатся значения индексированного столбца в определённой зоне. Классы операторов bloom строят фильтр Блума для всех значений в определённой зоне. Классы операторов minmax-multi хранят несколько минимальных и максимальных значений, встречающихся в индексированном столбце в определённой зоне.

Таблица 67.4. Встроенные классы операторов BRIN

Имя	Индексируемые операторы
`bit_minmax_ops`	`= (bit,bit)`
	`< (bit,bit)`
	`> (bit,bit)`
	`<= (bit,bit)`
	`>= (bit,bit)`
`box_inclusion_ops`	`@> (box,point)`
	`<< (box,box)`
	`&< (box,box)`
	`&> (box,box)`
	`>> (box,box)`
	`<@ (box,box)`
	`@> (box,box)`
	`~= (box,box)`
	`&& (box,box)`
	`<<\| (box,box)`
	`&<\| (box,box)`
	`\|&> (box,box)`
	`\|>> (box,box)`
`bpchar_bloom_ops`	`= (character,character)`
`bpchar_minmax_ops`	`= (character,character)`
	`< (character,character)`
	`<= (character,character)`
	`> (character,character)`
	`>= (character,character)`
`bytea_bloom_ops`	`= (bytea,bytea)`
`bytea_minmax_ops`	`= (bytea,bytea)`
	`< (bytea,bytea)`
	`<= (bytea,bytea)`
	`> (bytea,bytea)`
	`>= (bytea,bytea)`
`char_bloom_ops`	`= ("char","char")`
`char_minmax_ops`	`= ("char","char")`
	`< ("char","char")`
	`<= ("char","char")`
	`> ("char","char")`
	`>= ("char","char")`
`date_bloom_ops`	`= (date,date)`
`date_minmax_ops`	`= (date,date)`
	`< (date,date)`
	`<= (date,date)`
	`> (date,date)`
	`>= (date,date)`
`date_minmax_multi_ops`	`= (date,date)`
	`< (date,date)`
	`<= (date,date)`
	`> (date,date)`
	`>= (date,date)`
`float4_bloom_ops`	`= (float4,float4)`
`float4_minmax_ops`	`= (float4,float4)`
	`< (float4,float4)`
	`> (float4,float4)`
	`<= (float4,float4)`
	`>= (float4,float4)`
`float4_minmax_multi_ops`	`= (float4,float4)`
	`< (float4,float4)`
	`> (float4,float4)`
	`<= (float4,float4)`
	`>= (float4,float4)`
`float8_bloom_ops`	`= (float8,float8)`
`float8_minmax_ops`	`= (float8,float8)`
	`< (float8,float8)`
	`<= (float8,float8)`
	`> (float8,float8)`
	`>= (float8,float8)`
`float8_minmax_multi_ops`	`= (float8,float8)`
	`< (float8,float8)`
	`<= (float8,float8)`
	`> (float8,float8)`
	`>= (float8,float8)`
`inet_inclusion_ops`	`<< (inet,inet)`
	`<<= (inet,inet)`
	`>> (inet,inet)`
	`>>= (inet,inet)`
	`= (inet,inet)`
	`&& (inet,inet)`
`inet_bloom_ops`	`= (inet,inet)`
`inet_minmax_ops`	`= (inet,inet)`
	`< (inet,inet)`
	`<= (inet,inet)`
	`> (inet,inet)`
	`>= (inet,inet)`
`inet_minmax_multi_ops`	`= (inet,inet)`
	`< (inet,inet)`
	`<= (inet,inet)`
	`> (inet,inet)`
	`>= (inet,inet)`
`int2_bloom_ops`	`= (int2,int2)`
`int2_minmax_ops`	`= (int2,int2)`
	`< (int2,int2)`
	`> (int2,int2)`
	`<= (int2,int2)`
	`>= (int2,int2)`
`int2_minmax_multi_ops`	`= (int2,int2)`
	`< (int2,int2)`
	`> (int2,int2)`
	`<= (int2,int2)`
	`>= (int2,int2)`
`int4_bloom_ops`	`= (int4,int4)`
`int4_minmax_ops`	`= (int4,int4)`
	`< (int4,int4)`
	`> (int4,int4)`
	`<= (int4,int4)`
	`>= (int4,int4)`
`int4_minmax_multi_ops`	`= (int4,int4)`
	`< (int4,int4)`
	`> (int4,int4)`
	`<= (int4,int4)`
	`>= (int4,int4)`
`int8_bloom_ops`	`= (bigint,bigint)`
`int8_minmax_ops`	`= (bigint,bigint)`
	`< (bigint,bigint)`
	`> (bigint,bigint)`
	`<= (bigint,bigint)`
	`>= (bigint,bigint)`
`int8_minmax_multi_ops`	`= (bigint,bigint)`
	`< (bigint,bigint)`
	`> (bigint,bigint)`
	`<= (bigint,bigint)`
	`>= (bigint,bigint)`
`interval_bloom_ops`	`= (interval,interval)`
`interval_minmax_ops`	`= (interval,interval)`
	`< (interval,interval)`
	`<= (interval,interval)`
	`> (interval,interval)`
	`>= (interval,interval)`
`interval_minmax_multi_ops`	`= (interval,interval)`
	`< (interval,interval)`
	`<= (interval,interval)`
	`> (interval,interval)`
	`>= (interval,interval)`
`macaddr_bloom_ops`	`= (macaddr,macaddr)`
`macaddr_minmax_ops`	`= (macaddr,macaddr)`
	`< (macaddr,macaddr)`
	`<= (macaddr,macaddr)`
	`> (macaddr,macaddr)`
	`>= (macaddr,macaddr)`
`macaddr_minmax_multi_ops`	`= (macaddr,macaddr)`
	`< (macaddr,macaddr)`
	`<= (macaddr,macaddr)`
	`> (macaddr,macaddr)`
	`>= (macaddr,macaddr)`
`macaddr8_bloom_ops`	`= (macaddr8,macaddr8)`
`macaddr8_minmax_ops`	`= (macaddr8,macaddr8)`
	`< (macaddr8,macaddr8)`
	`<= (macaddr8,macaddr8)`
	`> (macaddr8,macaddr8)`
	`>= (macaddr8,macaddr8)`
`macaddr8_minmax_multi_ops`	`= (macaddr8,macaddr8)`
	`< (macaddr8,macaddr8)`
	`<= (macaddr8,macaddr8)`
	`> (macaddr8,macaddr8)`
	`>= (macaddr8,macaddr8)`
`name_bloom_ops`	`= (name,name)`
`name_minmax_ops`	`= (name,name)`
	`< (name,name)`
	`<= (name,name)`
	`> (name,name)`
	`>= (name,name)`
`numeric_bloom_ops`	`= (numeric,numeric)`
`numeric_minmax_ops`	`= (numeric,numeric)`
	`< (numeric,numeric)`
	`<= (numeric,numeric)`
	`> (numeric,numeric)`
	`>= (numeric,numeric)`
`numeric_minmax_multi_ops`	`= (numeric,numeric)`
	`< (numeric,numeric)`
	`<= (numeric,numeric)`
	`> (numeric,numeric)`
	`>= (numeric,numeric)`
`oid_bloom_ops`	`= (oid,oid)`
`oid_minmax_ops`	`= (oid,oid)`
	`< (oid,oid)`
	`> (oid,oid)`
	`<= (oid,oid)`
	`>= (oid,oid)`
`oid_minmax_multi_ops`	`= (oid,oid)`
	`< (oid,oid)`
	`> (oid,oid)`
	`<= (oid,oid)`
	`>= (oid,oid)`
`pg_lsn_bloom_ops`	`= (pg_lsn,pg_lsn)`
`pg_lsn_minmax_ops`	`= (pg_lsn,pg_lsn)`
	`< (pg_lsn,pg_lsn)`
	`> (pg_lsn,pg_lsn)`
	`<= (pg_lsn,pg_lsn)`
	`>= (pg_lsn,pg_lsn)`
`pg_lsn_minmax_multi_ops`	`= (pg_lsn,pg_lsn)`
	`< (pg_lsn,pg_lsn)`
	`> (pg_lsn,pg_lsn)`
	`<= (pg_lsn,pg_lsn)`
	`>= (pg_lsn,pg_lsn)`
`range_inclusion_ops`	`= (anyrange,anyrange)`
	`< (anyrange,anyrange)`
	`<= (anyrange,anyrange)`
	`>= (anyrange,anyrange)`
	`> (anyrange,anyrange)`
	`&& (anyrange,anyrange)`
	`@> (anyrange,anyelement)`
	`@> (anyrange,anyrange)`
	`<@ (anyrange,anyrange)`
	`<< (anyrange,anyrange)`
	`>> (anyrange,anyrange)`
	`&< (anyrange,anyrange)`
	`&> (anyrange,anyrange)`
	`-\|- (anyrange,anyrange)`
`text_bloom_ops`	`= (text,text)`
`text_minmax_ops`	`= (text,text)`
	`< (text,text)`
	`<= (text,text)`
	`> (text,text)`
	`>= (text,text)`
`tid_bloom_ops`	`= (tid,tid)`
`tid_minmax_ops`	`= (tid,tid)`
	`< (tid,tid)`
	`> (tid,tid)`
	`<= (tid,tid)`
	`>= (tid,tid)`
`tid_minmax_multi_ops`	`= (tid,tid)`
	`< (tid,tid)`
	`> (tid,tid)`
	`<= (tid,tid)`
	`>= (tid,tid)`
`timestamp_bloom_ops`	`= (timestamp,timestamp)`
`timestamp_minmax_ops`	`= (timestamp,timestamp)`
	`< (timestamp,timestamp)`
	`<= (timestamp,timestamp)`
	`> (timestamp,timestamp)`
	`>= (timestamp,timestamp)`
`timestamp_minmax_multi_ops`	`= (timestamp,timestamp)`
	`< (timestamp,timestamp)`
	`<= (timestamp,timestamp)`
	`> (timestamp,timestamp)`
	`>= (timestamp,timestamp)`
`timestamptz_bloom_ops`	`= (timestamptz,timestamptz)`
`timestamptz_minmax_ops`	`= (timestamptz,timestamptz)`
	`< (timestamptz,timestamptz)`
	`<= (timestamptz,timestamptz)`
	`> (timestamptz,timestamptz)`
	`>= (timestamptz,timestamptz)`
`timestamptz_minmax_multi_ops`	`= (timestamptz,timestamptz)`
	`< (timestamptz,timestamptz)`
	`<= (timestamptz,timestamptz)`
	`> (timestamptz,timestamptz)`
	`>= (timestamptz,timestamptz)`
`time_bloom_ops`	`= (time,time)`
`time_minmax_ops`	`= (time,time)`
	`< (time,time)`
	`<= (time,time)`
	`> (time,time)`
	`>= (time,time)`
`time_minmax_multi_ops`	`= (time,time)`
	`< (time,time)`
	`<= (time,time)`
	`> (time,time)`
	`>= (time,time)`
`timetz_bloom_ops`	`= (timetz,timetz)`
`timetz_minmax_ops`	`= (timetz,timetz)`
	`< (timetz,timetz)`
	`<= (timetz,timetz)`
	`> (timetz,timetz)`
	`>= (timetz,timetz)`
`timetz_minmax_multi_ops`	`= (timetz,timetz)`
	`< (timetz,timetz)`
	`<= (timetz,timetz)`
	`> (timetz,timetz)`
	`>= (timetz,timetz)`
`uuid_bloom_ops`	`= (uuid,uuid)`
`uuid_minmax_ops`	`= (uuid,uuid)`
	`< (uuid,uuid)`
	`> (uuid,uuid)`
	`<= (uuid,uuid)`
	`>= (uuid,uuid)`
`uuid_minmax_multi_ops`	`= (uuid,uuid)`
	`< (uuid,uuid)`
	`> (uuid,uuid)`
	`<= (uuid,uuid)`
	`>= (uuid,uuid)`
`varbit_minmax_ops`	`= (varbit,varbit)`
	`< (varbit,varbit)`
	`> (varbit,varbit)`
	`<= (varbit,varbit)`
	`>= (varbit,varbit)`

67.5.2.1. Параметры класса операторов #

Для некоторых встроенных классов операторов можно задавать параметры, влияющие на их поведение, а именно: для классов операторов bloom и minmax-multi. У разных классов операторов разный набор допустимых параметров.

Классы операторов bloom принимают эти параметры:

n_distinct_per_range: Определяет предполагаемое количество различных значений (без учёта NULL) в зоне блоков, в зависимости от которого выбирается размер фильтра Блума в BRIN-индексе. Работает аналогично параметру n_distinct для ALTER TABLE. Положительное значение непосредственно задаёт предполагаемое количество. Минимальное количество различных значений (без учёта NULL) значений — 16. Если заданное значение отрицательно, то количество таких значений линейно зависит от максимального возможного числа кортежей в зоне блоков (один блок может содержать до 290 строк). Коэффициентом зависимости будет модуль этого значения, который не должен превышать 1. Значение по умолчанию — -0.1.
false_positive_rate: Определяет ожидаемую долю ложных положительных срабатываний, в зависимости от которой выбирается размер фильтра Блума в BRIN-индексе. Принимаются значения от 0,0001 до 0,25. Значение по умолчанию — 0,01, то есть вероятность ложных положительных срабатываний равна 1%.

Классы операторов minmax-multi принимают эти параметры:

values_per_range: Определяет максимальное количество значений, хранимых BRIN-индексами типа minmax для обобщения информации по зоне блоков. Каждое значение может представлять собой либо точку, либо границу интервала. Принимаются значения от 8 до 256, а значение по умолчанию — 32.

67.5.3. Расширяемость #

Интерфейс BRIN характеризуется высоким уровнем абстракции и таким образом требует от разработчика метода доступа реализовать только смысловое наполнение обрабатываемого типа данных. Уровень BRIN берёт на себя заботу о параллельном доступе, поддержке журнала и поиске в структуре индекса.

Всё, что нужно, чтобы получить работающий метод доступа BRIN — это реализовать несколько пользовательских методов, определяющих поведение сводных значений, хранящихся в индексе, и их взаимоотношения с ключами сканирования. Словом, BRIN сочетает расширяемость с универсальностью, повторным использованием кода и аккуратным интерфейсом.

Класс операторов для BRIN должен предоставлять четыре метода:

BrinOpcInfo *opcInfo(Oid type_oid)

Возвращает внутреннюю информацию о сводных данных индексированных столбцов. Возвращаемое значение должно указывать на BrinOpcInfo (в памяти palloc) со следующим определением:

typedef struct BrinOpcInfo
{
    /* Число полей, хранящихся в столбце индекса этого класса операторов */
    uint16      oi_nstored;

    /* Непрозрачный указатель для внутреннего использования классом операторов */
    void       *oi_opaque;

    /* Элементы кеша типов для сохранённых столбцов */
    TypeCacheEntry *oi_typcache[FLEXIBLE_ARRAY_MEMBER];
} BrinOpcInfo;

Поле BrinOpcInfo.oi_opaque могут использовать подпрограммы класса операторов для передачи информации опорным функциям при сканировании индекса.

bool consistent(BrinDesc *bdesc, BrinValues *column, ScanKey *keys, int nkeys)

Показывает, соответствуют ли все значения ScanKey заданным индексированным значениям некоторой зоны. Номер целевого атрибута передаётся в составе ключа сканирования. Для одного атрибута может передаваться несколько ключей сканирования. Количество записей определяется параметром nkeys.

bool consistent(BrinDesc *bdesc, BrinValues *column, ScanKey key)

Показывает, соответствует ли значение ScanKey заданным индексированным значениям некоторой зоны. Номер целевого атрибута передаётся в составе ключа сканирования. Этот обратно совместимый вариант функции consistent устарел.

bool addValue(BrinDesc *bdesc, BrinValues *column, Datum newval, bool isnull)

Для заданного кортежа индекса и индексируемого значения изменяет выбранный атрибут кортежа, чтобы он дополнительно охватывал новое значение. Если в кортеж вносятся какие-либо изменения, возвращается true.

bool unionTuples(BrinDesc *bdesc, BrinValues *a, BrinValues *b)

Консолидирует два кортежа индекса. Получая два кортежа, изменяет выбранный атрибут первого из них, что он охватывал оба кортежа. Второй кортеж не изменяется.

Дополнительно класс операторов для BRIN может предоставить следующий метод:

void options(local_relopts *relopts)

Определяет набор видимых пользователю параметров, управляющих поведением класса операторов.

Функции options передаётся указатель на структуру local_relopts, в которую нужно внести набор параметров, относящихся к классу операторов. Обращаться к этим параметрам из других опорных функций можно с помощью макросов PG_HAS_OPCLASS_OPTIONS() и PG_GET_OPCLASS_OPTIONS().

Так как в BRIN и извлечение ключа из индексируемых значений, и его представление допускают гибкость, могут быть полезны параметры для настройки этого индекса.

Основной дистрибутив включает поддержку четырёх типов классов операторов: minmax, minmax-multi, inclusion и bloom. Определения классов операторов, использующие их, представлены для встроенных типов данных, насколько это уместно. Пользователь может определить дополнительные классы операторов для других типов данных, применяя аналогичные определения, и обойтись таким образом без написания кода; достаточно будет объявить нужные записи в каталоге. Заметьте, что предположения о семантике стратегий операторов зашиты в исходном коде опорных функций.

Также возможно создать классы операторов, воплощающие полностью другую семантику, разработав реализации четырёх основных опорных функций, описанных выше. Заметьте, что обратная совместимость между разными основными версиями не гарантируется: к примеру, в следующих выпусках могут потребоваться дополнительные опорные функции.

При написании класса операторов для типа данных, представляющего полностью упорядоченное множество, можно использовать опорные функции minmax вместе с соответствующими операторами, как показано в Таблице 67.5. Все члены класса операторов (функции и операторы) являются обязательными.

Таблица 67.5. Номера стратегий и опорных функций для классов операторов minmax

Член класса операторов	Объект
Опорная функция 1	внутренняя функция `brin_minmax_opcinfo()`
Опорная функция 2	внутренняя функция `brin_minmax_add_value()`
Опорная функция 3	внутренняя функция `brin_minmax_consistent()`
Опорная функция 4	внутренняя функция `brin_minmax_union()`
Стратегия оператора 1	оператор меньше
Стратегия оператора 2	оператор меньше-или-равно
Стратегия оператора 3	оператор равно
Стратегия оператора 4	оператор больше-или-равно
Стратегия оператора 5	оператор больше

При написании класса операторов для сложного типа данных, значения которого включаются в другой тип, можно использовать опорные функции inclusion вместе с соответствующими операторами, как показано в Таблице 67.6. Для этого требуется одна дополнительная функция, которую можно написать на любом языке. Для расширенной функциональности можно определить другие функции. Все операторы являются необязательными. Некоторые из них требует наличия других, что показано в таблице как зависимости.

Таблица 67.6. Номера стратегий и опорных функций для классов операторов inclusion

Член класса операторов	Объект	Зависимость
Опорная функция 1	внутренняя функция `brin_inclusion_opcinfo()`
Опорная функция 2	внутренняя функция `brin_inclusion_add_value()`
Опорная функция 3	внутренняя функция `brin_inclusion_consistent()`
Опорная функция 4	внутренняя функция `brin_inclusion_union()`
Опорная функция 11	функция для слияния двух элементов
Опорная функция 12	необязательная функция для проверки возможности слияния двух элементов
Опорная функция 13	необязательная функция для проверки, содержится ли один элемент в другом
Опорная функция 14	необязательная функция для проверки, является ли элемент пустым
Стратегия оператора 1	оператор левее	Стратегия оператора 4
Стратегия оператора 2	оператор не-простирается-правее	Стратегия оператора 5
Стратегия оператора 3	оператор перекрывается
Стратегия оператора 4	оператор не-простирается-левее	Стратегия оператора 1
Стратегия оператора 5	оператор правее	Стратегия оператора 2
Стратегия оператора 6, 18	оператор то-же-или-равно	Стратегия оператора 7
Стратегия оператора 7, 16, 24, 25	оператор содержит-или-равно
Стратегия оператора 8, 26, 27	оператор содержится-в-или-равно	Стратегия оператора 3
Стратегия оператора 9	оператор не-простирается-выше	Стратегия оператора 11
Стратегия оператора 10	оператор ниже	Стратегия оператора 12
Стратегия оператора 11	оператор выше	Стратегия оператора 9
Стратегия оператора 12	оператор не-простирается-ниже	Стратегия оператора 10
Стратегия оператора 20	оператор меньше	Стратегия оператора 5
Стратегия оператора 21	оператор меньше-или-равно	Стратегия оператора 5
Стратегия оператора 22	оператор больше	Стратегия оператора 1
Стратегия оператора 23	оператор больше-или-равно	Стратегия оператора 1

Номера опорных функций от 1 до 10 зарезервированы для внутренних функций BRIN, так что функции уровня SQL начинаются с номера 11. Опорная функция номер 11 является основной, необходимой для построения индекса. Она должна принимать два аргумента того же типа данных, что и целевой тип класса, и возвращать их объединение. Класс операторов inclusion может сохранять значения объединения в различных типах данных, в зависимости от параметра STORAGE. Возвращаемое функцией объединения значение должно соответствовать типу данных STORAGE.

Опорные функции под номерами 12 и 14 предоставляются для поддержки нерегулярностей встроенных типов данных. Функция номер 12 применяется для поддержки работы с сетевыми адресами из различных семейств, которые нельзя объединять. Функция номер 14 применяется для поддержки зон с пустыми значениями. Функция номер 13 является необязательной, но рекомендуемой; она проверяет новое значение, прежде чем оно будет передано функции объединения. Инфраструктура BRIN может соптимизировать некоторые операции, когда объединение не меняется, поэтому применение этой функции может способствовать увеличению быстродействия индекса.

При написании класса операторов для типа данных, который реализует только оператор равенства и поддерживает хеширование, можно использовать опорные процедуры bloom вместе с соответствующими операторами, как показано в Таблица 67.7. Все члены класса операторов (процедуры и операторы) являются обязательными.

Таблица 67.7. Номера стратегий и опорных процедур для классов операторов bloom

Член класса операторов	Объект
Опорная процедура 1	внутренняя функция `brin_bloom_opcinfo()`
Опорная процедура 2	внутренняя функция `brin_bloom_add_value()`
Опорная процедура 3	внутренняя функция `brin_bloom_consistent()`
Опорная процедура 4	внутренняя функция `brin_bloom_union()`
Опорная процедура 5	внутренняя функция `brin_bloom_options()`
Опорная процедура 11	функция для вычисления хеша элемента
Стратегия оператора 1	оператор равно

Номера опорных процедур 1-10 зарезервированы для внутренних функций BRIN, так что функции уровня SQL начинаются с номера 11. Опорная функция номер 11 является основной, необходимой для построения индекса. Она должна принимать один аргумент того же типа данных, что и класс оператора, и возвращать хеш значения.

Класс операторов minmax-multi также используется для типов данных, представляющих полностью упорядоченное множество, и может рассматриваться просто как расширение класса операторов minmax. Класс операторов minmax для каждого блока обобщает информацию по значениям в один непрерывный интервал, а minmax-multi позволяет обобщить информацию по значениям в несколько меньших интервалов для более эффективной обработки выпадающих значений. При написании класса операторов можно использовать опорные процедуры minmax-multi вместе с соответствующими операторами, как показано в Таблица 67.8. Все члены класса операторов (процедуры и операторы) являются обязательными.

Таблица 67.8. Номера стратегий и опорных процедур для классов операторов minmax-multi

Член класса операторов	Объект
Опорная процедура 1	внутренняя функция `brin_minmax_multi_opcinfo()`
Опорная процедура 2	внутренняя функция `brin_minmax_add_value()`
Опорная процедура 3	внутренняя функция `brin_minmax_consistent()`
Опорная процедура 4	внутренняя функция `brin_minmax_union()`
Опорная процедура 5	внутренняя функция `brin_minmax_multi_options()`
Опорная процедура 11	функция для вычисления расстояния между двумя значениями (размер зоны)
Стратегия оператора 1	оператор меньше
Стратегия оператора 2	оператор меньше-или-равно
Стратегия оператора 3	оператор равно
Стратегия оператора 4	оператор больше-или-равно
Стратегия оператора 5	оператор больше

Классы операторов minmax и inclusion поддерживают межтиповые операторы, хотя с ними зависимости становятся более сложными. Класс minmax требует, чтобы для двух аргументов одного типа определялся полный набор операторов. Это позволяет поддерживать дополнительные типы данных, определяя дополнительные наборы операторов. Стратегии операторов класса inclusion могут зависеть от других стратегий, как показано в Таблице 67.6, или от своих собственных стратегий. Для них требуется, чтобы был определён необходимый оператор с типом данных STORAGE для левого аргумента и другим поддерживаемым типом для правого аргумента реализуемого оператора. См. определение float4_minmax_ops в качестве примера для minmax и box_inclusion_ops в качестве примера для inclusion.

Пред.	Наверх	След.
67.4. Индексы GIN	Начало	67.6. Хеш-индексы

67.5. BRIN Indexes
Prev	Up	Chapter 67. Built-in Index Access Methods	Home	Next

67.5. BRIN Indexes #

67.5.1. Introduction
67.5.2. Built-in Operator Classes
67.5.3. Extensibility

67.5.1. Introduction #

BRIN stands for Block Range Index. BRIN is designed for handling very large tables in which certain columns have some natural correlation with their physical location within the table.

BRIN works in terms of block ranges (or “page ranges”). A block range is a group of pages that are physically adjacent in the table; for each block range, some summary info is stored by the index. For example, a table storing a store's sale orders might have a date column on which each order was placed, and most of the time the entries for earlier orders will appear earlier in the table as well; a table storing a ZIP code column might have all codes for a city grouped together naturally.

BRIN indexes can satisfy queries via regular bitmap index scans, and will return all tuples in all pages within each range if the summary info stored by the index is consistent with the query conditions. The query executor is in charge of rechecking these tuples and discarding those that do not match the query conditions — in other words, these indexes are lossy. Because a BRIN index is very small, scanning the index adds little overhead compared to a sequential scan, but may avoid scanning large parts of the table that are known not to contain matching tuples.

The specific data that a BRIN index will store, as well as the specific queries that the index will be able to satisfy, depend on the operator class selected for each column of the index. Data types having a linear sort order can have operator classes that store the minimum and maximum value within each block range, for instance; geometrical types might store the bounding box for all the objects in the block range.

The size of the block range is determined at index creation time by the pages_per_range storage parameter. The number of index entries will be equal to the size of the relation in pages divided by the selected value for pages_per_range. Therefore, the smaller the number, the larger the index becomes (because of the need to store more index entries), but at the same time the summary data stored can be more precise and more data blocks can be skipped during an index scan.

67.5.1.1. Index Maintenance #

At the time of creation, all existing heap pages are scanned and a summary index tuple is created for each range, including the possibly-incomplete range at the end. As new pages are filled with data, page ranges that are already summarized will cause the summary information to be updated with data from the new tuples. When a new page is created that does not fall within the last summarized range, the range that the new page belongs to does not automatically acquire a summary tuple; those tuples remain unsummarized until a summarization run is invoked later, creating the initial summary for that range.

There are several ways to trigger the initial summarization of a page range. If the table is vacuumed, either manually or by autovacuum, all existing unsummarized page ranges are summarized. Also, if the index's autosummarize parameter is enabled, which it isn't by default, whenever autovacuum runs in that database, summarization will occur for all unsummarized page ranges that have been filled, regardless of whether the table itself is processed by autovacuum; see below.

Lastly, the following functions can be used (while these functions run, search_path is temporarily changed to pg_catalog, pg_temp):

brin_summarize_new_values(regclass) which summarizes all unsummarized ranges;

brin_summarize_range(regclass, bigint) which summarizes only the range containing the given page, if it is unsummarized.

When autosummarization is enabled, a request is sent to autovacuum to execute a targeted summarization for a block range when an insertion is detected for the first item of the first page of the next block range, to be fulfilled the next time an autovacuum worker finishes running in the same database. If the request queue is full, the request is not recorded and a message is sent to the server log:

LOG:  request for BRIN range summarization for index "brin_wi_idx" page 128 was not recorded

When this happens, the range will remain unsummarized until the next regular vacuum run on the table, or one of the functions mentioned above are invoked.

Conversely, a range can be de-summarized using the brin_desummarize_range(regclass, bigint) function, which is useful when the index tuple is no longer a very good representation because the existing values have changed. See Section 9.28.8 for details.

67.5.2. Built-in Operator Classes #

The core Postgres Pro Shardman distribution includes the BRIN operator classes shown in Table 67.4.

The minmax operator classes store the minimum and the maximum values appearing in the indexed column within the range. The inclusion operator classes store a value which includes the values in the indexed column within the range. The bloom operator classes build a Bloom filter for all values in the range. The minmax-multi operator classes store multiple minimum and maximum values, representing values appearing in the indexed column within the range.

Table 67.4. Built-in BRIN Operator Classes

Name	Indexable Operators
`bit_minmax_ops`	`= (bit,bit)`
	`< (bit,bit)`
	`> (bit,bit)`
	`<= (bit,bit)`
	`>= (bit,bit)`
`box_inclusion_ops`	`@> (box,point)`
	`<< (box,box)`
	`&< (box,box)`
	`&> (box,box)`
	`>> (box,box)`
	`<@ (box,box)`
	`@> (box,box)`
	`~= (box,box)`
	`&& (box,box)`
	`<<\| (box,box)`
	`&<\| (box,box)`
	`\|&> (box,box)`
	`\|>> (box,box)`
`bpchar_bloom_ops`	`= (character,character)`
`bpchar_minmax_ops`	`= (character,character)`
	`< (character,character)`
	`<= (character,character)`
	`> (character,character)`
	`>= (character,character)`
`bytea_bloom_ops`	`= (bytea,bytea)`
`bytea_minmax_ops`	`= (bytea,bytea)`
	`< (bytea,bytea)`
	`<= (bytea,bytea)`
	`> (bytea,bytea)`
	`>= (bytea,bytea)`
`char_bloom_ops`	`= ("char","char")`
`char_minmax_ops`	`= ("char","char")`
	`< ("char","char")`
	`<= ("char","char")`
	`> ("char","char")`
	`>= ("char","char")`
`date_bloom_ops`	`= (date,date)`
`date_minmax_ops`	`= (date,date)`
	`< (date,date)`
	`<= (date,date)`
	`> (date,date)`
	`>= (date,date)`
`date_minmax_multi_ops`	`= (date,date)`
	`< (date,date)`
	`<= (date,date)`
	`> (date,date)`
	`>= (date,date)`
`float4_bloom_ops`	`= (float4,float4)`
`float4_minmax_ops`	`= (float4,float4)`
	`< (float4,float4)`
	`> (float4,float4)`
	`<= (float4,float4)`
	`>= (float4,float4)`
`float4_minmax_multi_ops`	`= (float4,float4)`
	`< (float4,float4)`
	`> (float4,float4)`
	`<= (float4,float4)`
	`>= (float4,float4)`
`float8_bloom_ops`	`= (float8,float8)`
`float8_minmax_ops`	`= (float8,float8)`
	`< (float8,float8)`
	`<= (float8,float8)`
	`> (float8,float8)`
	`>= (float8,float8)`
`float8_minmax_multi_ops`	`= (float8,float8)`
	`< (float8,float8)`
	`<= (float8,float8)`
	`> (float8,float8)`
	`>= (float8,float8)`
`inet_inclusion_ops`	`<< (inet,inet)`
	`<<= (inet,inet)`
	`>> (inet,inet)`
	`>>= (inet,inet)`
	`= (inet,inet)`
	`&& (inet,inet)`
`inet_bloom_ops`	`= (inet,inet)`
`inet_minmax_ops`	`= (inet,inet)`
	`< (inet,inet)`
	`<= (inet,inet)`
	`> (inet,inet)`
	`>= (inet,inet)`
`inet_minmax_multi_ops`	`= (inet,inet)`
	`< (inet,inet)`
	`<= (inet,inet)`
	`> (inet,inet)`
	`>= (inet,inet)`
`int2_bloom_ops`	`= (int2,int2)`
`int2_minmax_ops`	`= (int2,int2)`
	`< (int2,int2)`
	`> (int2,int2)`
	`<= (int2,int2)`
	`>= (int2,int2)`
`int2_minmax_multi_ops`	`= (int2,int2)`
	`< (int2,int2)`
	`> (int2,int2)`
	`<= (int2,int2)`
	`>= (int2,int2)`
`int4_bloom_ops`	`= (int4,int4)`
`int4_minmax_ops`	`= (int4,int4)`
	`< (int4,int4)`
	`> (int4,int4)`
	`<= (int4,int4)`
	`>= (int4,int4)`
`int4_minmax_multi_ops`	`= (int4,int4)`
	`< (int4,int4)`
	`> (int4,int4)`
	`<= (int4,int4)`
	`>= (int4,int4)`
`int8_bloom_ops`	`= (bigint,bigint)`
`int8_minmax_ops`	`= (bigint,bigint)`
	`< (bigint,bigint)`
	`> (bigint,bigint)`
	`<= (bigint,bigint)`
	`>= (bigint,bigint)`
`int8_minmax_multi_ops`	`= (bigint,bigint)`
	`< (bigint,bigint)`
	`> (bigint,bigint)`
	`<= (bigint,bigint)`
	`>= (bigint,bigint)`
`interval_bloom_ops`	`= (interval,interval)`
`interval_minmax_ops`	`= (interval,interval)`
	`< (interval,interval)`
	`<= (interval,interval)`
	`> (interval,interval)`
	`>= (interval,interval)`
`interval_minmax_multi_ops`	`= (interval,interval)`
	`< (interval,interval)`
	`<= (interval,interval)`
	`> (interval,interval)`
	`>= (interval,interval)`
`macaddr_bloom_ops`	`= (macaddr,macaddr)`
`macaddr_minmax_ops`	`= (macaddr,macaddr)`
	`< (macaddr,macaddr)`
	`<= (macaddr,macaddr)`
	`> (macaddr,macaddr)`
	`>= (macaddr,macaddr)`
`macaddr_minmax_multi_ops`	`= (macaddr,macaddr)`
	`< (macaddr,macaddr)`
	`<= (macaddr,macaddr)`
	`> (macaddr,macaddr)`
	`>= (macaddr,macaddr)`
`macaddr8_bloom_ops`	`= (macaddr8,macaddr8)`
`macaddr8_minmax_ops`	`= (macaddr8,macaddr8)`
	`< (macaddr8,macaddr8)`
	`<= (macaddr8,macaddr8)`
	`> (macaddr8,macaddr8)`
	`>= (macaddr8,macaddr8)`
`macaddr8_minmax_multi_ops`	`= (macaddr8,macaddr8)`
	`< (macaddr8,macaddr8)`
	`<= (macaddr8,macaddr8)`
	`> (macaddr8,macaddr8)`
	`>= (macaddr8,macaddr8)`
`name_bloom_ops`	`= (name,name)`
`name_minmax_ops`	`= (name,name)`
	`< (name,name)`
	`<= (name,name)`
	`> (name,name)`
	`>= (name,name)`
`numeric_bloom_ops`	`= (numeric,numeric)`
`numeric_minmax_ops`	`= (numeric,numeric)`
	`< (numeric,numeric)`
	`<= (numeric,numeric)`
	`> (numeric,numeric)`
	`>= (numeric,numeric)`
`numeric_minmax_multi_ops`	`= (numeric,numeric)`
	`< (numeric,numeric)`
	`<= (numeric,numeric)`
	`> (numeric,numeric)`
	`>= (numeric,numeric)`
`oid_bloom_ops`	`= (oid,oid)`
`oid_minmax_ops`	`= (oid,oid)`
	`< (oid,oid)`
	`> (oid,oid)`
	`<= (oid,oid)`
	`>= (oid,oid)`
`oid_minmax_multi_ops`	`= (oid,oid)`
	`< (oid,oid)`
	`> (oid,oid)`
	`<= (oid,oid)`
	`>= (oid,oid)`
`pg_lsn_bloom_ops`	`= (pg_lsn,pg_lsn)`
`pg_lsn_minmax_ops`	`= (pg_lsn,pg_lsn)`
	`< (pg_lsn,pg_lsn)`
	`> (pg_lsn,pg_lsn)`
	`<= (pg_lsn,pg_lsn)`
	`>= (pg_lsn,pg_lsn)`
`pg_lsn_minmax_multi_ops`	`= (pg_lsn,pg_lsn)`
	`< (pg_lsn,pg_lsn)`
	`> (pg_lsn,pg_lsn)`
	`<= (pg_lsn,pg_lsn)`
	`>= (pg_lsn,pg_lsn)`
`range_inclusion_ops`	`= (anyrange,anyrange)`
	`< (anyrange,anyrange)`
	`<= (anyrange,anyrange)`
	`>= (anyrange,anyrange)`
	`> (anyrange,anyrange)`
	`&& (anyrange,anyrange)`
	`@> (anyrange,anyelement)`
	`@> (anyrange,anyrange)`
	`<@ (anyrange,anyrange)`
	`<< (anyrange,anyrange)`
	`>> (anyrange,anyrange)`
	`&< (anyrange,anyrange)`
	`&> (anyrange,anyrange)`
	`-\|- (anyrange,anyrange)`
`text_bloom_ops`	`= (text,text)`
`text_minmax_ops`	`= (text,text)`
	`< (text,text)`
	`<= (text,text)`
	`> (text,text)`
	`>= (text,text)`
`tid_bloom_ops`	`= (tid,tid)`
`tid_minmax_ops`	`= (tid,tid)`
	`< (tid,tid)`
	`> (tid,tid)`
	`<= (tid,tid)`
	`>= (tid,tid)`
`tid_minmax_multi_ops`	`= (tid,tid)`
	`< (tid,tid)`
	`> (tid,tid)`
	`<= (tid,tid)`
	`>= (tid,tid)`
`timestamp_bloom_ops`	`= (timestamp,timestamp)`
`timestamp_minmax_ops`	`= (timestamp,timestamp)`
	`< (timestamp,timestamp)`
	`<= (timestamp,timestamp)`
	`> (timestamp,timestamp)`
	`>= (timestamp,timestamp)`
`timestamp_minmax_multi_ops`	`= (timestamp,timestamp)`
	`< (timestamp,timestamp)`
	`<= (timestamp,timestamp)`
	`> (timestamp,timestamp)`
	`>= (timestamp,timestamp)`
`timestamptz_bloom_ops`	`= (timestamptz,timestamptz)`
`timestamptz_minmax_ops`	`= (timestamptz,timestamptz)`
	`< (timestamptz,timestamptz)`
	`<= (timestamptz,timestamptz)`
	`> (timestamptz,timestamptz)`
	`>= (timestamptz,timestamptz)`
`timestamptz_minmax_multi_ops`	`= (timestamptz,timestamptz)`
	`< (timestamptz,timestamptz)`
	`<= (timestamptz,timestamptz)`
	`> (timestamptz,timestamptz)`
	`>= (timestamptz,timestamptz)`
`time_bloom_ops`	`= (time,time)`
`time_minmax_ops`	`= (time,time)`
	`< (time,time)`
	`<= (time,time)`
	`> (time,time)`
	`>= (time,time)`
`time_minmax_multi_ops`	`= (time,time)`
	`< (time,time)`
	`<= (time,time)`
	`> (time,time)`
	`>= (time,time)`
`timetz_bloom_ops`	`= (timetz,timetz)`
`timetz_minmax_ops`	`= (timetz,timetz)`
	`< (timetz,timetz)`
	`<= (timetz,timetz)`
	`> (timetz,timetz)`
	`>= (timetz,timetz)`
`timetz_minmax_multi_ops`	`= (timetz,timetz)`
	`< (timetz,timetz)`
	`<= (timetz,timetz)`
	`> (timetz,timetz)`
	`>= (timetz,timetz)`
`uuid_bloom_ops`	`= (uuid,uuid)`
`uuid_minmax_ops`	`= (uuid,uuid)`
	`< (uuid,uuid)`
	`> (uuid,uuid)`
	`<= (uuid,uuid)`
	`>= (uuid,uuid)`
`uuid_minmax_multi_ops`	`= (uuid,uuid)`
	`< (uuid,uuid)`
	`> (uuid,uuid)`
	`<= (uuid,uuid)`
	`>= (uuid,uuid)`
`varbit_minmax_ops`	`= (varbit,varbit)`
	`< (varbit,varbit)`
	`> (varbit,varbit)`
	`<= (varbit,varbit)`
	`>= (varbit,varbit)`

67.5.2.1. Operator Class Parameters #

Some of the built-in operator classes allow specifying parameters affecting behavior of the operator class. Each operator class has its own set of allowed parameters. Only the bloom and minmax-multi operator classes allow specifying parameters:

bloom operator classes accept these parameters:

n_distinct_per_range: Defines the estimated number of distinct non-null values in the block range, used by BRIN bloom indexes for sizing of the Bloom filter. It behaves similarly to n_distinct option for ALTER TABLE. When set to a positive value, each block range is assumed to contain this number of distinct non-null values. When set to a negative value, which must be greater than or equal to -1, the number of distinct non-null values is assumed to grow linearly with the maximum possible number of tuples in the block range (about 290 rows per block). The default value is -0.1, and the minimum number of distinct non-null values is 16.
false_positive_rate: Defines the desired false positive rate used by BRIN bloom indexes for sizing of the Bloom filter. The values must be between 0.0001 and 0.25. The default value is 0.01, which is 1% false positive rate.

minmax-multi operator classes accept these parameters:

values_per_range: Defines the maximum number of values stored by BRIN minmax indexes to summarize a block range. Each value may represent either a point, or a boundary of an interval. Values must be between 8 and 256, and the default value is 32.

67.5.3. Extensibility #

The BRIN interface has a high level of abstraction, requiring the access method implementer only to implement the semantics of the data type being accessed. The BRIN layer itself takes care of concurrency, logging and searching the index structure.

All it takes to get a BRIN access method working is to implement a few user-defined methods, which define the behavior of summary values stored in the index and the way they interact with scan keys. In short, BRIN combines extensibility with generality, code reuse, and a clean interface.

There are four methods that an operator class for BRIN must provide:

BrinOpcInfo *opcInfo(Oid type_oid)

Returns internal information about the indexed columns' summary data. The return value must point to a palloc'd BrinOpcInfo, which has this definition:

typedef struct BrinOpcInfo
{
    /* Number of columns stored in an index column of this opclass */
    uint16      oi_nstored;

    /* Opaque pointer for the opclass' private use */
    void       *oi_opaque;

    /* Type cache entries of the stored columns */
    TypeCacheEntry *oi_typcache[FLEXIBLE_ARRAY_MEMBER];
} BrinOpcInfo;

BrinOpcInfo.oi_opaque can be used by the operator class routines to pass information between support functions during an index scan.

bool consistent(BrinDesc *bdesc, BrinValues *column, ScanKey *keys, int nkeys)

Returns whether all the ScanKey entries are consistent with the given indexed values for a range. The attribute number to use is passed as part of the scan key. Multiple scan keys for the same attribute may be passed at once; the number of entries is determined by the nkeys parameter.

bool consistent(BrinDesc *bdesc, BrinValues *column, ScanKey key)

Returns whether the ScanKey is consistent with the given indexed values for a range. The attribute number to use is passed as part of the scan key. This is an older backward-compatible variant of the consistent function.

bool addValue(BrinDesc *bdesc, BrinValues *column, Datum newval, bool isnull)

Given an index tuple and an indexed value, modifies the indicated attribute of the tuple so that it additionally represents the new value. If any modification was done to the tuple, true is returned.

bool unionTuples(BrinDesc *bdesc, BrinValues *a, BrinValues *b)

Consolidates two index tuples. Given two index tuples, modifies the indicated attribute of the first of them so that it represents both tuples. The second tuple is not modified.

An operator class for BRIN can optionally specify the following method:

void options(local_relopts *relopts)

Defines a set of user-visible parameters that control operator class behavior.

The options function is passed a pointer to a local_relopts struct, which needs to be filled with a set of operator class specific options. The options can be accessed from other support functions using the PG_HAS_OPCLASS_OPTIONS() and PG_GET_OPCLASS_OPTIONS() macros.

Since both key extraction of indexed values and representation of the key in BRIN are flexible, they may depend on user-specified parameters.

The core distribution includes support for four types of operator classes: minmax, minmax-multi, inclusion and bloom. Operator class definitions using them are shipped for in-core data types as appropriate. Additional operator classes can be defined by the user for other data types using equivalent definitions, without having to write any source code; appropriate catalog entries being declared is enough. Note that assumptions about the semantics of operator strategies are embedded in the support functions' source code.

Operator classes that implement completely different semantics are also possible, provided implementations of the four main support functions described above are written. Note that backwards compatibility across major releases is not guaranteed: for example, additional support functions might be required in later releases.

To write an operator class for a data type that implements a totally ordered set, it is possible to use the minmax support functions alongside the corresponding operators, as shown in Table 67.5. All operator class members (functions and operators) are mandatory.

Table 67.5. Function and Support Numbers for Minmax Operator Classes

Operator class member	Object
Support Function 1	internal function `brin_minmax_opcinfo()`
Support Function 2	internal function `brin_minmax_add_value()`
Support Function 3	internal function `brin_minmax_consistent()`
Support Function 4	internal function `brin_minmax_union()`
Operator Strategy 1	operator less-than
Operator Strategy 2	operator less-than-or-equal-to
Operator Strategy 3	operator equal-to
Operator Strategy 4	operator greater-than-or-equal-to
Operator Strategy 5	operator greater-than

To write an operator class for a complex data type which has values included within another type, it's possible to use the inclusion support functions alongside the corresponding operators, as shown in Table 67.6. It requires only a single additional function, which can be written in any language. More functions can be defined for additional functionality. All operators are optional. Some operators require other operators, as shown as dependencies on the table.

Table 67.6. Function and Support Numbers for Inclusion Operator Classes

Operator class member	Object	Dependency
Support Function 1	internal function `brin_inclusion_opcinfo()`
Support Function 2	internal function `brin_inclusion_add_value()`
Support Function 3	internal function `brin_inclusion_consistent()`
Support Function 4	internal function `brin_inclusion_union()`
Support Function 11	function to merge two elements
Support Function 12	optional function to check whether two elements are mergeable
Support Function 13	optional function to check if an element is contained within another
Support Function 14	optional function to check whether an element is empty
Operator Strategy 1	operator left-of	Operator Strategy 4
Operator Strategy 2	operator does-not-extend-to-the-right-of	Operator Strategy 5
Operator Strategy 3	operator overlaps
Operator Strategy 4	operator does-not-extend-to-the-left-of	Operator Strategy 1
Operator Strategy 5	operator right-of	Operator Strategy 2
Operator Strategy 6, 18	operator same-as-or-equal-to	Operator Strategy 7
Operator Strategy 7, 16, 24, 25	operator contains-or-equal-to
Operator Strategy 8, 26, 27	operator is-contained-by-or-equal-to	Operator Strategy 3
Operator Strategy 9	operator does-not-extend-above	Operator Strategy 11
Operator Strategy 10	operator is-below	Operator Strategy 12
Operator Strategy 11	operator is-above	Operator Strategy 9
Operator Strategy 12	operator does-not-extend-below	Operator Strategy 10
Operator Strategy 20	operator less-than	Operator Strategy 5
Operator Strategy 21	operator less-than-or-equal-to	Operator Strategy 5
Operator Strategy 22	operator greater-than	Operator Strategy 1
Operator Strategy 23	operator greater-than-or-equal-to	Operator Strategy 1

Support function numbers 1 through 10 are reserved for the BRIN internal functions, so the SQL level functions start with number 11. Support function number 11 is the main function required to build the index. It should accept two arguments with the same data type as the operator class, and return the union of them. The inclusion operator class can store union values with different data types if it is defined with the STORAGE parameter. The return value of the union function should match the STORAGE data type.

Support function numbers 12 and 14 are provided to support irregularities of built-in data types. Function number 12 is used to support network addresses from different families which are not mergeable. Function number 14 is used to support empty ranges. Function number 13 is an optional but recommended one, which allows the new value to be checked before it is passed to the union function. As the BRIN framework can shortcut some operations when the union is not changed, using this function can improve index performance.

To write an operator class for a data type that implements only an equality operator and supports hashing, it is possible to use the bloom support procedures alongside the corresponding operators, as shown in Table 67.7. All operator class members (procedures and operators) are mandatory.

Table 67.7. Procedure and Support Numbers for Bloom Operator Classes

Operator class member	Object
Support Procedure 1	internal function `brin_bloom_opcinfo()`
Support Procedure 2	internal function `brin_bloom_add_value()`
Support Procedure 3	internal function `brin_bloom_consistent()`
Support Procedure 4	internal function `brin_bloom_union()`
Support Procedure 5	internal function `brin_bloom_options()`
Support Procedure 11	function to compute hash of an element
Operator Strategy 1	operator equal-to

Support procedure numbers 1-10 are reserved for the BRIN internal functions, so the SQL level functions start with number 11. Support function number 11 is the main function required to build the index. It should accept one argument with the same data type as the operator class, and return a hash of the value.

The minmax-multi operator class is also intended for data types implementing a totally ordered set, and may be seen as a simple extension of the minmax operator class. While minmax operator class summarizes values from each block range into a single contiguous interval, minmax-multi allows summarization into multiple smaller intervals to improve handling of outlier values. It is possible to use the minmax-multi support procedures alongside the corresponding operators, as shown in Table 67.8. All operator class members (procedures and operators) are mandatory.

Table 67.8. Procedure and Support Numbers for minmax-multi Operator Classes

Operator class member	Object
Support Procedure 1	internal function `brin_minmax_multi_opcinfo()`
Support Procedure 2	internal function `brin_minmax_multi_add_value()`
Support Procedure 3	internal function `brin_minmax_multi_consistent()`
Support Procedure 4	internal function `brin_minmax_multi_union()`
Support Procedure 5	internal function `brin_minmax_multi_options()`
Support Procedure 11	function to compute distance between two values (length of a range)
Operator Strategy 1	operator less-than
Operator Strategy 2	operator less-than-or-equal-to
Operator Strategy 3	operator equal-to
Operator Strategy 4	operator greater-than-or-equal-to
Operator Strategy 5	operator greater-than

Both minmax and inclusion operator classes support cross-data-type operators, though with these the dependencies become more complicated. The minmax operator class requires a full set of operators to be defined with both arguments having the same data type. It allows additional data types to be supported by defining extra sets of operators. Inclusion operator class operator strategies are dependent on another operator strategy as shown in Table 67.6, or the same operator strategy as themselves. They require the dependency operator to be defined with the STORAGE data type as the left-hand-side argument and the other supported data type to be the right-hand-side argument of the supported operator. See float4_minmax_ops as an example of minmax, and box_inclusion_ops as an example of inclusion.

Prev	Up	Next
67.4. GIN Indexes	Home	67.6. Hash Indexes