Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf2e4038

Browse files
committed
Support for INCLUDE attributes in GiST indexes
Similarly to B-tree, GiST index access method gets support of INCLUDEattributes. These attributes aren't used for tree navigation and aren'tpresent in non-leaf pages. But they are present in leaf pages and can befetched during index-only scan.The point of having INCLUDE attributes in GiST indexes is slightly differentfrom the point of having them in B-tree. The main point of INCLUDE attributesin B-tree is to define UNIQUE constraint over part of attributes enabled forindex-only scan. In GiST the main point of INCLUDE attributes is to useindex-only scan for attributes, whose data types don't have GiST opclasses.Discussion:https://postgr.es/m/73A1A452-AD5F-40D4-BD61-978622FF75C1%40yandex-team.ruAuthor: Andrey Borodin, with small changes by meReviewed-by: Andreas Karlsson
1 parenta0b7626 commitf2e4038

File tree

16 files changed

+382
-48
lines changed

16 files changed

+382
-48
lines changed

‎doc/src/sgml/indices.sgml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1145,8 +1145,8 @@ CREATE UNIQUE INDEX tab_x_y ON tab(x) INCLUDE (y);
11451145
likely to not need to access the heap. If the heap tuple must be visited
11461146
anyway, it costs nothing more to get the column's value from there.
11471147
Other restrictions are that expressions are not currently supported as
1148-
included columns, and that only B-tree indexes currently support included
1149-
columns.
1148+
included columns, and that only B-treeand GiSTindexes currently support
1149+
includedcolumns.
11501150
</para>
11511151

11521152
<para>
@@ -1165,7 +1165,7 @@ CREATE INDEX tab_x_y ON tab(x, y);
11651165
enforce uniqueness on the key column(s). Also, explicitly marking
11661166
non-searchable columns as <literal>INCLUDE</literal> columns makes the
11671167
index slightly smaller, because such columns need not be stored in upper
1168-
B-tree levels.
1168+
tree levels.
11691169
</para>
11701170

11711171
<para>

‎doc/src/sgml/ref/create_index.sgml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,10 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
181181
</para>
182182

183183
<para>
184-
Currently,onlythe B-tree index accessmethod supports this feature.
185-
In B-tree indexes, the values of columns listed in the
186-
<literal>INCLUDE</literal> clause are included in leaf tuples which
187-
correspond to heap tuples, but are not included in upper-level
184+
Currently, the B-treeand the GiSTindex accessmethods supports this
185+
feature.In B-treeand the GiSTindexes, the values of columns listed
186+
in the<literal>INCLUDE</literal> clause are included in leaf tuples
187+
whichcorrespond to heap tuples, but are not included in upper-level
188188
index entries used for tree navigation.
189189
</para>
190190
</listitem>

‎doc/src/sgml/textsearch.sgml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3674,6 +3674,12 @@ SELECT plainto_tsquery('supernovae stars');
36743674
retrieved to see if the match is correct.
36753675
</para>
36763676

3677+
<para>
3678+
A GiST index can be covering, i.e. use the <literal>INCLUDE</literal>
3679+
clause. Included columns can have data types without any GiST operator
3680+
class. Included attributes will be stored uncompressed.
3681+
</para>
3682+
36773683
<para>
36783684
Lossiness causes performance degradation due to unnecessary fetches of table
36793685
records that turn out to be false matches. Since random access to table

‎src/backend/access/gist/gist.c‎

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ gisthandler(PG_FUNCTION_ARGS)
7575
amroutine->amclusterable= true;
7676
amroutine->ampredlocks= true;
7777
amroutine->amcanparallel= false;
78-
amroutine->amcaninclude=false;
78+
amroutine->amcaninclude=true;
7979
amroutine->amkeytype=InvalidOid;
8080

8181
amroutine->ambuild=gistbuild;
@@ -1382,8 +1382,10 @@ gistSplit(Relation r,
13821382
IndexTupleSize(itup[0]),GiSTPageSize,
13831383
RelationGetRelationName(r))));
13841384

