Skip to content

Commit

Permalink
feat(parquet): update comments for BufferedStreamEnabled (#295)
Browse files Browse the repository at this point in the history
### Rationale for this change

Seems that there is a small error in the comment of
`BufferdStreamEnabled`.

### What changes are included in this PR?

Fix the comment.

### Are these changes tested?

Just change the comments, no need to test

### Are there any user-facing changes?
  • Loading branch information
joechenrh authored Feb 24, 2025
1 parent 7ef4d1e commit 0dd922e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions parquet/reader_properties.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ type ReaderProperties struct {
// just use the read stream when reading data. Otherwise we will buffer
// the data we're going to read into memory first and then read that buffer.
//
// If reading from higher latency IO, like S3, it might improve performance to
// set this to true in order to read the entire row group in at once rather than
// make multiple smaller data requests. For low latency IO streams or if only
// reading small portions / subsets of the parquet file, this can be set to false
// to reduce the amount of IO performed in order to avoid reading excess amounts of data.
// When accessing data from IO sources with higher latency, like S3, setting this
// to false may improve performance by reading the entire row group at once rather
// than sending multiple smaller IO requests. For IO streams with low latency, setting
// this to true can optimize memory usage for the reader. Additionally, this can decrease
// the amount of data retrieved when only needs to access small portions of the parquet file.
BufferedStreamEnabled bool
}

Expand Down

0 comments on commit 0dd922e

Please sign in to comment.