mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2025-01-18 18:44:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

C comments: improve description of GiST NSN and GistBuildLSN

Browse Source 
GiST indexes are complex, so adding more details in the code might help
someone.

Discussion: https://postgr.es/m/20210302164021.GA364@momjian.us
This commit is contained in:
Bruce Momjian 2021-03-10 17:03:10 -05:00
parent d87251048a
commit 845ac7f847
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/backend/access/gist/README
View File

@ -10,6 +10,7 @@ GiST stands for Generalized Search Tree. It was introduced in the seminal paper
Jeffrey F. Naughton, Avi Pfeffer:
http://www.sai.msu.su/~megera/postgres/gist/papers/gist.ps
https://dsf.berkeley.edu/papers/sigmod97-gist.pdf
and implemented by J. Hellerstein and P. Aoki in an early version of
PostgreSQL (more details are available from The GiST Indexing Project

15
src/include/access/gist.h
View File

@ -51,13 +51,20 @@
#define F_HAS_GARBAGE (1 << 4) /* some tuples on the page are dead,
* but not deleted yet */
/* NSN - node sequence number, a special-purpose LSN */
/*
* NSN (node sequence number) is a special-purpose LSN which is stored on each
* index page in GISTPageOpaqueData and updated only during page splits. By
* recording the parent's LSN in GISTSearchItem.parentlsn, it is possible to
* detect concurrent child page splits by checking if parentlsn < child's NSN,
* and handle them properly. The child page's LSN is insufficient for this
* purpose since it is updated for every page change.
*/
typedef XLogRecPtr GistNSN;
/*
* A bogus LSN / NSN value used during index build. Must be smaller than any
* real or fake unlogged LSN, so that after an index build finishes, all the
* splits are considered completed.
* A fake LSN / NSN value used during index builds. Must be smaller than any
* real or fake (unlogged) LSN generated after the index build completes so
* that all splits are considered complete.
*/
#define GistBuildLSN ((XLogRecPtr) 1)