Skip to content

Commit b0cfb95

Browse files
author
Sreesh Maheshwar
committed
Improvement: Comments
1 parent 3a4fb52 commit b0cfb95

1 file changed

Lines changed: 17 additions & 4 deletions

File tree

python/pyarrow/_parquet_encryption.pyx

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,14 @@ def create_decryption_properties(
723723
"""
724724
Create FileDecryptionProperties using a direct footer key.
725725
726-
This bypasses the KMS-based CryptoFactory API and directly constructs
727-
decryption properties from a plaintext key.
726+
This bypasses the KMS-based :class:`CryptoFactory` API and directly
727+
constructs decryption properties from a plaintext key. This is useful
728+
when the caller manages key wrapping externally (e.g. via an
729+
application-level envelope encryption scheme).
730+
731+
For most use cases, prefer the higher-level :class:`CryptoFactory`
732+
with :class:`DecryptionConfiguration`, which handles envelope
733+
encryption and key rotation automatically.
728734
729735
Parameters
730736
----------
@@ -806,8 +812,15 @@ def create_encryption_properties(
806812
"""
807813
Create FileEncryptionProperties using a direct footer key.
808814
809-
This bypasses the KMS-based CryptoFactory API and directly constructs
810-
encryption properties from a plaintext key.
815+
This bypasses the KMS-based :class:`CryptoFactory` API and directly
816+
constructs encryption properties from a plaintext key. This is useful
817+
when the caller manages key wrapping externally (e.g. via an
818+
application-level envelope encryption scheme).
819+
820+
For most use cases, prefer the higher-level :class:`CryptoFactory`
821+
with :class:`EncryptionConfiguration`, which handles envelope
822+
encryption, key rotation, and unique-per-file data keys
823+
automatically.
811824
812825
Parameters
813826
----------

0 commit comments

Comments
 (0)