Creating an External C/C++ Scalar or Aggregate Function

Set up a new external C or C++ aggregate function on an SAP Sybase IQ server.

Prerequisites

Database Version	Function Privileges
SAP Sybase IQ 15.3 and 15.4	External C/C++ Scalar or Aggregate function to be owned by self or any user – you must have DBA authority.
SAP Sybase IQ 16.0	External C/C++ Scalar or Aggregate function to be owned by self – you must have all of: CREATE PROCEDURE system privilege CREATE EXTERNAL REFERENCE system privilege External C/C++ Scalar or Aggregate function to be owned by any user – you must have the CREATE EXTERNAL REFERENCE system privilege. You must also have one of: CREATE ANY PROCEDURE system privilege CREATE ANY OBJECT system privilege

Database Version

Function Privileges

SAP Sybase IQ 15.3 and 15.4

External C/C++ Scalar or Aggregate function to be owned by self or any user – you must have DBA authority.

SAP Sybase IQ 16.0

External C/C++ Scalar or Aggregate function to be owned by self – you must have all of:

CREATE PROCEDURE system privilege
CREATE EXTERNAL REFERENCE system privilege

External C/C++ Scalar or Aggregate function to be owned by any user – you must have the CREATE EXTERNAL REFERENCE system privilege. You must also have one of:

CREATE ANY PROCEDURE system privilege
CREATE ANY OBJECT system privilege

The SAP Sybase IQ resource is authenticated and running.
You must be licensed for the InDatabase Analytics Option (IQ_IDA).
(Optional) Copy the library that contains the external function to a location accessible to the SAP Sybase IQ server. (You can create the function if the library is not accessible to SAP Sybase IQ, but SAP Sybase IQ cannot execute the function.)

Task

In the Perspective Resources view, select the resource, and select Resource > Administration Console.
In the left pane, expand IQ Servers > Compiled Objects, and then select Functions.
Click the arrow next to Functions and select New.
The Create Function Wizard appears.

On the Welcome page, specify:

Option	Description
Select a resource for which the function will be created	From the list, select the resource for which the function will be created.
Which user or group/role do you want to own the function?	From the list, select the user or role/group to own the function.
What do you want to name the function?	Enter a unique name for the new function; maximum of 128 characters.
Which SQL dialect or language do you want to use?	Select External C/C++ scalar or External C/C++ aggregate.
Use SQL template	(Optional) Select to insert a hardcoded SQL template and skip the wizard page for specifying a return type. You can also set a Watcom SQL function to be deterministic or nondeterministic.

Click Next.
If you chose to use the SQL template, skip to step 9. Otherwise, on the Specify Return Type page, select the type of value to return and whether to create a deterministic function. Click Next.
On the Function Attributes page, specify the attributes of the function, including the names of its shared library file and descriptor function. Click Next.
For External C/C++ aggregate only, on the Function Clauses page, configure clauses that control windows on the Function Clauses page. Click Next.
On the SQL page, edit the code provided by the wizard.
1. Define input parameters: name, type, and default value.
2. If you chose to use the SQL template, replace the placeholder external name at the end of the query with a real name of the form functionDescriptorName@libraryName.
3. Make any other changes needed to complete your function.
4. (Optional) Enter a comment describing the function.
  Comments can include both HTML and Javadoc tags, so you can incorporate them into your generated database documentation.
Click Finish.