IDAX.LIST_COMPONENTS - List components of selected or all models

Use this stored procedure to list the model components.

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_COMPONENTS(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 components 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, components 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_COMPONENTS 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
SCHEMA VARCHAR(128) The schema of the table or view
NAME VARCHAR(128) The name of the table or view

If the name of the table or view is changed or removed, this entry becomes invalid.

TYPE VARCHAR(16) The component type, for example, Table or View
MANAGEMENT VARCHAR(16) The management level of the table or view, that is, Managed or Referenced

Managed means that provided procedure controls the life cycle of the components, for example, the components are dropped when the model is dropped.

Referenced means that the names of these components are added to the metadata for reference. Referenced components can be also in a schema other than the schema of the model.

USAGETYPE VARCHAR(64) The usage type of the table or view, for example, Model or Input
SEQID SMALLINT An integer (>=0) that identifies tables or views of the same type

If the SEQID is not used, this column is NULL.

If an algorithm stores more than one table or view of the same type, these tables or views are distinguished by the sequence ID.

Example

CALL IDAX.LIST_COMPONENTS('where=OWNER=''BOB'' AND USAGETYPE=''Model''');