@@ -145,6 +145,7 @@ typedef struct spgConfigOut
145145{
146146 Oid prefixType; /* Data type of inner-tuple prefixes */
147147 Oid labelType; /* Data type of inner-tuple node labels */
148+ bool canReturnData; /* Opclass can reconstruct original data */
148149 bool longValuesOK; /* Opclass can cope with values > 1 page */
149150} spgConfigOut;
150151</programlisting>
@@ -159,6 +160,8 @@ typedef struct spgConfigOut
159160 <structfield>prefixType</> can be set to <literal>VOIDOID</>.
160161 Likewise, for operator classes that do not use node labels,
161162 <structfield>labelType</> can be set to <literal>VOIDOID</>.
163+ <structfield>canReturnData</> should be set true if the operator class
164+ is capable of reconstructing the originally-supplied index value.
162165 <structfield>longValuesOK</> should be set true only when the
163166 <structfield>attType</> is of variable length and the operator
164167 class is capable of segmenting long values by repeated suffixing
@@ -441,6 +444,7 @@ typedef struct spgInnerConsistentIn
441444
442445 Datum reconstructedValue; /* value reconstructed at parent */
443446 int level; /* current level (counting from zero) */
447+ bool returnData; /* original data must be returned? */
444448
445449 /* Data from current inner tuple */
446450 bool allTheSame; /* tuple is marked all-the-same? */
@@ -467,6 +471,9 @@ typedef struct spgInnerConsistentOut
467471 parent level.
468472 <structfield>level</> is the current inner tuple's level, starting at
469473 zero for the root level.
474+ <structfield>returnData</> is <literal>true</> if reconstructed data is
475+ required for this query; this will only be so if the
476+ <function>config</> function asserted <structfield>canReturnData</>.
470477 <structfield>allTheSame</> is true if the current inner tuple is
471478 marked <quote>all-the-same</>; in this case all the nodes have the
472479 same label (if any) and so either all or none of them match the query
@@ -525,12 +532,14 @@ typedef struct spgLeafConsistentIn
525532
526533 Datum reconstructedValue; /* value reconstructed at parent */
527534 int level; /* current level (counting from zero) */
535+ bool returnData; /* original data must be returned? */
528536
529537 Datum leafDatum; /* datum in leaf tuple */
530538} spgLeafConsistentIn;
531539
532540typedef struct spgLeafConsistentOut
533541{
542+ Datum leafValue; /* reconstructed original data, if any */
534543 bool recheck; /* set true if operator must be rechecked */
535544} spgLeafConsistentOut;
536545</programlisting>
@@ -543,13 +552,19 @@ typedef struct spgLeafConsistentOut
543552 parent level.
544553 <structfield>level</> is the current leaf tuple's level, starting at
545554 zero for the root level.
555+ <structfield>returnData</> is <literal>true</> if reconstructed data is
556+ required for this query; this will only be so if the
557+ <function>config</> function asserted <structfield>canReturnData</>.
546558 <structfield>leafDatum</> is the key value stored in the current
547559 leaf tuple.
548560 </para>
549561
550562 <para>
551563 The function must return <literal>true</> if the leaf tuple matches the
552564 query, or <literal>false</> if not. In the <literal>true</> case,
565+ if <structfield>returnData</> is <literal>true</> then
566+ <structfield>leafValue</> must be set to the value originally supplied
567+ to be indexed for this leaf tuple. Also,
553568 <structfield>recheck</> may be set to <literal>true</> if the match
554569 is uncertain and so the operator must be re-applied to the actual heap
555570 tuple to verify the match.
0 commit comments