User Defined Functions and APIs

• 1: Unity Catalog Batch Python UDFs

1 - Unity Catalog Batch Python UDFs

The UDFs in this section are applicable only to install and configure the Big Data Protector in the Databricks environment.
This version of the build only supports Unity Catalog Batch Python UDFs that use the Application Protector REST and Cloud Protect approaches. The Hive and Spark UDFs and APIs that provide native protection within the cluster nodes are not packaged in this build. To use those features, please use the 9.1.0.0 builds.

pty_who_am_i()

The UDF returns the current user.

Signature:

pty_who_am_i()

Parameters:

Result:

• The UDF returns the current user.

pty_get_version()

The UDF returns the current version of the protector.

Signature:

pty_get_version()

Parameters:

Result:

• The UDF returns the current version of the protector.

Example:

select pty_get_version();

pty_get_version_extended()

The UDF returns the extended version information of the protector.

Signature:

pty_get_version_extended();

Parameters:

Result:

The UDF returns a String in the following format:

BDP: <bdp_version>, Application Protector REST: <aprest_version>, Jcore: <jcore_version>, Core: <core_version>;

where:

• BDP: is the current version of the Protector
• Application Protector REST: is the Application Protector REST version
• Jcore: is the Jcorelite version
• Core: is the Core library version

Example:

select pty_get_version_extended();

pty_protect_binary()

The UDF protects the BINARY format data, which is provided as input.

Signature:

pty_protect_binary (input BINARY, data_element STRING)

Parameters:

Returns:
The UDF returns the BINARY format data, which is protected.

Example:

SELECT pty_protect_binary(<column_with_binary_data>, "<binary_data_element>");

pty_unprotect_binary()

The UDF unprotects the protected BINARY data, which is provided as an input.

Signature:

pty_unprotect_binary (input BINARY, data_element STRING)

Parameters:

Returns:
The UDF returns the BINARY format data, which is unprotected.

Example:

SELECT pty_unprotect_binary(<column_with_protected_binary_data>, "<binary_data_element>");

pty_protect_date()

The UDF protects the DATE format data, which is provided as input.

Signature:

pty_protect_date (input DATE, data_element STRING)

Note: The supported DATE format is YYYY-MM-DD.

Parameters:

Returns:
The UDF returns the DATE format data, which is protected.

Example:

SELECT pty_protect_date(<column_with_date_data>, "de_datetime");

pty_unprotect_date()

The UDF unprotects the protected DATE data, which is provided as an input.

Signature:

pty_unprotect_date (input DATE, data_element STRING)

Note: The supported DATE format is YYYY-MM-DD.

Parameters:

Returns:
The UDF returns the DATE format data, which is unprotected.

Example:

SELECT pty_unprotect_date(<column_with_protected_date_data>, "de_datetime");

pty_protect_smallint()

The UDF protects the SMALLINT format data, which is provided as input.

Signature:

pty_protect_smallint (input SMALLINT, data_element STRING)

Parameters:

Returns:
The UDF returns the SMALLINT format data, which is protected.

Example:

SELECT pty_protect_smallint(<column_with_smallint_data>, "de_int2");

pty_unprotect_smallint()

The UDF unprotects the protected SMALLINT data, which is provided as an input.

Signature:

pty_unprotect_smallint (input SMALLINT, data_element STRING)

Parameters:

Returns:
The UDF returns the SMALLINT format data, which is unprotected.

Example:

SELECT pty_unprotect_smallint(<column_with_protected_smallint_data>, "de_int2");

pty_protect_int()

The UDF protects the INT format data, which is provided as input.

Signature:

pty_protect_int (input INT, data_element STRING)

Parameters:

Returns:
The UDF returns the INT format data, which is protected.

Example:

SELECT pty_protect_int(<column_with_int_data>, "de_int4");

pty_unprotect_int()

The UDF unprotects the protected INT data, which is provided as an input.

Signature:

pty_unprotect_int (input INT, data_element STRING)

Parameters:

Returns:
The UDF returns the INT format data, which is unprotected.

Example:

SELECT pty_unprotect_int(<column_with_protected_int_data>, "de_int4");

pty_protect_string()

The UDF protects the STRING format data, which is provided as input.

For BIGINT, DATETIME, DECIMAL, DOUBLE, and FLOAT data types, it is recommended to use the pty_protect_string() UDF.

For example:

SELECT pty_protect_string(CAST(<column_with_input_data> AS STRING), "<data_element>");

It is recommended to use the following data elements corresponding to their input data type:

• For BIGINT input, use an integer data element.

  SELECT pty_protect_string(CAST(<column_with_bigint_data> AS STRING), "de_int8");
  

