IDAX.LIST_PARAMS - List parameters for selected or all models

Use this stored procedure to list parameters for a selected model or for all models.

Authorization

The privileges held by the authorization ID of the statement must include at least one of the following authorities:

  • CONTROL privilege on the model
  • SELECT privilege on the model
  • DATAACCESS authority

Syntax

IDAX.LIST_PARAMS(in parameter_string varchar(32672))

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:
format=short
Optional.
A column subset is printed. All columns are of varchar type with minimal size, that is, size of the shortest entry.
Use this format for interactive work on the command line.
Default.
format=long
Optional.
All columns are printed.
If a print of the column subset is not sufficient, specify this format parameter to access and work the full data set.
schema
Optional.
Only parameters for models in this schema are displayed.
Default: current schema
Note: You cannot specify schema and all=true at the same time.
all
Optional.
If you specify all=true, parameters for models from all schemas are displayed.
Note: You cannot specify all=true and schema at the same time.
where
Optional.
Filters the result.
outtable
Optional.
If you specify a regular table or a declared global temporary table, the result set is not displayed but written to the specified table. The table must not exist. If the table that the procedure tries to create already exists, an exception is raised.
If a schema name is not specified, a regular table is created.
If the schema name is SESSION, a declared global temporary table is created, for example, SESSION."Foo".

Returned information

The result set columns are as follows:

Table 1. Result set columns for the IDAX.LIST_PARAMS procedure
Column name Column type Description
MODELSCHEMA VARCHAR(128) The schema of the analytics model that stores the model components
MODELNAME VARCHAR(64) The name of the analytics model
TASKSEQ SMALLINT Identifies the task that is used to create or update the model

Each operation to create or update a model can be viewed as a task. Each of these tasks has a task sequence ID. For example, when a model is created, the task sequence is set to 1. When the model is updated, the task sequence ID is incremented, and the new ID stores the parameters of the update procedure. This way, the complete series of stored procedure calls of a model are stored.

PARAMETERNAME VARCHAR(64) The name of the parameter that is specified in the parameter string of the build procedure or update procedure for the model
PARAMETERTYPE VARCHAR(64) The data type of the parameter

Contains SQL data type names

PARAMETERVALUE VARCHAR(7680) The value of the parameter as a string

Example

CALL IDAX.LIST_PARAMS('where=MODELNAME=''My_Model''');