diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-16 19:46:48 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-16 19:46:48 +0000 |
| commit | 311bcfc6b3acdd6fd152798c7f287ddf74fa2a98 (patch) | |
| tree | 0ec307299b1dada3701e42f4ca6eda57d708261e /doc/src/sgml/html/spgist-implementation.html | |
| parent | Initial commit. (diff) | |
| download | postgresql-15-311bcfc6b3acdd6fd152798c7f287ddf74fa2a98.tar.xz postgresql-15-311bcfc6b3acdd6fd152798c7f287ddf74fa2a98.zip | |
Adding upstream version 15.4.upstream/15.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/html/spgist-implementation.html')
| -rw-r--r-- | doc/src/sgml/html/spgist-implementation.html | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/src/sgml/html/spgist-implementation.html b/doc/src/sgml/html/spgist-implementation.html new file mode 100644 index 0000000..103fb6a --- /dev/null +++ b/doc/src/sgml/html/spgist-implementation.html @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>69.4. Implementation</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="spgist-extensibility.html" title="69.3. Extensibility" /><link rel="next" href="spgist-examples.html" title="69.5. Examples" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">69.4. Implementation</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="spgist-extensibility.html" title="69.3. Extensibility">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="spgist.html" title="Chapter 69. SP-GiST Indexes">Up</a></td><th width="60%" align="center">Chapter 69. SP-GiST Indexes</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 15.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="spgist-examples.html" title="69.5. Examples">Next</a></td></tr></table><hr /></div><div class="sect1" id="SPGIST-IMPLEMENTATION"><div class="titlepage"><div><div><h2 class="title" style="clear: both">69.4. Implementation</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="spgist-implementation.html#SPGIST-LIMITS">69.4.1. SP-GiST Limits</a></span></dt><dt><span class="sect2"><a href="spgist-implementation.html#SPGIST-NULL-LABELS">69.4.2. SP-GiST Without Node Labels</a></span></dt><dt><span class="sect2"><a href="spgist-implementation.html#SPGIST-ALL-THE-SAME">69.4.3. <span class="quote">“<span class="quote">All-the-Same</span>”</span> Inner Tuples</a></span></dt></dl></div><p> + This section covers implementation details and other tricks that are + useful for implementers of <acronym class="acronym">SP-GiST</acronym> operator classes to + know. + </p><div class="sect2" id="SPGIST-LIMITS"><div class="titlepage"><div><div><h3 class="title">69.4.1. SP-GiST Limits</h3></div></div></div><p> + Individual leaf tuples and inner tuples must fit on a single index page + (8kB by default). Therefore, when indexing values of variable-length + data types, long values can only be supported by methods such as radix + trees, in which each level of the tree includes a prefix that is short + enough to fit on a page, and the final leaf level includes a suffix also + short enough to fit on a page. The operator class should set + <code class="structfield">longValuesOK</code> to true only if it is prepared to arrange for + this to happen. Otherwise, the <acronym class="acronym">SP-GiST</acronym> core will + reject any request to index a value that is too large to fit + on an index page. + </p><p> + Likewise, it is the operator class's responsibility that inner tuples + do not grow too large to fit on an index page; this limits the number + of child nodes that can be used in one inner tuple, as well as the + maximum size of a prefix value. + </p><p> + Another limitation is that when an inner tuple's node points to a set + of leaf tuples, those tuples must all be in the same index page. + (This is a design decision to reduce seeking and save space in the + links that chain such tuples together.) If the set of leaf tuples + grows too large for a page, a split is performed and an intermediate + inner tuple is inserted. For this to fix the problem, the new inner + tuple <span class="emphasis"><em>must</em></span> divide the set of leaf values into more than one + node group. If the operator class's <code class="function">picksplit</code> function + fails to do that, the <acronym class="acronym">SP-GiST</acronym> core resorts to + extraordinary measures described in <a class="xref" href="spgist-implementation.html#SPGIST-ALL-THE-SAME" title="69.4.3. “All-the-Same” Inner Tuples">Section 69.4.3</a>. + </p><p> + When <code class="structfield">longValuesOK</code> is true, it is expected + that successive levels of the <acronym class="acronym">SP-GiST</acronym> tree will + absorb more and more information into the prefixes and node labels of + the inner tuples, making the required leaf datum smaller and smaller, + so that eventually it will fit on a page. + To prevent bugs in operator classes from causing infinite insertion + loops, the <acronym class="acronym">SP-GiST</acronym> core will raise an error if the + leaf datum does not become any smaller within ten cycles + of <code class="function">choose</code> method calls. + </p></div><div class="sect2" id="SPGIST-NULL-LABELS"><div class="titlepage"><div><div><h3 class="title">69.4.2. SP-GiST Without Node Labels</h3></div></div></div><p> + Some tree algorithms use a fixed set of nodes for each inner tuple; + for example, in a quad-tree there are always exactly four nodes + corresponding to the four quadrants around the inner tuple's centroid + point. In such a case the code typically works with the nodes by + number, and there is no need for explicit node labels. To suppress + node labels (and thereby save some space), the <code class="function">picksplit</code> + function can return NULL for the <code class="structfield">nodeLabels</code> array, + and likewise the <code class="function">choose</code> function can return NULL for + the <code class="structfield">prefixNodeLabels</code> array during + a <code class="literal">spgSplitTuple</code> action. + This will in turn result in <code class="structfield">nodeLabels</code> being NULL during + subsequent calls to <code class="function">choose</code> and <code class="function">inner_consistent</code>. + In principle, node labels could be used for some inner tuples and omitted + for others in the same index. + </p><p> + When working with an inner tuple having unlabeled nodes, it is an error + for <code class="function">choose</code> to return <code class="literal">spgAddNode</code>, since the set + of nodes is supposed to be fixed in such cases. + </p></div><div class="sect2" id="SPGIST-ALL-THE-SAME"><div class="titlepage"><div><div><h3 class="title">69.4.3. <span class="quote">“<span class="quote">All-the-Same</span>”</span> Inner Tuples</h3></div></div></div><p> + The <acronym class="acronym">SP-GiST</acronym> core can override the results of the + operator class's <code class="function">picksplit</code> function when + <code class="function">picksplit</code> fails to divide the supplied leaf values into + at least two node categories. When this happens, the new inner tuple + is created with multiple nodes that each have the same label (if any) + that <code class="function">picksplit</code> gave to the one node it did use, and the + leaf values are divided at random among these equivalent nodes. + The <code class="literal">allTheSame</code> flag is set on the inner tuple to warn the + <code class="function">choose</code> and <code class="function">inner_consistent</code> functions that the + tuple does not have the node set that they might otherwise expect. + </p><p> + When dealing with an <code class="literal">allTheSame</code> tuple, a <code class="function">choose</code> + result of <code class="literal">spgMatchNode</code> is interpreted to mean that the new + value can be assigned to any of the equivalent nodes; the core code will + ignore the supplied <code class="structfield">nodeN</code> value and descend into one + of the nodes at random (so as to keep the tree balanced). It is an + error for <code class="function">choose</code> to return <code class="literal">spgAddNode</code>, since + that would make the nodes not all equivalent; the + <code class="literal">spgSplitTuple</code> action must be used if the value to be inserted + doesn't match the existing nodes. + </p><p> + When dealing with an <code class="literal">allTheSame</code> tuple, the + <code class="function">inner_consistent</code> function should return either all or none + of the nodes as targets for continuing the index search, since they are + all equivalent. This may or may not require any special-case code, + depending on how much the <code class="function">inner_consistent</code> function normally + assumes about the meaning of the nodes. + </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="spgist-extensibility.html" title="69.3. Extensibility">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="spgist.html" title="Chapter 69. SP-GiST Indexes">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="spgist-examples.html" title="69.5. Examples">Next</a></td></tr><tr><td width="40%" align="left" valign="top">69.3. Extensibility </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 15.4 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 69.5. Examples</td></tr></table></div></body></html>
\ No newline at end of file |