Movatterモバイル変換

62.5.1. Introduction

62.5.2. Built-in Operator Classes

62.5.3. Extensibility

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 ofblock 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 isconsistent 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 aBRIN 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 aBRIN 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 thepages_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 forpages_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.

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

The corePostgres Pro distribution includes theBRIN operator classes shown inTable 62.4.

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

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

All it takes to get aBRIN 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 forBRIN must provide:

An operator class forBRIN can optionally specify the following method:

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 inTable 62.5. All operator class members (functions and operators) are mandatory.

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 inTable 62.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.

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 theSTORAGE parameter. The return value of the union function should match theSTORAGE 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 inTable 62.7. All operator class members (procedures and operators) are mandatory.

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 inTable 62.8. All operator class members (procedures and operators) are mandatory.

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 inTable 62.6, or the same operator strategy as themselves. They require the dependency operator to be defined with theSTORAGE 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. Seefloat4_minmax_ops as an example of minmax, andbox_inclusion_ops as an example of inclusion.