• For DATETIME input, use the datetime data element.

  SELECT pty_protect_string(CAST(<column_with_datetime_data> AS STRING), "de_datetime");
  

• For DECIMAL input, use a decimal data element.

  SELECT pty_protect_string(CAST(<column_with_decimal_data> AS STRING), "de_decimal");
  

• For DOUBLE input, either use a decimal, numeric, or a no encryption data element.

  SELECT pty_protect_string(CAST(<column_with_double_data> AS STRING), "de_decimal");
  

  SELECT pty_protect_string(CAST(<column_with_double_data> AS STRING), "de_numeric");
  

• For FLOAT input, either use a decimal, numeric, or a no encryption data element.

  SELECT pty_protect_string(CAST(<column_with_float_data> AS STRING), "de_decimal");
  

  SELECT pty_protect_string(CAST(<column_with_float_data> AS STRING), "de_numeric");
  

Signature:

pty_protect_string (input STRING, data_element STRING)

Note: The UDF accepts a maximum input length of 4081 characters.

Parameters:

Returns:
The UDF returns the STRING format data, which is protected.

Example:

SELECT pty_protect_string(<column_with_string_data>, "de_alphanum");

pty_unprotect_string()

The UDF unprotects the STRING format data, which is provided as input.

For BIGINT, DATETIME, DECIMAL, DOUBLE, and FLOAT data types, it is recommended to use the pty_unprotect_string() UDF.

For example:

SELECT pty_unprotect_string(CAST(<column_with_protected_data> AS STRING), "<data_element>");

It is recommended to use the following data elements corresponding to their input data type:

• For BIGINT input, use an integer data element.

  SELECT pty_unprotect_string(CAST(<column_with_protected_bigint_data> AS STRING), "de_int8");
  

• For DATETIME input, use the datetime data element.

  SELECT pty_unprotect_string(CAST(<column_with_protected_datetime_data> AS STRING), "de_datetime");
  

• For DECIMAL input, use a decimal data element.

  SELECT pty_unprotect_string(CAST(<column_with_protected_decimal_data> AS STRING), "de_decimal");
  

• For DOUBLE input, either use a decimal, numeric, or a no encryption data element.

  SELECT pty_unprotect_string(CAST(<column_with_protected_double_data> AS STRING), "de_decimal");
  

  SELECT pty_unprotect_string(CAST(<column_with_protected_double_data> AS STRING), "de_numeric");
  

• For FLOAT input, either use a decimal, numeric, or a no encryption data element.

  SELECT pty_unprotect_string(CAST(<column_with_protected_float_data> AS STRING), "de_decimal");
  

  SELECT pty_unprotect_string(CAST(<column_with_protected_float_data> AS STRING), "de_numeric");
  

Signature:

pty_unprotect_string (input STRING, data_element STRING)

Parameters:

Returns:
The UDF returns the STRING format data, which is unprotected.

Example:

SELECT pty_unprotect_string(<column_with_protected_string_data>, "de_alphanum");

pty_encrypt_string()

The UDF encrypts STRING format data, which is provided as input.

Signature:

pty_encrypt_string (input STRING, data_element STRING)

Parameters:

Returns:
The UDF returns the BINARY format data, which is encrypted.

Example:

SELECT pty_encrypt_string(<column_with_string_data>, "<encryption_data_element>");

pty_decrypt_string()

The UDF decrypts the encrypted BINARY data, which is provided as an input.

Signature:

pty_decrypt_string (input BINARY, data_element STRING)

Parameters:

Returns:
The UDF returns the STRING format data, which is decrypted.

Example:

SELECT pty_decrypt_string(<column_with_encrypted_string_data>, "<encryption_data_element>");

pty_protect_string_fpe()

The UDF protects the STRING format data, which is provided as input.

Note: The UDF is compatible only with the Application Protector REST approach.

Signature:

pty_protect_string_fpe (input STRING, data_element STRING, encoding STRING)

Note: The UDF accepts a maximum input length of 4081 characters.

Parameters:

Returns:
The UDF returns the STRING format data, which is protected.

Example:

SELECT pty_protect_string_fpe(<column_with_string_data>, "de_alphanum", "utf_8");

Note: For more information about the supported encoding formats, refer to Standard Encodings

pty_unprotect_string_fpe()

The UDF unprotects the protected STRING format data, which is provided as input.

Note: The UDF is compatible only with the Application Protector REST approach.

Signature:

pty_unprotect_string_fpe (input STRING, data_element STRING, encoding STRING)

Parameters:

Returns:
The UDF returns the STRING format data, which is unprotected.

Example:

SELECT pty_unprotect_string_fpe(<column_with_protected_string_data>, "de_alphanum", "utf_8");

Note: For more information about the supported encoding formats, refer Standard Encodings