67.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 key)

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

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

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

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

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

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

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

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

Таблица 67.2. Номера стратегий и опорных функций для классов операторов 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.3. Для этого требуется одна дополнительная функция, которую можно написать на любом языке. Для расширенной функциональности можно определить другие функции. Все операторы являются необязательными. Некоторые из них требует наличия других, что показано в таблице как зависимости.

Таблица 67.3. Номера стратегий и опорных функций для классов операторов 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, 13, 16, 24, 25оператор содержит-или-равно 
Стратегия оператора 8, 14, 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 может соптимизировать некоторые операции, когда объединение не меняется, поэтому применение этой функции может способствовать увеличению быстродействия индекса.

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