Java SDK Documentation  23.3.0
com.vertica.sdk.UDXFunction Class Reference
Inheritance diagram for com.vertica.sdk.UDXFunction:
Inheritance graph
Collaboration diagram for com.vertica.sdk.UDXFunction:
Collaboration graph

Public Member Functions

final void cancelUDX (ServerInterface srvInterface)
 
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes)
 
void destroy (ServerInterface srvInterface, SizedColumnTypes argTypes, SessionParamWriterMap udSessionParams)
 
boolean isCanceled ()
 
void setup (ServerInterface srvInterface, SizedColumnTypes argTypes)
 

Protected Member Functions

void cancel (ServerInterface srvInterface)
 

Member Function Documentation

void com.vertica.sdk.UDXObject.cancel ( ServerInterface  srvInterface)
protectedinherited

Cancel callback to be overridden by the UDX implementation. Called when the query running the UDX has been canceled.

  • This method will be invoked at most once per UDX object. Once a UDX object has been canceled, it will never be un-canceled.
  • This method may be called from a separate thread, concurrently with other methods of this UDX object (but never the constructor). Implementations must be thread-safe with all methods of this UDX.
  • This method will be invoked for either an explicit user cancel, or in the event of an error during query execution.
Parameters
srvInterfacea ServerInterface object used to communicate with Vertica

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

final void com.vertica.sdk.UDXObject.cancelUDX ( ServerInterface  srvInterface)
inherited

Cancel callback invoked when the query running the UDX has been canceled.

See cancel().

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
void com.vertica.sdk.UDXFunction.destroy ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes 
)

Perform per instance destruction. This function may throw errors

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
argTypesthe types of the arguments (as SizedColumnTypes)

Referenced by com.vertica.sdk.UDXFunction.destroy().

void com.vertica.sdk.UDXFunction.destroy ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes,
SessionParamWriterMap  udSessionParams 
)

Perform per instance destruction and write session parameters to be used by UDxs that are invoked after this one returns. This function may throw errors

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
argTypesthe types of the arguments (as SizedColumnTypes)
udSessionParamsa SessionParamWriterMap
boolean com.vertica.sdk.UDXObject.isCanceled ( )
inherited
Returns
true if execution was canceled.

Referenced by com.vertica.sdk.UDXObject.cancelUDX().

void com.vertica.sdk.UDXFunction.setup ( ServerInterface  srvInterface,
SizedColumnTypes  argTypes 
)

Perform per instance initialization. This function may throw errors.

Parameters
srvInterfacea ServerInterface object used to communicate with Vertica
argTypesthe types of the arguments (as SizedColumnTypes)