1385-
memset(v.spl_lisnull, true,sizeof(bool)*giststate->tupdesc->natts);
1386-
memset(v.spl_risnull, true,sizeof(bool)*giststate->tupdesc->natts);
1385+
memset(v.spl_lisnull, true,
1386+
sizeof(bool)*giststate->nonLeafTupdesc->natts);
1387+
memset(v.spl_risnull, true,
1388+
sizeof(bool)*giststate->nonLeafTupdesc->natts);
13871389
gistSplitByKey(r,page,itup,len,giststate,&v,0);
13881390

13891391
/* form left and right vector */
@@ -1461,9 +1463,23 @@ initGISTstate(Relation index)
14611463

14621464
giststate->scanCxt=scanCxt;
14631465
giststate->tempCxt=scanCxt;/* caller must change this if needed */
1464-
giststate->tupdesc=index->rd_att;
1466+
giststate->leafTupdesc=index->rd_att;
14651467

1466-
for (i=0;i<index->rd_att->natts;i++)
1468+
/*
1469+
* The truncated tupdesc for non-leaf index tuples, which doesn't contain
1470+
* the INCLUDE attributes.
1471+
*
1472+
* It is used to form tuples during tuple adjustement and page split.
1473+
* B-tree creates shortened tuple descriptor for every truncated tuple,
1474+
* because it is doing this less often: it does not have to form truncated
1475+
* tuples during page split. Also, B-tree is not adjusting tuples on
1476+
* internal pages the way GiST does.
1477+
*/
1478+
giststate->nonLeafTupdesc=CreateTupleDescCopyConstr(index->rd_att);
1479+
giststate->nonLeafTupdesc->natts=
1480+
IndexRelationGetNumberOfKeyAttributes(index);
1481+
1482+
for (i=0;i<IndexRelationGetNumberOfKeyAttributes(index);i++)
14671483
{
14681484
fmgr_info_copy(&(giststate->consistentFn[i]),
14691485
index_getprocinfo(index,i+1,GIST_CONSISTENT_PROC),
@@ -1531,6 +1547,21 @@ initGISTstate(Relation index)
15311547
giststate->supportCollation[i]=DEFAULT_COLLATION_OID;
15321548
}
15331549

1550+
/* No opclass information for INCLUDE attributes */
1551+
for (;i<index->rd_att->natts;i++)
1552+
{
1553+
giststate->consistentFn[i].fn_oid=InvalidOid;
1554+
giststate->unionFn[i].fn_oid=InvalidOid;
1555+
giststate->compressFn[i].fn_oid=InvalidOid;
1556+
giststate->decompressFn[i].fn_oid=InvalidOid;
1557+
giststate->penaltyFn[i].fn_oid=InvalidOid;
1558+
giststate->picksplitFn[i].fn_oid=InvalidOid;
1559+
giststate->equalFn[i].fn_oid=InvalidOid;
1560+
giststate->distanceFn[i].fn_oid=InvalidOid;
1561+
giststate->fetchFn[i].fn_oid=InvalidOid;
1562+
giststate->supportCollation[i]=InvalidOid;
1563+
}
1564+
15341565
MemoryContextSwitchTo(oldCxt);
15351566

15361567
returngiststate;

‎src/backend/access/gist/gistget.c‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ gistindex_keytest(IndexScanDesc scan,
164164

165165
datum=index_getattr(tuple,
166166
key->sk_attno,
167-
giststate->tupdesc,
167+
giststate->leafTupdesc,
168168
&isNull);
169169

170170
if (key->sk_flags&SK_ISNULL)
@@ -244,7 +244,7 @@ gistindex_keytest(IndexScanDesc scan,
244244

245245
datum=index_getattr(tuple,
246246
key->sk_attno,
247-
giststate->tupdesc,
247+
giststate->leafTupdesc,
248248
&isNull);
249249

250250
if ((key->sk_flags&SK_ISNULL)||isNull)
@@ -769,11 +769,13 @@ gistgetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
769769
*
770770
* Opclasses that implement a fetch function support index-only scans.
771771
* Opclasses without compression functions also support index-only scans.
772+
* Included attributes always can be fetched for index-only scans.
772773
*/
773774
bool
774775
gistcanreturn(Relationindex,intattno)
775776
{
776-
if (OidIsValid(index_getprocid(index,attno,GIST_FETCH_PROC))||
777+
if (attno>IndexRelationGetNumberOfKeyAttributes(index)||
778+
OidIsValid(index_getprocid(index,attno,GIST_FETCH_PROC))||
777779
!OidIsValid(index_getprocid(index,attno,GIST_COMPRESS_PROC)))
778780
return true;
779781
else

‎src/backend/access/gist/gistscan.c‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ gistrescan(IndexScanDesc scan, ScanKey key, int nkeys,
158158
if (scan->xs_want_itup&& !scan->xs_hitupdesc)
159159
{
160160
intnatts;
161+
intnkeyatts;
161162
intattno;
162163

163164
/*
@@ -167,13 +168,23 @@ gistrescan(IndexScanDesc scan, ScanKey key, int nkeys,
167168
* types.
168169
*/
169170
natts=RelationGetNumberOfAttributes(scan->indexRelation);
171+
nkeyatts=IndexRelationGetNumberOfKeyAttributes(scan->indexRelation);
170172
so->giststate->fetchTupdesc=CreateTemplateTupleDesc(natts);
171-
for (attno=1;attno <=natts;attno++)
173+
for (attno=1;attno <=nkeyatts;attno++)
172174
{
173175
TupleDescInitEntry(so->giststate->fetchTupdesc,attno,NULL,
174176
scan->indexRelation->rd_opcintype[attno-1],
175177
-1,0);
176178
}
179+
180+
for (;attno <=natts;attno++)
181+
{
182+
/* taking opcintype from giststate->tupdesc */
183+
TupleDescInitEntry(so->giststate->fetchTupdesc,attno,NULL,
184+
TupleDescAttr(so->giststate->leafTupdesc,
185+
attno-1)->atttypid,
186+
-1,0);
187+
}
177188
scan->xs_hitupdesc=so->giststate->fetchTupdesc;
178189

179190
/* Also create a memory context that will hold the returned tuples */

‎src/backend/access/gist/gistsplit.c‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ placeOne(Relation r, GISTSTATE *giststate, GistSplitVector *v,
207207
gistDeCompressAtt(giststate,r,itup,NULL, (OffsetNumber)0,
208208
identry,isnull);
209209

210-
for (;attno<giststate->tupdesc->natts;attno++)
210+
for (;attno<giststate->nonLeafTupdesc->natts;attno++)
211211
{
212212
floatlpenalty,
213213
rpenalty;
@@ -485,7 +485,7 @@ gistUserPicksplit(Relation r, GistEntryVector *entryvec, int attno, GistSplitVec
485485
*/
486486
v->spl_dontcare=NULL;
487487

488-
if (attno+1<giststate->tupdesc->natts)
488+
if (attno+1<giststate->nonLeafTupdesc->natts)
489489
{
490490
intNumDontCare;
491491

@@ -639,7 +639,7 @@ gistSplitByKey(Relation r, Page page, IndexTuple *itup, int len,
639639
Datumdatum;
640640
boolIsNull;
641641

642-
datum=index_getattr(itup[i-1],attno+1,giststate->tupdesc,
642+
datum=index_getattr(itup[i-1],attno+1,giststate->leafTupdesc,
643643
&IsNull);
644644
gistdentryinit(giststate,attno,&(entryvec->vector[i]),
645645
datum,r,page,i,
@@ -657,7 +657,7 @@ gistSplitByKey(Relation r, Page page, IndexTuple *itup, int len,
657657
*/
658658
v->spl_risnull[attno]=v->spl_lisnull[attno]= true;
659659

660-
if (attno+1<giststate->tupdesc->natts)
660+
if (attno+1<giststate->nonLeafTupdesc->natts)
661661
gistSplitByKey(r,page,itup,len,giststate,v,attno+1);
662662
else
663663
gistSplitHalf(&v->splitVector,len);
@@ -683,7 +683,7 @@ gistSplitByKey(Relation r, Page page, IndexTuple *itup, int len,
683683
v->splitVector.spl_left[v->splitVector.spl_nleft++]=i;
684684

685685
/* Compute union keys, unless outer recursion level will handle it */
686-
if (attno==0&&giststate->tupdesc->natts==1)
686+
if (attno==0&&giststate->nonLeafTupdesc->natts==1)
687687
{
688688
v->spl_dontcare=NULL;
689689
gistunionsubkey(giststate,itup,v);
@@ -700,7 +700,7 @@ gistSplitByKey(Relation r, Page page, IndexTuple *itup, int len,
700700
* Splitting on attno column is not optimal, so consider
701701
* redistributing don't-care tuples according to the next column
702702
*/
703-
Assert(attno+1<giststate->tupdesc->natts);
703+
Assert(attno+1<giststate->nonLeafTupdesc->natts);
704704

705705
if (v->spl_dontcare==NULL)
706706
{
@@ -771,7 +771,7 @@ gistSplitByKey(Relation r, Page page, IndexTuple *itup, int len,
771771
* that PickSplit (or the special cases above) produced correct union
772772
* datums.
773773
*/
774-
if (attno==0&&giststate->tupdesc->natts>1)
774+
if (attno==0&&giststate->nonLeafTupdesc->natts>1)
775775
{
776776
v->spl_dontcare=NULL;
777777
gistunionsubkey(giststate,itup,v);

‎src/backend/access/gist/gistutil.c‎

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ gistMakeUnionItVec(GISTSTATE *giststate, IndexTuple *itvec, int len,
160160

161161
evec= (GistEntryVector*)palloc((len+2)*sizeof(GISTENTRY)+GEVHDRSZ);
162162

163-
for (i=0;i<giststate->tupdesc->natts;i++)
163+
for (i=0;i<giststate->nonLeafTupdesc->natts;i++)
164164
{
165165
intj;
166166

@@ -171,7 +171,8 @@ gistMakeUnionItVec(GISTSTATE *giststate, IndexTuple *itvec, int len,
171171
Datumdatum;
172172
boolIsNull;
173173

174-
datum=index_getattr(itvec[j],i+1,giststate->tupdesc,&IsNull);
174+
datum=index_getattr(itvec[j],i+1,giststate->leafTupdesc,
175+
&IsNull);
175176
if (IsNull)
176177
continue;
177178

@@ -296,11 +297,11 @@ gistDeCompressAtt(GISTSTATE *giststate, Relation r, IndexTuple tuple, Page p,
296297
{
297298
inti;
298299

299-
for (i=0;i<r->rd_att->natts;i++)
300+
for (i=0;i<IndexRelationGetNumberOfKeyAttributes(r);i++)
300301
{
301302
Datumdatum;
302303

303-
datum=index_getattr(tuple,i+1,giststate->tupdesc,&isnull[i]);
304+
datum=index_getattr(tuple,i+1,giststate->leafTupdesc,&isnull[i]);
304305
gistdentryinit(giststate,i,&attdata[i],
305306
datum,r,p,o,
306307
false,isnull[i]);
@@ -329,7 +330,7 @@ gistgetadjusted(Relation r, IndexTuple oldtup, IndexTuple addtup, GISTSTATE *gis
329330
gistDeCompressAtt(giststate,r,addtup,NULL,
330331
(OffsetNumber)0,addentries,addisnull);
331332

332-
for (i=0;i<r->rd_att->natts;i++)
333+
for (i=0;i<IndexRelationGetNumberOfKeyAttributes(r);i++)
333334
{
334335
gistMakeUnionKey(giststate,i,
335336
oldentries+i,oldisnull[i],
@@ -442,14 +443,15 @@ gistchoose(Relation r, Page p, IndexTuple it,/* it has compressed entry */
442443
zero_penalty= true;
443444

444445
/* Loop over index attributes. */
445-
for (j=0;j<r->rd_att->natts;j++)
446+
for (j=0;j<IndexRelationGetNumberOfKeyAttributes(r);j++)
446447
{
447448
Datumdatum;
448449
floatusize;
449450
boolIsNull;
450451

451452
/* Compute penalty for this column. */
452-
datum=index_getattr(itup,j+1,giststate->tupdesc,&IsNull);
453+
datum=index_getattr(itup,j+1,giststate->leafTupdesc,
454+
&IsNull);
453455
gistdentryinit(giststate,j,&entry,datum,r,p,i,
454456
false,IsNull);
455457
usize=gistpenalty(giststate,j,&entry,IsNull,
@@ -470,7 +472,7 @@ gistchoose(Relation r, Page p, IndexTuple it,/* it has compressed entry */
470472
result=i;
471473
best_penalty[j]=usize;
472474

473-
if (j<r->rd_att->natts-1)
475+
if (j<IndexRelationGetNumberOfKeyAttributes(r)-1)
474476
best_penalty[j+1]=-1;
475477

476478
/* we have new best, so reset keep-it decision */
@@ -500,7 +502,7 @@ gistchoose(Relation r, Page p, IndexTuple it,/* it has compressed entry */
500502
* If we looped past the last column, and did not update "result",
501503
* then this tuple is exactly as good as the prior best tuple.
502504
*/
503-
if (j==r->rd_att->natts&&result!=i)
505+
if (j==IndexRelationGetNumberOfKeyAttributes(r)&&result!=i)
504506
{
505507
if (keep_current_best==-1)
506508
{
@@ -579,7 +581,7 @@ gistFormTuple(GISTSTATE *giststate, Relation r,
579581
/*
580582
* Call the compress method on each attribute.
581583
*/
582-
for (i=0;i<r->rd_att->natts;i++)
584+
for (i=0;i<IndexRelationGetNumberOfKeyAttributes(r);i++)
583585
{
584586
if (isnull[i])
585587
compatt[i]= (Datum)0;
@@ -602,7 +604,23 @@ gistFormTuple(GISTSTATE *giststate, Relation r,
602604
}
603605
}
604606

605-
res=index_form_tuple(giststate->tupdesc,compatt,isnull);
607+
if (isleaf)
608+
{
609+
/*
610+
* Emplace each included attribute if any.
611+
*/
612+
for (;i<r->rd_att->natts;i++)
613+
{
614+
if (isnull[i])
615+
compatt[i]= (Datum)0;
616+
else
617+
compatt[i]=attdata[i];
618+
}
619+
}
620+
621+
res=index_form_tuple(isleaf ?giststate->leafTupdesc :
622+
giststate->nonLeafTupdesc,
623+
compatt,isnull);
606624

607625
/*
608626
* The offset number on tuples on internal pages is unused. For historical
@@ -644,11 +662,11 @@ gistFetchTuple(GISTSTATE *giststate, Relation r, IndexTuple tuple)
644662
boolisnull[INDEX_MAX_KEYS];
645663
inti;
646664

647-
for (i=0;i<r->rd_att->natts;i++)
665+
for (i=0;i<IndexRelationGetNumberOfKeyAttributes(r);i++)
648666
{
649667
Datumdatum;
650668

651-
datum=index_getattr(tuple,i+1,giststate->tupdesc,&isnull[i]);
669+
datum=index_getattr(tuple,i+1,giststate->leafTupdesc,&isnull[i]);
652670

653671
if (giststate->fetchFn[i].fn_oid!=InvalidOid)
654672
{
@@ -679,6 +697,15 @@ gistFetchTuple(GISTSTATE *giststate, Relation r, IndexTuple tuple)
679697
fetchatt[i]= (Datum)0;
680698
}
681699
}
700+
701+
/*
702+
* Get each included attribute.
703+
*/
704+
for (;i<r->rd_att->natts;i++)
705+
{
706+
fetchatt[i]=index_getattr(tuple,i+1,giststate->leafTupdesc,
707+
&isnull[i]);
708+
}
682709
MemoryContextSwitchTo(oldcxt);
683710

684711
returnheap_form_tuple(giststate->fetchTupdesc,fetchatt,isnull);

‎src/include/access/gist_private.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,9 @@ typedef struct GISTSTATE
7878
MemoryContextscanCxt;/* context for scan-lifespan data */
7979
MemoryContexttempCxt;/* short-term context for calling functions */
8080

81-
TupleDesctupdesc;/* index's tuple descriptor */
81+
TupleDescleafTupdesc;/* index's tuple descriptor */
82+
TupleDescnonLeafTupdesc;/* truncated tuple descriptor for non-leaf
83+
* pages */
8284
TupleDescfetchTupdesc;/* tuple descriptor for tuples returned in an
8385
* index-only scan */
8486

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp