Teradata UDFs on

General UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section includes the general UDFs that can be used to retrieve the Teradata Protector version and the current user.

pty_whoami

This UDF returns the name of the user who is currently logged in.

Signature:

pty_whoami()

Parameters:
None

Returns:
The function returns the name of user logged in to the database.

Example:

select pty_whoami();

pty_getversion

This UDF returns the version of the installed Teradata Data Warehouse Protector.

Signature:

pty_getversion()

Parameters:
None

Access Check UDFs

Mon, 01 Jan 0001 00:00:00 +0000

This section includes list of UDFs that can be used to check select access-related information.

pty_checkselaccess

This UDF checks whether a database user has unprotect access for a set of data elements. To run this UDF, the database user should be granted access rights for protection.

Signature:

pty_checkselaccess(dataelement<n> VARCHAR, resultlen INTEGER, communicationid INTEGER)

Parameters:

Name	Type	Description
`dataelement1`	VARCHAR	Specifies the name of the data element to check.
`dataelement2`	VARCHAR	Specifies the name of the data element to check.
`dataelement3`	VARCHAR	Specifies the name of the data element to check.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as `0`. This parameter is deprecated.

Returns:

The function returns a 3-CHARACTER string.

Varchar Latin UDFs

Mon, 01 Jan 0001 00:00:00 +0000

The Varchar Latin UDFs accept the string data encoded in the Latin character set.

Important: Do not exceed the maximum output buffer length when using the result length parameter (resultlen) in the Varchar Latin UDFs.
For more information about the maximum output buffer length, for each Varchar Latin UDF, refer to Installing the Teradata Objects.

pty_varcharlatinenc

This UDF protects the string data using an Encryption data element.

Signature:

pty_varcharlatinenc(col VARCHAR, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Varchar Unicode UDFs

Mon, 01 Jan 0001 00:00:00 +0000

The Varchar Unicode UDFs accept the string data encoded in the UNICODE character set.

Important: Do not exceed the maximum output buffer length when using the result length parameter (resultlen) in the Varchar Unicode UDFs.
For more information about the maximum output buffer length, for each Varchar Unicode UDF, refer to Installing the Teradata Objects.

pty_varcharunicodeenc

This UDF protects the Unicode string using an Encryption data element for encryption.

Signature:

Float UDFs

Mon, 01 Jan 0001 00:00:00 +0000

pty_floatenc

This UDF protects the float value using an Encryption data element.

Signature:

pty_floatenc(col FLOAT, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	FLOAT	Specifies the data to protect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:
The function returns the protected VARBYTE value.

Small Integer UDFs

Mon, 01 Jan 0001 00:00:00 +0000

pty_smallintenc

This UDF protects the small integer value using an Encryption data element.

Signature:

pty_smallintenc(col SMALLINT, dataelement VARCHAR, resultlen INTEGER, communicationidINTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	SMALLINT	Specifies the data to protect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:
The function returns the protected VARBYTE value.

Integer UDFs

Mon, 01 Jan 0001 00:00:00 +0000

pty_integerenc

This UDF protects integer value using an Encryption data element.

Signature:

pty_integerenc(col INTEGER, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	INTEGER	Specifies the data to protect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:
The function returns the protected VARBYTE value.

Big Integer UDFs

Mon, 01 Jan 0001 00:00:00 +0000

pty_bigintenc

This UDF protects the Big Integer value using a data element for encryption.

Signature:

pty_bigintenc(col BIGINT, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	VARBYTE	Specifies the data to unprotect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:

The function returns the protected VARBYTE value.

Date UDFs

Mon, 01 Jan 0001 00:00:00 +0000

The dates can be protected using encryption and tokenization as the data protection method. The native UDFs, such as, pty_dateenc and pty_datedec, can be used for encryption and decryption respectively. To tokenize the date formats using the date data element, the data must be cast to VARCHAR type and then protected/unprotected with PTY_VARCHARLATININS/PTY_VARCHARLATINSEL UDFs.

To avoid any performance issues resulting due to casting of the data, a general best practice is to protect the data and present the decryption-related UDFs in the tables as views to authorized users only. This eliminates the unauthorized user’s access to the decryption UDFs and has the protected data only. The decryption process is limited to authorized users and thus, doesn’t cause any performance impact as the UDFs are executed restrictively.

8-Byte and 16-Byte Decimal UDFs

Mon, 01 Jan 0001 00:00:00 +0000

These UDFs work on the Decimal data types that are either 8 or 16 bytes in size. The 8-byte Decimal data types have a precision between 10 and 18 digits, while the 16-byte Decimals have a precision between 19 and 38 digits.

Note: Only one set of Decimal UDFs can be created for each range. The user must provide the UDF name. It is recommended that you replace with, for example, 10_2 if the target data type is Decimal(10,2) to get a function pty_decimal_10_2enc, or 22_3 if the target data type is Decimal(22,3) to get pty_decimal_22_3enc.

JSON UDFs

Mon, 01 Jan 0001 00:00:00 +0000

These UDFs are used to protect and unprotect data for JSON data type. These UDFs have been introduced to support LOB or Large Objects that can be loaded to or extracted from the Teradata Database tables. Depending on the data element chosen, the data is tokenized or encrypted. The data in JSON are protected as CLOBs.

The examples provided for protection and unprotection are for single queries.

pty_jsonins

This UDF protects the JSON value using the type-preserving data elements, such as, token and No Encryption data element for access control.

XML UDFs

Mon, 01 Jan 0001 00:00:00 +0000

These UDFs support the XML data type. The XML content is stored in compact binary form or CLOBs that preserve the information set of the XML document. These UDFs have been introduced to support the XML files that can be loaded to or extracted from the Teradata Database tables. Depending on the data element chosen, the data is either tokenized or encrypted.

pty_xmlins

This UDF protects the XML value using type-preserving data elements, such as, token and No Encryption for access control.

Float UDFs for No Encryption

Mon, 01 Jan 0001 00:00:00 +0000

pty_floatins

This UDF can be used only with the No Encryption data element.

Signature:

pty_floatins(col FLOAT, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	FLOAT	Specifies the data to protect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:
The function returns the input value as it is.

Date UDFs for No Encryption

Mon, 01 Jan 0001 00:00:00 +0000

This section provides DATE UDFs that are applicable for No Encryption data elements.

pty_dateins

This UDF protects a date value with a No Encryption data element to impose access control.

Signature:

pty_dateins(col DATE, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`col`	DATE	Specifies the data to protect.
`dataelement`	VARCHAR	Specifies the name of the data element.
`resultlen`	INTEGER	Specifies the length of the buffer to hold the result.
`communicationid`	INTEGER	Specify the value as 0. This parameter is deprecated.
`scid`	INTEGER	Specify the value as 0. This parameter is deprecated.

Returns:
The function returns the input value as is.

8-Byte AND 16-Byte Decimal UDFs for No Encryption

Mon, 01 Jan 0001 00:00:00 +0000

These UDFs work on the Decimal data types that are either 8 or 16 bytes in size. The 8-byte Decimals have a precision between 10 and 18 digits, while the 16-byte Decimals have a precision between 19 and 38 digits. These UDFs apply to the No Encryption data elements only.

pty_decimalins

This UDF protects the decimal value using a No Encryption data element.

Signature:

pty_decimal<n>ins(col DECIMAL<M,N>, dataelement VARCHAR, resultlen INTEGER, communicationid INTEGER, scid INTEGER)

Parameters: