IDAX.PREDICT_TWOSTEP - Apply a TwoStep clustering model

Authorization

The privileges held by the authorization ID of the statement must include the IDAX_USER role. Additionally, you must be the owner of the model or have the authority to alter it.

Syntax

IDAX.PREDICT_TWOSTEP(in parameter_string varchar(32672), in synchronous boolean default true)

Parameter descriptions

parameter_string

Mandatory one-string parameter that contains pairs of <parameter>=<value> entries that are separated by a comma.

Data type: VARCHAR(32672)

The following list shows the parameter values:

model

Mandatory.

The name of the TwoStep model that is to be applied.

Data type: VARCHAR(64)

intable

Mandatory.

The name of the input table.

Data type: VARCHAR(128)

outtable

Mandatory.

The name of the output table where assigned clusters are stored.

Data type: VARCHAR(128)

id

Optional.

The column of the input table that identifies a unique instance ID.

Default: The id column that is used to build the TwoStep clustering model.

Data type: VARCHAR(128)

synchronous

Optional.

Synchronous or asynchronous execution of the PREDICT_TWOSTEP stored procedure.

In a synchronous execution, the PREDICT_TWOSTEP stored procedure waits until the execution is completed. In an asynchronous execution, the PREDICT_TWOSTEP procedure returns as soon as it is submitted.

To get the status and the submission ID of an asynchronously executed PREDICT_TWOSTEP stored procedure, call the IDAX.APP_STATUS() stored procedure after you launch the PREDICT_TWOSTEP stored procedure.

To cancel an asynchronously executed PREDICT_TWOSTEP stored procedure, call the IDAX.CANCEL_APP() stored procedure while the PREDICT_TWOSTEP stored procedure is running.

Default: true

spark_partitions

Optional.

Number of Spark partitions that are created with the input data.

This number determines the degree of parallelism that is used to apply the model to the input data.

Default: Number of available CPUs divided by 2.

Data type: INTEGER

Returned information

The procedure does not return any SQL results.

Example

CALL IDAX.PREDICT_TWOSTEP('model=adult_mdl, intable=adult_test, id=id, outtable=adult_mdl_score');