You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by ad...@apache.org on 2021/06/14 16:47:32 UTC
svn commit: r1890775 - in
/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment:
overview.md records.md
Author: adulceanu
Date: Mon Jun 14 16:47:32 2021
New Revision: 1890775
URL: http://svn.apache.org/viewvc?rev=1890775&view=rev
Log:
OAK-9460 - Small documentation improvements for oak-segment-tar
Contribution by Aravindo Wingeier
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/overview.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/records.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/overview.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/overview.md?rev=1890775&r1=1890774&r2=1890775&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/overview.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/overview.md Mon Jun 14 16:47:32 2021
@@ -46,7 +46,7 @@ Oak Segment Tar is an Oak storage backen
* *Locality*. Segments are written so that related records, like a node and its immediate children, usually end up stored in the same segment. This makes tree traversals very fast and avoids most cache misses for typical clients that access more than one related node per session.
-The content tree and all its revisions are stored in a collection of immutable *records* within *segments*. Each segment is identified by a UUID and typically contains a continuous subset of the content tree, for example a node with its properties and closest child nodes. Some segments might also be used to store commonly occurring property values or other shared data. Segments can be to up to 256KiB in size. See [Segments and records](records.html) for a detailed description of the segments and records.
+The content tree and all its revisions are stored in a collection of immutable *records* within *segments*. Each segment is identified by a UUID and typically contains a continuous subset of the content tree, for example a node with its properties and closest child nodes. Some segments might also be used to store commonly occurring property values or other shared data. Segments can be up to 256KiB in size. See [Segments and records](records.html) for a detailed description of the segments and records.
Segments are collectively stored in *tar files* and check-summed to ensure their integrity. Tar files also contain an index of the tar segments, the graph of segment references of all segments it contains and an index of all external binaries referenced from the segments in the tar file. See [Structure of TAR files](tar.html) for details.
@@ -278,7 +278,7 @@ TarMK GC #2: compaction interrupted
##### <a name="how-does-compaction-deal-with-checkpoints"/> How does compaction deal with checkpoints?
-Since checkpoints share a lot of common data between themselves and between the actual content compaction handles them individually deduplicating as much content as possible. The following messages will be printed to the log during the process.
+Since checkpoints share a lot of common data between themselves and between the actual content, compaction handles them individually, deduplicating as much content as possible. The following messages will be printed to the log during the process.
```
TarMK GC #2: Found checkpoint 4b2ee46a-d7cf-45e7-93c3-799d538f85e6 created at Wed Nov 29 15:31:43 CET 2017.
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/records.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/records.md?rev=1890775&r1=1890774&r2=1890775&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/records.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/segment/records.md Mon Jun 14 16:47:32 2021
@@ -239,14 +239,14 @@ records to represent itself:
an integer field and a record identifier pointing to a bucket.
- +--------+--------+--------+-----+
- | sub-list ID 1 | ... |
- +--------+--------+--------+-----+
- |
- v
- +--------+--------+--------+-----+--------+--------+--------+
- | record ID 1 | ... | record ID 255 |
- +--------+--------+--------+-----+--------+--------+--------+
+ +--------+--------+--------+-----+
+ | sub-list ID 1 | ... |
+ +--------+--------+--------+-----+
+ |
+ v
+ +--------+--------+--------+-----+--------+--------+--------+
+ | record ID 1 | ... | record ID 255 |
+ +--------+--------+--------+-----+--------+--------+--------+
The result is a hierarchically stored immutable list where each element
can be accessed in O(log N) time and the size overhead of updating or