↑↓ select↵ open⌫ change scopeOpen full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Wiki / Operator Families

brin/box_inclusion_ops (class)

BRIN operator class for box; member of box_inclusion_ops.

Reading PG 18·Select a recorded version

Object kind
Operator class
Index AM
BRIN
Input type
box
Stored key type
box
Default class
yes
aliases
box_inclusion_ops, brin/box_inclusion_ops
classes
map[default:t family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops input_type:box key_type:box method:brin name:box_inclusion_ops slug:class-brin-box_inclusion_ops source_oid:]
signature
brin/box_inclusion_ops
source oid
Unknown

Definition PG 18

BRIN operator class for box; member of box_inclusion_ops.

Family operator strategies

Operator overloadStrategyPurposeOrdering familyMembership scopeSource description
<<(box,box)1searchClass input pairis left of
&<(box,box)2searchClass input pairoverlaps or is left of
&&(box,box)3searchClass input pairoverlaps
&>(box,box)4searchClass input pairoverlaps or is right of
>>(box,box)5searchClass input pairis right of
~=(box,box)6searchClass input pairsame as
@>(box,box)7searchClass input paircontains
<@(box,box)8searchClass input pairis contained by
&<|(box,box)9searchClass input pairoverlaps or is below
<<|(box,box)10searchClass input pairis below
|>>(box,box)11searchClass input pairis above
|&>(box,box)12searchClass input pairoverlaps or is above
@>(box,point)7searchFamily membercontains

Family support functions

Support numberLeft typeRight typeFunction signatureResult type
1boxboxbrin_inclusion_opcinfo(internal)internal
2boxboxbrin_inclusion_add_value(internal,internal,internal,internal)bool
3boxboxbrin_inclusion_consistent(internal,internal,internal)bool
4boxboxbrin_inclusion_union(internal,internal,internal)bool
11boxboxbound_box(box,box)box
13boxboxbox_contain(box,box)bool

Classes in this family

ClassInput typeKey typeDefault
box_inclusion_opsboxboxyes

Compare versions

Complete source facts

class

{"default":"t","family":"box_inclusion_ops","input_type":"box","key_type":"box","method":"brin","name":"box_inclusion_ops"}

operators

map[description:is left of family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:<<(box,box) operator_slug:op-3c3c-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:1], map[description:overlaps or is left of family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:&<(box,box) operator_slug:op-263c-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:2], map[description:overlaps family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:&&(box,box) operator_slug:op-2626-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:3], map[description:overlaps or is right of family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:&>(box,box) operator_slug:op-263e-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:4], map[description:is right of family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:>>(box,box) operator_slug:op-3e3e-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:5], map[description:same as family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:~=(box,box) operator_slug:op-7e3d-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:6], map[description:contains family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:@>(box,box) operator_slug:op-403e-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:7], map[description:is contained by family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:<@(box,box) operator_slug:op-3c40-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:8], map[description:overlaps or is below family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:&<|(box,box) operator_slug:op-263c7c-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:9], map[description:is below family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:<<|(box,box) operator_slug:op-3c3c7c-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:10], map[description:is above family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:|>>(box,box) operator_slug:op-7c3e3e-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:11], map[description:overlaps or is above family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:|&>(box,box) operator_slug:op-7c263e-box-box purpose:search result_type:bool right_type:box sort_family: sort_family_slug: strategy:12], map[description:contains family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops left_type:box method:brin operator:@>(box,point) operator_slug:op-403e-box-point purpose:search result_type:bool right_type:point sort_family: sort_family_slug: strategy:7]

support functions

map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:brin_inclusion_opcinfo(internal) left_type:box method:brin number:1 result_type:internal right_type:box], map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:brin_inclusion_add_value(internal,internal,internal,internal) left_type:box method:brin number:2 result_type:bool right_type:box], map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:brin_inclusion_consistent(internal,internal,internal) left_type:box method:brin number:3 result_type:bool right_type:box], map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:brin_inclusion_union(internal,internal,internal) left_type:box method:brin number:4 result_type:bool right_type:box], map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:bound_box(box,box) left_type:box method:brin number:11 result_type:box right_type:box], map[family:box_inclusion_ops family_slug:family-brin-box_inclusion_ops function:box_contain(box,box) left_type:box method:brin number:13 result_type:bool right_type:box]

Source references

Full definition and evidence JSON

Definition sources

center · PostgreSQL 18 · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f

Text language: en · 555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f