Skip to content

Conversation

@adamreeve
Copy link
Contributor

Which issue does this PR close?

Part of #7278, and a follow on from #7281.

Rationale for this change

Makes it easier for users to understand how to use the new encryption feature.

What changes are included in this PR?

Adds examples inline in the documentation for the encryption module, the KeyRetriever trait and the FileDecryptionProperties and FileEncryptionProperties types.

Note that this documentation isn't currently built due to the encryption module being experimental.

Are there any user-facing changes?

No

@github-actions github-actions bot added the parquet Changes to the parquet crate label Apr 2, 2025
Copy link
Contributor

@etseidl etseidl left a comment

Choose a reason for hiding this comment

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

Excellent documentation @adamreeve, thank you!

Copy link
Member

@mbrobbel mbrobbel 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 @adamreeve, this is very helpful.

Co-authored-by: Matthijs Brobbel <[email protected]>
@alamb alamb merged commit 885e7bf into apache:main Apr 4, 2025
16 checks passed
@alamb
Copy link
Contributor

alamb commented Apr 4, 2025

Amazing @adamreeve -- thank you also for the reviews @mbrobbel and @etseidl

@adamreeve adamreeve deleted the encryption_examples branch April 4, 2025 15:21
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.

4 participants