pyarrow.parquet.encryption.CryptoFactory

class pyarrow.parquet.encryption.CryptoFactory(kms_client_factory)

Bases: _Weakrefable

A factory that produces the low-level FileEncryptionProperties and FileDecryptionProperties objects, from the high-level parameters.

__init__()

Create CryptoFactory.

Parameters:
kms_client_factorya callable() that accepts KmsConnectionConfig

and returns a KmsClient

Methods

__init__

Create CryptoFactory.

file_decryption_properties(self, ...)

Create file decryption properties.

file_encryption_properties(self, ...)

Create file encryption properties.

remove_cache_entries_for_all_tokens(self)

remove_cache_entries_for_token(self, ...)

file_decryption_properties(self, KmsConnectionConfig kms_connection_config, DecryptionConfiguration decryption_config=None)

Create file decryption properties.

Parameters:
kms_connection_configKmsConnectionConfig

Configuration of connection to KMS

decryption_configDecryptionConfiguration, default None

Configuration of the decryption, such as cache timeout. Can be None.

Returns:
file_decryption_propertiesFileDecryptionProperties

File decryption properties.

file_encryption_properties(self, KmsConnectionConfig kms_connection_config, EncryptionConfiguration encryption_config)

Create file encryption properties.

Parameters:
kms_connection_configKmsConnectionConfig

Configuration of connection to KMS

encryption_configEncryptionConfiguration

Configuration of the encryption, such as which columns to encrypt

Returns:
file_encryption_propertiesFileEncryptionProperties

File encryption properties.

remove_cache_entries_for_all_tokens(self)
remove_cache_entries_for_token(self, access_token)