70.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 вместе с соответствующими операторами, как показано в Таблице 70.2. Все члены класса операторов (функции и операторы) являются обязательными.
Таблица 70.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 вместе с соответствующими операторами, как показано в Таблице 70.3. Для этого требуется одна дополнительная функция, которую можно написать на любом языке. Для расширенной функциональности можно определить другие функции. Все операторы являются необязательными. Некоторые из них требует наличия других, что показано в таблице как зависимости.
Таблица 70.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, 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 вместе с соответствующими операторами, как показано в Таблица 70.4. Все члены класса операторов (процедуры и операторы) являются обязательными.
Таблица 70.4. Номера стратегий и опорных процедур для классов операторов 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 вместе с соответствующими операторами, как показано в Таблица 70.5. Все члены класса операторов (процедуры и операторы) являются обязательными.
Таблица 70.5. Номера стратегий и опорных процедур для классов операторов 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 могут зависеть от других стратегий, как показано в Таблице 70.3, или от своих собственных стратегий. Для них требуется, чтобы был определён необходимый оператор с типом данных STORAGE для левого аргумента и другим поддерживаемым типом для правого аргумента реализуемого оператора. См. определение float4_minmax_ops в качестве примера для minmax и box_inclusion_ops в качестве примера для inclusion.