General AE functions

Function/Subroutine documentation

• subroutine nzaeClose(handle)

  Optionally called when no more interface functions are to be called to the Netezza system.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

  This functionality is performed upon returning from nzaeHandleRequest , if it has not already been called. It frees up adapter memory in the Netezza system for AEs that are doing work after finishing other AE API calls.

• subroutine nzaeDone(handle)

  Optionally called when there is no data left to be sent.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

  This functionality is performed upon returning from nzaeHandleRequest , if it has not already been called.

• subroutine nzaeIsLocal(isLocal)

  Specifies whether the AE is local or remote.

  • Parameters
    • isLocal

      (integer) The return value of this function. A value of 1 indicates the AE is local; 0 indicates remote.

• subroutine nzaeIsRemote(isRemote)

  Specifies whether the AE is local or remote.

  • Parameters
    • isRemote

      (integer) The return value of this function. A value of 1 indicates the AE is remote; 0 indicates local.

• subroutine nzaeIsShaper(handle, isShaper)

  Specifies whether the AE currently running is a Shaper.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

    • isShaper

      (integer) The return value of this function. A value of 1 indicates the currently-running AE is a shaper; 0 otherwise.

• subroutine nzaeIsUda(handle, isUda)

  Specifies whether the AE currently running is a UDA.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

    • isUda

      (integer) The return value of this function. A value of 1 indicates the currently-running AE is a UDA; 0 otherwise.

• subroutine nzaeIsUdf(handle, isUdf)

  Specifies whether the AE currently running is a UDF.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

    • isUdf

      (integer) The return value of this function. A value of 1 indicates the currently-running AE is a UDF; 0 otherwise.

• subroutine nzaeIsUdtf(handle, isUdtf)

  Specifies whether the AE currently running is a UDTF.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

    • isUdtf

      (integer) The return value of this function. A value of 1 indicates the currently-running AE is a UDTF; 0 otherwise.

• subroutine nzaePing(handle)

  Notifies the Netezza system that work is still being performed and the AE should not be terminated.

  • Parameters
    • handle

      (integer) The handle passed to nzaeHandleRequest .

  When there are long periods of inactivity with the AE system, this function should be called to notify the Netezza system that the AE is still working.