Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify GenericColumnReader::read_records #4540

Merged
merged 3 commits into from
Jul 22, 2023

Conversation

tustvold
Copy link
Contributor

Which issue does this PR close?

Closes #.

Rationale for this change

#4376 (comment)

What changes are included in this PR?

Are there any user-facing changes?

@github-actions github-actions bot added the parquet Changes to the parquet crate label Jul 18, 2023
@tustvold tustvold changed the title Clarity GenericColumnReader::read_records Clarify GenericColumnReader::read_records Jul 18, 2023
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @tustvold -- it is a great idea to clarify the documentation for future readers.

I think clarifying what "partially read" means would help here (I left a suggestion but am not sure it is correct).

cc @zeevm

/// Read up to `num_records` returning the number of complete records, non-null
/// values and levels decoded
/// Read up to `num_records` whole records, returning the number of complete
/// records, non-null values and levels decoded. Records will not be partially read
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "partially read" mean? Like does it mean that the a record will not be read unless there is sufficient data for all columns?

If so, maybe

Suggested change
/// records, non-null values and levels decoded. Records will not be partially read
/// records, non-null values and levels decoded. Records will not be partially read,
/// they are only read as long as there is sufficient data for all columns available.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You only have a single column here, this is referring to record shredding of repeated values, will clarify further...

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you

@tustvold tustvold merged commit fc21cfb into apache:master Jul 22, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants