DB2 User Defined Functions and APIs on

General UDFs

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

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

pty.whoami

The UDF returns the name of the user.

Signature:

pty.whoami()

Parameters:
None

Result:

This UDF returns the name of user logged on to the database as VARCHAR(256).

Example:

SELECT pty.whoami() FROM SYSIBM.SYSDUMMY1;

pty.getversion

The UDF returns the version number of the DB2 protector.

Signature:

pty.getversion()

Parameters:
None

Result:

Access Check UDFs

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

These UDFs are used to check access permissions. The functions returns 1 if the user has access. Otherwise, it returns a 0 (zero).

pty.have_sel_perm

The UDF verifies whether the user has select or unprotect access to the data element.

Signature:

pty.have_sel_perm(communicationid INTEGER, dataelement VARCHAR)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.

Result:

VarChar UDFs

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

The UDFs, listed in this section, protect and unprotect VARCHAR data.

pty.ins_enc_varchar

The UDF encrypts the VARCHAR data with an encryption data element.

Signature:

pty.ins_enc_varchar(communicationid INTEGER, dataelement VARCHAR, data VARCHAR, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`data`	`VARCHAR(32672)`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

VarChar for Bit Data UDFs

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

The UDFs, listed in this section, protect and unprotect VARCHAR FOR BIT DATA.

pty.ins_enc_varcharfbd

The UDF encrypts the VARCHAR FOR BIT DATA value with an encryption data element.

Signature:

pty.ins_enc_varcharfbd(comm_id INTEGER, dataelement VARCHAR, input_data VARCHAR, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`VARCHAR(32672) FOR BIT DATA`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Char UDFs

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

The UDFs, listed in this section, protect and unprotect CHAR data.

pty.ins_enc_char

The UDF protects the CHAR data with an encryption data element.

Signature:

pty.ins_enc_char(comm_id INTEGER, dataelement VARCHAR, input_data CHAR, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`VARCHAR(254)`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Char for Bit Data UDFs

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

The UDFs, listed in this section, protect and unprotect CHAR FOR BIT DATA.

pty.ins_enc_charfbd

The UDF encrypts the CHAR FOR BIT DATA value with an encryption data element.

Signature:

pty.ins_enc_charfbd(comm_id INTEGER, dataelement VARCHAR, input_data VARCHAR, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`VARCHAR(254) FOR BIT DATA`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Long VarChar UDFs

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

The UDFs, listed in this section, protect and unprotect LONG VARCHAR data.

pty.ins_enc_lvarchar

The UDF encrypts the LONG VARCHAR data with an encryption data element.

Signature:

pty.ins_enc_lvarchar(comm_id INTEGER, dataelement VARCHAR, input_data LONG VARCHAR, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`LONG VARCHAR`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Long VarChar for Bit Data UDFs

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

The UDFs, listed in this section, protect and unprotect LONG VARCHAR FOR BIT DATA.

pty.ins_enc_lvcfbd

The UDF encrypts the LONG VARCHAR FOR BIT DATA value with an encryption data element.

Signature:

pty.ins_enc_lvcfbd(comm_id INTEGER, dataelement VARCHAR, input_data LONG VARCHAR FOR BIT DATA, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`LONG VARCHAR FOR BIT DATA`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Date UDFs

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

The UDFs, listed in this section, protect and unprotect DATE data.

pty.ins_enc_date

The UDF encrypts a DATE value with an encryption data element.

Signature:

pty.ins_enc_date(comm_id INTEGER, dataelement VARCHAR, input_data DATE, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`DATE`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Timestamp UDFs

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

The UDFs, listed in this section, protect and unprotect TIMESTAMP data.

pty.ins_enc_timestamp

The UDF encrypts a TIMESTAMP value with an encryption data element.

Signature:

pty.ins_enc_timestamp(comm_id INTEGER, dataelement VARCHAR, input_data TIMESTAMP, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`TIMESTAMP`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Time UDFs

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

The UDFs, listed in this section, protect and unprotect TIME data.

pty.ins_enc_time

The UDF encrypts TIME value with an encryption data element.

Signature:

pty.ins_enc_time(comm_id INTEGER, dataelement VARCHAR, input_data TIME, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`TIME`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Integer UDFs

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

The UDFs, listed in this section, protect and unprotect INTEGER data.

pty.ins_enc_integer

The UDF protects the INTEGER data with a data element for encryption.

Signature:

pty.ins_enc_integer(comm_id INTEGER, dataelement VARCHAR, input_data INTEGER, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`INTEGER`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

SmallInt UDFs

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

The UDFs, listed in this section, protect and unprotect SMALLINT data.

pty.ins_enc_smallint

The UDF encrypts the SMALL INTEGER data with a data element for encryption.

Signature:

pty.ins_enc_smallint(comm_id INTEGER, dataelement VARCHAR, input_data SMALLINT, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`SMALLINT`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

BigInt UDFs

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

The UDFs, listed in this section, protect and unprotect BIGINT data.

pty.ins_enc_bigint

The UDF encrypts the BIG INTEGER data with a data element for encryption.

Signature:

pty.ins_enc_bigint(comm_id INTEGER, dataelement VARCHAR, input_data BIGINT, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`BIGINT`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Real UDFs

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

The UDFs, listed in this section, protect and unprotect REAL data.

pty.ins_enc_real

The UDF encrypts REAL data with a data element for encryption.

Signature:

pty.ins_enc_real(comm_id INTEGER, dataelement VARCHAR, input_data REAL, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`REAL`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Double UDFs

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

The UDFs, listed in this section, protect and unprotect DOUBLE data.

pty.ins_enc_double

The UDF encrypts the DOUBLE data with a data element for encryption.

Signature:

pty.ins_enc_double(comm_id INTEGER, dataelement VARCHAR, input_data DOUBLE, scid INTEGER)

Parameters:

Name	Type	Description
`communicationid`	`INTEGER`	Specifies the location where the UDF will find the policy. The value must be the same as configured in the `config.ini` file. Note: This parameter is no longer used and is retained for compatibility purposes only.
`dataelement`	`VARCHAR(64)`	Specifies the name of the data element.
`input_data`	`DOUBLE`	Specifies the input data.
`scid`	`INTEGER`	Specifies the security coordinate ID. Set the value of the parameter to zero. Note: This parameter is no longer used and is retained for compatibility purposes only.

Result:

Blob UDFs

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

The UDFs, listed in this section, protect and unprotect BLOB data.

** Note:** The BLOB UDFs support a maximum input size of 2,147,483,576 bytes, which is approximately 2GB. The the protected output can be up to 2,147,483,610 bytes. Large operations are memory intensive. For example, 2 GB operation can require several gigabytes of memory per member. Ensure the instance is sized adequately. For example, the INSTANCE_MEMORY should be 16 GB or higher. Otherwise, the UDFs may fail with the SQL0930N error.

Clob UDFs

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

The UDFs, listed in this section, protect and unprotect CLOB data.

Note: The CLOB UDFs support a maximum input size of 2,147,483,576 bytes, which is approximately 2GB. The protected output can be up to 2,147,483,610 bytes. Use the BLOB UDFs for binary data like images, audio, and video. This is because the CLOB codepage conversion can corrupt binary content. Large operations are memory intensive. For example, 2 GB operation can require several gigabytes of memory per member. Ensure the instance is sized adequately. For example, the INSTANCE_MEMORY should be 16 GB or higher. Otherwise, the UDFs may fail with the SQL0930N error.