You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/11/09 17:22:34 UTC

[GitHub] [arrow-rs] alamb opened a new pull request, #3068: Minor: Improve docstrings on WriterPropertiesBuilder

alamb opened a new pull request, #3068:
URL: https://github.com/apache/arrow-rs/pull/3068

   # Which issue does this PR close?
   
   N/A
   # Rationale for this change
   
   Even though the docs did mention the fact that the limits were a function of the write batch size, I think both @Ted-Jiang and I missed the subtlety initially. See conversation on  https://github.com/apache/arrow-datafusion/pull/4131#discussion_r1016554574
   
   
   # What changes are included in this PR?
   Add some additional commentary on write batch size docs as well as backlinks from other limits
   
   # Are there any user-facing changes?
   Only docstrings


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] tustvold merged pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
tustvold merged PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] viirya commented on a diff in pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
viirya commented on code in PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#discussion_r1018243338


##########
parquet/src/file/properties.rs:
##########
@@ -306,38 +306,46 @@ impl WriterPropertiesBuilder {
         self
     }
 
-    /// Sets best effort maximum size of a data page in bytes
+    /// Sets best effort maximum size of a data page in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_pagesize_limit(mut self, value: usize) -> Self {
         self.data_pagesize_limit = value;
         self
     }
 
-    /// Sets best effort maximum number of rows in a data page
+    /// Sets best effort maximum number of rows in a data page.
     ///
     ///
     /// This can be used to limit the number of rows within a page to
-    /// yield better page pruning
+    /// yield better page pruning.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_page_row_count_limit(mut self, value: usize) -> Self {
         self.data_page_row_count_limit = value;
         self
     }
 
-    /// Sets best effort maximum dictionary page size, in bytes
+    /// Sets best effort maximum dictionary page size, in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_dictionary_pagesize_limit(mut self, value: usize) -> Self {
         self.dictionary_pagesize_limit = value;
         self
     }
 
-    /// Sets write batch size
+    /// Sets write batch size.
+    ///
+    /// For performance reasons, data for each column is written in

Review Comment:
   Verified it by looking at the related code and this is accurate.



-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] ursabot commented on pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
ursabot commented on PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#issuecomment-1309149648

   Benchmark runs are scheduled for baseline = 5a3ecc2ea270af7f9aba4c1a162072acf9541fb8 and contender = e4e15f8e7efc31db6469198852c3e7719577411d. e4e15f8e7efc31db6469198852c3e7719577411d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
   Conbench compare runs links:
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/81712e3607d84c0bb285bc9139be4a33...cdf330de8f854fd99d0aed806e5c908e/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on test-mac-arm] [test-mac-arm](https://conbench.ursa.dev/compare/runs/0f5c90ed5afe415ebb1a91ed415c49e5...e82d974e9495475daf147aef2994f6a3/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/d53d2dcca66f4338a528b68b56b9153f...b40b71dd886c48f2b95ecb2420e50e7a/)
   [Skipped :warning: Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/02b481d729584256a2f57ea4a8bf5ec2...4906a5c2b678483eb5f7eef1bf9dc4ad/)
   Buildkite builds:
   Supported benchmarks:
   ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
   test-mac-arm: Supported benchmark langs: C++, Python, R
   ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
   ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
   


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] Ted-Jiang commented on pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
Ted-Jiang commented on PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#issuecomment-1309688723

   @alamb Thanks 👍


-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] tustvold commented on a diff in pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
tustvold commented on code in PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#discussion_r1018237629


##########
parquet/src/file/properties.rs:
##########
@@ -306,38 +306,46 @@ impl WriterPropertiesBuilder {
         self
     }
 
-    /// Sets best effort maximum size of a data page in bytes
+    /// Sets best effort maximum size of a data page in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_pagesize_limit(mut self, value: usize) -> Self {
         self.data_pagesize_limit = value;
         self
     }
 
-    /// Sets best effort maximum number of rows in a data page
+    /// Sets best effort maximum number of rows in a data page.
     ///
     ///
     /// This can be used to limit the number of rows within a page to
-    /// yield better page pruning
+    /// yield better page pruning.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_page_row_count_limit(mut self, value: usize) -> Self {
         self.data_page_row_count_limit = value;
         self
     }
 
-    /// Sets best effort maximum dictionary page size, in bytes
+    /// Sets best effort maximum dictionary page size, in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_dictionary_pagesize_limit(mut self, value: usize) -> Self {
         self.dictionary_pagesize_limit = value;
         self
     }
 
-    /// Sets write batch size
+    /// Sets write batch size.
+    ///
+    /// For performance reasons, data for each column is written in

Review Comment:
   Its accurate



-- 
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: github-unsubscribe@arrow.apache.org

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


[GitHub] [arrow-rs] alamb commented on a diff in pull request #3068: Minor: Improve docstrings on WriterPropertiesBuilder

Posted by GitBox <gi...@apache.org>.
alamb commented on code in PR #3068:
URL: https://github.com/apache/arrow-rs/pull/3068#discussion_r1018220676


##########
parquet/src/file/properties.rs:
##########
@@ -306,38 +306,46 @@ impl WriterPropertiesBuilder {
         self
     }
 
-    /// Sets best effort maximum size of a data page in bytes
+    /// Sets best effort maximum size of a data page in bytes.

Review Comment:
   I added `.` as well to make the docstrings for these properties consistent with the others in this file 



##########
parquet/src/file/properties.rs:
##########
@@ -306,38 +306,46 @@ impl WriterPropertiesBuilder {
         self
     }
 
-    /// Sets best effort maximum size of a data page in bytes
+    /// Sets best effort maximum size of a data page in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_pagesize_limit(mut self, value: usize) -> Self {
         self.data_pagesize_limit = value;
         self
     }
 
-    /// Sets best effort maximum number of rows in a data page
+    /// Sets best effort maximum number of rows in a data page.
     ///
     ///
     /// This can be used to limit the number of rows within a page to
-    /// yield better page pruning
+    /// yield better page pruning.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_data_page_row_count_limit(mut self, value: usize) -> Self {
         self.data_page_row_count_limit = value;
         self
     }
 
-    /// Sets best effort maximum dictionary page size, in bytes
+    /// Sets best effort maximum dictionary page size, in bytes.
     ///
-    /// Note: this is a best effort limit based on the write batch size
+    /// Note: this is a best effort limit based on value of
+    /// [`set_write_batch_size`](Self::set_write_batch_size).
     pub fn set_dictionary_pagesize_limit(mut self, value: usize) -> Self {
         self.dictionary_pagesize_limit = value;
         self
     }
 
-    /// Sets write batch size
+    /// Sets write batch size.
+    ///
+    /// For performance reasons, data for each column is written in

Review Comment:
   I am pretty sure this is accurate but it would be nice for someone else to confirm



-- 
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: github-unsubscribe@arrow.apache.org

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