You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by "bereng (via GitHub)" <gi...@apache.org> on 2023/08/24 09:22:27 UTC
[GitHub] [cassandra] bereng opened a new pull request, #2628: Javadoc BigFormat
bereng opened a new pull request, #2628:
URL: https://github.com/apache/cassandra/pull/2628
Thanks for sending a pull request! Here are some tips if you're new here:
* Ensure you have added or run the [appropriate tests](https://cassandra.apache.org/_/development/testing.html) for your PR.
* Be sure to keep the PR description updated to reflect all changes.
* Write your PR title to summarize what this PR proposes.
* If possible, provide a concise example to reproduce the issue for a faster review.
* Read our [contributor guidelines](https://cassandra.apache.org/_/development/index.html)
* If you're making a documentation change, see our [guide to documentation contribution](https://cassandra.apache.org/_/development/documentation.html)
Commit messages should follow the following format:
```
<One sentence description, usually Jira title or CHANGES.txt summary>
<Optional lengthier description (context on patch)>
patch by <Authors>; reviewed by <Reviewers> for CASSANDRA-#####
Co-authored-by: Name1 <email1>
Co-authored-by: Name2 <email2>
```
The [Cassandra Jira](https://issues.apache.org/jira/projects/CASSANDRA/issues/)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "bereng (via GitHub)" <gi...@apache.org>.
bereng commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331111792
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
Review Comment:
I wanted to say 'a' not 'the' :shrug:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331028713
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
Review Comment:
can we use full for of this? - `approximate`? Later you have word "approximately".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "bereng (via GitHub)" <gi...@apache.org>.
bereng commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331111035
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
Review Comment:
Done
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.indexsummary.IndexSummary}
+ * <br>
+ * {@link IndexSummaryComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#PRIMARY_INDEX}: We'll land here in the approximate area where to look for the PK thanks to the Summary. Now we'll search for
+ * the exact PK to get it's exact position in the data file.
+ * <p></p>
+ * {@link BigTableWriter#indexWriter}
+ * <br>
+ * {@link RowIndexEntry}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.IndexInfo}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.IndexComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DATA}: The actual data/partitions file as an array or partitions. Each partition has the form:
+ * <ul>
+ * <li>A partition header</li>
+ * <li>Maybe a static row</li>
+ * <li>Rows or range tombstone</li>
+ * </ul>
+ * I.e. upon flush {@link Flushing.FlushRunnable#writeSortedContents()}
+ * <br>
+ * Down to {@link org.apache.cassandra.io.sstable.format.SortedTableWriter#startPartition}
+ * <br>
+ * Down to {@link org.apache.cassandra.io.sstable.format.SortedTablePartitionWriter#start}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.DataComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#STATS}: Stats on the data such as min timestamps to later vint encode TTL, markForDeleteAt, etc
+ * <p></p>
+ * {@link org.apache.cassandra.db.rows.EncodingStats}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.StatsComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#COMPRESSION_INFO}: Contains compresion metadata
+ * <p></p>
+ * {@link org.apache.cassandra.io.compress.CompressedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.compress.CompressionMetadata}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.CompressionInfoComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DIGEST}: The digest supporting the compression
+ * <p></p>
+ * {@link org.apache.cassandra.io.compress.CompressedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.util.ChecksumWriter}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#FILTER}: Bloom filter for data files
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.format.FilterComponent}
+ * <br>
+ * {@link org.apache.cassandra.utils.BloomFilterSerializer}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#CRC}: CRC for the data
+ * <p></p>
+ * {@link org.apache.cassandra.io.util.ChecksummedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.util.ChecksumWriter}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#TOC}: List of all the components for the sstable
Review Comment:
Done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng closed pull request #2628: Javadoc BigFormat
Posted by "bereng (via GitHub)" <gi...@apache.org>.
bereng closed pull request #2628: Javadoc BigFormat
URL: https://github.com/apache/cassandra/pull/2628
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331028938
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
Review Comment:
can we use full for of this? - `approximate`? Later you have word "approximation".
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
Review Comment:
can we use full for of this? - `approximate`? Later you have word "approximation".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331028713
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
Review Comment:
can we use full for of this? - `approximate`? Later you have word "approximation".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] bereng commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "bereng (via GitHub)" <gi...@apache.org>.
bereng commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331260606
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approximate lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.indexsummary.IndexSummary}
+ * <br>
+ * {@link IndexSummaryComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#PRIMARY_INDEX}: We'll land here in the approximate area where to look for the PK thanks to the Summary. Now we'll search for
+ * the exact PK to get it's exact position in the data file.
+ * <p></p>
+ * {@link BigTableWriter#indexWriter}
+ * <br>
+ * {@link RowIndexEntry}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.IndexInfo}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.IndexComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DATA}: The actual data/partitions file as an array or partitions. Each partition has the form:
+ * <ul>
+ * <li>A partition header</li>
+ * <li>Maybe a static row</li>
+ * <li>Rows or range tombstone</li>
+ * </ul>
+ * I.e. upon flush {@link Flushing.FlushRunnable#writeSortedContents()}
Review Comment:
Done
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331029873
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.indexsummary.IndexSummary}
+ * <br>
+ * {@link IndexSummaryComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#PRIMARY_INDEX}: We'll land here in the approximate area where to look for the PK thanks to the Summary. Now we'll search for
+ * the exact PK to get it's exact position in the data file.
+ * <p></p>
+ * {@link BigTableWriter#indexWriter}
+ * <br>
+ * {@link RowIndexEntry}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.IndexInfo}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.IndexComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DATA}: The actual data/partitions file as an array or partitions. Each partition has the form:
+ * <ul>
+ * <li>A partition header</li>
+ * <li>Maybe a static row</li>
+ * <li>Rows or range tombstone</li>
+ * </ul>
+ * I.e. upon flush {@link Flushing.FlushRunnable#writeSortedContents()}
+ * <br>
+ * Down to {@link org.apache.cassandra.io.sstable.format.SortedTableWriter#startPartition}
+ * <br>
+ * Down to {@link org.apache.cassandra.io.sstable.format.SortedTablePartitionWriter#start}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.DataComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#STATS}: Stats on the data such as min timestamps to later vint encode TTL, markForDeleteAt, etc
+ * <p></p>
+ * {@link org.apache.cassandra.db.rows.EncodingStats}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.StatsComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#COMPRESSION_INFO}: Contains compresion metadata
+ * <p></p>
+ * {@link org.apache.cassandra.io.compress.CompressedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.compress.CompressionMetadata}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.CompressionInfoComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DIGEST}: The digest supporting the compression
+ * <p></p>
+ * {@link org.apache.cassandra.io.compress.CompressedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.util.ChecksumWriter}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#FILTER}: Bloom filter for data files
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.format.FilterComponent}
+ * <br>
+ * {@link org.apache.cassandra.utils.BloomFilterSerializer}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#CRC}: CRC for the data
+ * <p></p>
+ * {@link org.apache.cassandra.io.util.ChecksummedSequentialWriter}
+ * <br>
+ * {@link org.apache.cassandra.io.util.ChecksumWriter}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#TOC}: List of all the components for the sstable
Review Comment:
Should not be "SSTable" ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331215819
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
Review Comment:
ok
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331216948
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approximate lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.indexsummary.IndexSummary}
+ * <br>
+ * {@link IndexSummaryComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#PRIMARY_INDEX}: We'll land here in the approximate area where to look for the PK thanks to the Summary. Now we'll search for
+ * the exact PK to get it's exact position in the data file.
+ * <p></p>
+ * {@link BigTableWriter#indexWriter}
+ * <br>
+ * {@link RowIndexEntry}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.IndexInfo}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.IndexComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DATA}: The actual data/partitions file as an array or partitions. Each partition has the form:
+ * <ul>
+ * <li>A partition header</li>
+ * <li>Maybe a static row</li>
+ * <li>Rows or range tombstone</li>
+ * </ul>
+ * I.e. upon flush {@link Flushing.FlushRunnable#writeSortedContents()}
Review Comment:
this has braces `()` but other links point to methods do no have it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331028298
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approx lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
Review Comment:
`for the first` probably? I am not a native speaker though.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2628: Javadoc BigFormat
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2628:
URL: https://github.com/apache/cassandra/pull/2628#discussion_r1331216948
##########
src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java:
##########
@@ -66,7 +67,99 @@
import static org.apache.cassandra.io.sstable.format.SSTableFormat.Components.DATA;
/**
- * Legacy bigtable format
+ * Legacy bigtable format. Components and approximate lifecycle:
+ * <br>
+ * {@link SSTableFormat.Components}
+ * <br>
+ * {@link Components#ALL_COMPONENTS}
+ * <ul>
+ * <li>
+ * {@link Components#SUMMARY}: When searching for a PK we go here for a first approximation on where to look in the index file. It is
+ * a small sampling of the Index entries intended for a first fast search in-memory.
+ * <p></p>
+ * {@link org.apache.cassandra.io.sstable.indexsummary.IndexSummary}
+ * <br>
+ * {@link IndexSummaryComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#PRIMARY_INDEX}: We'll land here in the approximate area where to look for the PK thanks to the Summary. Now we'll search for
+ * the exact PK to get it's exact position in the data file.
+ * <p></p>
+ * {@link BigTableWriter#indexWriter}
+ * <br>
+ * {@link RowIndexEntry}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.IndexInfo}
+ * <br>
+ * {@link org.apache.cassandra.io.sstable.format.IndexComponent}
+ * <p></p>
+ * </li>
+ * <li>
+ * {@link Components#DATA}: The actual data/partitions file as an array or partitions. Each partition has the form:
+ * <ul>
+ * <li>A partition header</li>
+ * <li>Maybe a static row</li>
+ * <li>Rows or range tombstone</li>
+ * </ul>
+ * I.e. upon flush {@link Flushing.FlushRunnable#writeSortedContents()}
Review Comment:
this has braces `()` but other links pointing to methods do no have it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org