Wiki / Operator Families / BRIN classes
brin/range_inclusion_ops (class)
BRIN operator class for anyrange; member of range_inclusion_ops.
Reading PostgreSQL 18.6.
Description
BRIN operator class for anyrange; member of range_inclusion_ops.
- Object kind
- Operator class
- Index AM
- BRIN
- Input type
- anyrange
- Stored key type
- anyrange
- Default class
- yes
Usage
brin/range_inclusion_opsOperator classes and families
An index definition can specify an operator class for each column of an index.
The operator class identifies the operators to be used by the index for that column. For example, a B-tree index on the type int4 would use the int4_ops class; this operator class includes comparison functions for values of type int4 . In practice the default operator class for the column's data type is usually sufficient. The main reason for having operator classes is that for some data types, there could be more than one meaningful index behavior. For example, we might want to sort a complex-number data type either by absolute value or by real part. We could do this by defining two operator classes for the data type and then selecting the proper class when making an index. The operator class determines the basic sort ordering (which can then be modified by adding sort options COLLATE , ASC / DESC and/or NULLS FIRST / NULLS LAST ).
There are also some built-in operator classes besides the default ones:
Family operator strategies
| Operator overload | Strategy | Purpose | Ordering family | Membership scope | Source description |
|---|---|---|---|---|---|
| <<(anyrange,anyrange) | 1 | search | Class input pair | is left of | |
| &<(anyrange,anyrange) | 2 | search | Class input pair | overlaps or is left of | |
| &&(anyrange,anyrange) | 3 | search | Class input pair | overlaps | |
| &>(anyrange,anyrange) | 4 | search | Class input pair | overlaps or is right of | |
| >>(anyrange,anyrange) | 5 | search | Class input pair | is right of | |
| @>(anyrange,anyrange) | 7 | search | Class input pair | contains | |
| <@(anyrange,anyrange) | 8 | search | Class input pair | is contained by | |
| @>(anyrange,anyelement) | 16 | search | Family member | contains | |
| -|-(anyrange,anyrange) | 17 | search | Class input pair | is adjacent to | |
| =(anyrange,anyrange) | 18 | search | Class input pair | equal | |
| <(anyrange,anyrange) | 20 | search | Class input pair | less than | |
| <=(anyrange,anyrange) | 21 | search | Class input pair | less than or equal | |
| >(anyrange,anyrange) | 22 | search | Class input pair | greater than | |
| >=(anyrange,anyrange) | 23 | search | Class input pair | greater than or equal |
Family support functions
| Support number | Left type | Right type | Function signature | Result type |
|---|---|---|---|---|
| 1 | anyrange | anyrange | brin_inclusion_opcinfo(internal) | internal |
| 2 | anyrange | anyrange | brin_inclusion_add_value(internal,internal,internal,internal) | bool |
| 3 | anyrange | anyrange | brin_inclusion_consistent(internal,internal,internal) | bool |
| 4 | anyrange | anyrange | brin_inclusion_union(internal,internal,internal) | bool |
| 11 | anyrange | anyrange | range_merge(anyrange,anyrange) | anyrange |
| 13 | anyrange | anyrange | range_contains(anyrange,anyrange) | bool |
| 14 | anyrange | anyrange | isempty(anyrange) | bool |
Classes in this family
| Class | Input type | Key type | Default |
|---|---|---|---|
| range_inclusion_ops | anyrange | anyrange | yes |
Related entries
Documentation and source
- Matching PostgreSQL source archive
- PostgreSQL 18 English manual: indexes-opclass.html
- PostgreSQL 18 English manual: catalog-pg-opclass.html
- PostgreSQL 18 English manual: catalog-pg-amop.html
- PostgreSQL 18 English manual: catalog-pg-amproc.html
Source build
- Version
- 18.6
- Build
- https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
- Source fingerprint
555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f
Compare versions
PostgreSQL 17 → 18: unchanged.
Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.
Related entries
brin/bit_minmax_ops (class)brin/box_inclusion_ops (class)brin/bpchar_bloom_ops (class)brin/bpchar_minmax_ops (class)brin/bytea_bloom_ops (class)brin/bytea_minmax_ops (class)brin/char_bloom_ops (class)brin/char_minmax_ops (class)brin/date_bloom_ops (class)brin/date_minmax_multi_ops (class)brin/date_minmax_ops (class)brin/float4_bloom_ops (class)
Export JSON · Back to Operator Families · Recorded in PostgreSQL 10 through 20; the first sample is not necessarily its introduction.