Metadata functions

Module documentation and detailed description for metadata functions.

Function/Subroutine documentation

  • subroutine nzaeGetInputScale(handle, columnIndex, result)

    Determines the scale of an input column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The scale of the input at the specified column index.

  • subroutine nzaeGetInputSize(handle, columnIndex, result)

    Determines the size of an input string column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The size of the input at the specified column index.

  • subroutine nzaeGetInputType(handle, columnIndex, result)

    Determines the data type of a gven input column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The type of the input at the specified column index.

    The possible types can be found at /nz/kit/sys/include/nzudsudxtypes.h.

  • subroutine nzaeGetNumberOfInputColumns(handle, result)

    Determines the number of columns in the input.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The number of columns in the input.

  • subroutine nzaeGetNumberOfOutputColumns(handle, result)

    Determines the number of columns in the output.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The number of columns in the output.

  • subroutine nzaeGetOutputScale(handle, columnIndex, result)

    Determines the scale of an output column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The scale of the output at the specified column index.

    This function works for function AEs as well as during the "final-result" process state of aggregate AEs.

  • subroutine nzaeGetOutputSize(handle, columnIndex, result)

    Determines the size of an output string column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The size of the output at the specified column index.

    This function works for function AEs as well as during the "final-result" process state of aggregate AEs.

  • subroutine nzaeGetOutputType(handle, columnIndex, result)

    Determines the data type of a gven output column.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • columnIndex

        (integer) The column index to interrogate.

      • result

        (integer) The type of the output at the specified column index.

    The possible types can be found at /nz/kit/sys/include/nzudsudxtypes.h. This function works for function AEs as well as during the "final-result" process state of aggregate AEs.

  • subroutine nzaeIsDataInnerCorrelated(handle, result)

    Determines if the AE was invoked with inner-correlated data.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The value is 1 if the the AE was invoked such that the data is inner-correlated; 0 otherwise.

  • subroutine nzaeIsDataLeftCorrelated(handle, result)

    Determines if the AE was invoked with left-correlated data.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The value is 1 if the the AE was invoked such that the data is left-correlated; 0 otherwise.

  • subroutine nzaeIsDataUncorrelated(handle, result)

    Determines if the AE was invoked with uncorrelated data.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The value is 1 if the the AE was invoked such that the data is correlated; 0 otherwise.

  • subroutine nzaeIsInvokedWithOrderByClause(handle, result)

    Determines if the AE was invoked with an ORDER BY clause.

    • Parameters
      • handle

        (integer) The data type in question.

      • result

        (integer) The value is 1 if the the AE was invoked with a ORDER BY clause; 0 otherwise.

  • subroutine nzaeIsInvokedWithOverClause(handle, result)

    Determines if the AE was invoked with an OVER clause.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result

        (integer) The value is 1 if the the AE was invoked with an OVER clause; 0 otherwise.

  • subroutine nzaeIsInvokedWithPartitionByClause(handle, result)

    Determines if the AE was invoked with a PARTITION BY clause.

    • Parameters
      • handle

        (integer) The handle passed to nzaeHandleRequest .

      • result(integer) The value is 1 if the the AE was invoked with a PARTITION BY clause; 0 otherwise.