You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by GitBox <gi...@apache.org> on 2020/09/02 21:24:51 UTC

[GitHub] [avro] krishnan1985 opened a new pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

krishnan1985 opened a new pull request #954:
URL: https://github.com/apache/avro/pull/954


   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ Yes ] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
     - https://issues.apache.org/jira/browse/AVRO-XXX
     - In case you are adding a dependency, check if the license complies with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
   
   ### Tests
   
   - [ Yes ] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   A new test has been added for all three codec types: DataFileTests::testLastSync
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ Yes ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain Javadoc that explain what it does
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] krishnan1985 commented on a change in pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
krishnan1985 commented on a change in pull request #954:
URL: https://github.com/apache/avro/pull/954#discussion_r497069416



##########
File path: lang/c++/api/DataFile.hh
##########
@@ -102,6 +103,11 @@ public:
      */
     void syncIfNeeded();
 
+    /**
+     * Returns offset to the last sync marker written.
+     */
+    uint64_t getLastSync();

Review comment:
       I like your suggestion. I will make the change.
   
   However, I chose this name since it matched with the terminology used in DataFileReader. DataFileReader already exposes the following: pastSync(), previousSync(), etc. which denote the same. Should we rationalize these APIs as well in a future change?

##########
File path: lang/c++/api/DataFile.hh
##########
@@ -102,6 +103,11 @@ public:
      */
     void syncIfNeeded();
 
+    /**
+     * Returns offset to the last sync marker written.
+     */
+    uint64_t getLastSync();

Review comment:
       Thanks, Thiru! I like your suggestion. I will make the change.
   
   However, I chose this name since it matched with the terminology used in DataFileReader. DataFileReader already exposes the following: pastSync(), previousSync(), etc. which denote the same. Should we rationalize these APIs as well in a future change?




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] krishnan1985 edited a comment on pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
krishnan1985 edited a comment on pull request #954:
URL: https://github.com/apache/avro/pull/954#issuecomment-686692523






----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] krishnan1985 commented on pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
krishnan1985 commented on pull request #954:
URL: https://github.com/apache/avro/pull/954#issuecomment-686692523


   I'm unable to request specific reviewers from github. Requesting review from @thiru-mg from a comment instead.


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] thiru-mg commented on a change in pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
thiru-mg commented on a change in pull request #954:
URL: https://github.com/apache/avro/pull/954#discussion_r496440539



##########
File path: lang/c++/api/DataFile.hh
##########
@@ -102,6 +103,11 @@ public:
      */
     void syncIfNeeded();
 
+    /**
+     * Returns offset to the last sync marker written.
+     */
+    uint64_t getLastSync();

Review comment:
       I think the name is bit ambiguous, it could mean either the beginning of the sync marker or the end of the sync marker. I think `currentBlockStart()` or something like it. The comment could read:
   
        Returns the byte offset (within the current file) of the start of the current block being written.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] krishnan1985 edited a comment on pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
krishnan1985 edited a comment on pull request #954:
URL: https://github.com/apache/avro/pull/954#issuecomment-686692523


   I'm unable to request specific reviewers from github. Hoping to get attention of @thiru-mg / @Fokko (based on previous C++ reviews in Avro). #Closed


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] thiru-mg commented on a change in pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
thiru-mg commented on a change in pull request #954:
URL: https://github.com/apache/avro/pull/954#discussion_r496440539



##########
File path: lang/c++/api/DataFile.hh
##########
@@ -102,6 +103,11 @@ public:
      */
     void syncIfNeeded();
 
+    /**
+     * Returns offset to the last sync marker written.
+     */
+    uint64_t getLastSync();

Review comment:
       I think the name is bit ambiguous, it could mean either the beginning of the sync marker or the end of the sync marker. I think `currentBlockStart()` or something like it would be a better choice. The comment could read:
   
        Returns the byte offset (within the current file) of the start of the current block being written.




----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [avro] thiru-mg merged pull request #954: AVRO-2891: Expose last sync offset written on DataFileWriter

Posted by GitBox <gi...@apache.org>.
thiru-mg merged pull request #954:
URL: https://github.com/apache/avro/pull/954


   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org