Shaper and sizer functions

Module documentation and detailed description for Shaper and Sizer Functions

Function/Subroutine documentation

  • subroutine nzaeAddOutputColumnString(handle, dataType, columnName, size)

    Adds a string output column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • dataType

        (integer) The UDS string type.

      • columnName

        (character*) The column name to add. Ignored for sizer AEs.

      • size

        (integer) The size/width of the string column to add.

    The possible UDS string types are Fixed/Char (0), Variable/Varchar (1), National-Fixed (2), and National- Variable (3).

  • subroutine nzaeAddOutputColumnNumeric(handle, dataType, columnName, precision, scale)

    Adds a numeric output column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • dataType

        (integer) The UDS numeric type.

      • columnName

        (character*) The column name to add. Ignored for sizer AEs.

      • precision

        (integer) The precision of the numeric column to add.

      • scale

        (integer) The scale of the numeric column to add.

    The possible UDS numeric types are numeric32 (8), numeric64 (9), and numeric128 (10).

  • subroutine nzaAddOutputColumn(handle, dataType, columnName)

    Adds a non-string, non-numeric output column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • dataType

        (integer) The UDS numeric type.

      • columnName

        (character*) The column name to add. Ignored for sizer AEs.

      • precision

        (integer) The precision of the numeric column to add.

      • scale

        ((integer) The scale of the numeric column to add.

    The possible UDS types are bool (4), date (5), time (6), timezone (7), float (11), double (12), interval (13), 8-bit integer (14), 16-bit integer (15), 32-bit integer (16), 64-bit integer (17), and timestamp (18).

  • ssubroutine nzaeIsInputConstant(handle, columnIndex, isConstant)

    Determines if the input to the shaper/sizer function is a constant, and therefore available.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index.

      • isConstant

        (integer) The value is 1 if the input is a constant; 0 otherwise.

  • subroutine nzaeIsSystemCatalogUpperCase(handle, isUpperCase)

    Determines if the the NPS catalog is in upper case.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • isUpperCase

        (integer) The value is 1 if the system catalog is upper-case; 0 otherwise.

  • subroutine nzaeIsUdfSizer(handle, isUdfSizer)

    Determines if the AE that is running is a UDF sizer.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • isUdfSizer

        (integer)The value is 1 if the AE is a UDF sizer; 0 otherwise.

  • subroutine nzaeIsUdtfShaper(handle, isUdtfShaper)

    Determines if the AE that is running is a UDTF shaper.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • isUdtfShaper

        (integer) The value is 1 if the AE is a UDTF shaper; 0 otherwise.