IDAX.LIST_COLPROPS - List column properties for selected or all models

Use this stored procedure to list column properties for the selected models 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_COLPROPS(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=meta-long
Optional.
The column properties are printed in the form in which they are stored in the metadata tables.
format=meta-short
Optional.
The column properties are printed in the form in which they are stored in the metadata tables.
All columns are of varchar type with minimal size, that is, the size of the shortest entry.
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.
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.
schema
Optional.
Only column properties 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, column properties 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.
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:

  • For format=meta-long, the result set has the columns that are shown in the table.
  • For format=meta-short, the result set has the same columns as for format=meta-long that are shown in the table, except for the column type. The column type is VARCHAR for all columns.
  • For format=long, the result set has the same columns as the definition of the column property table.
  • For format=short, all columns of the column property table are returned except for the statistics columns that are currently unused.
Table 1. Result set columns for the IDAX.LIST_COLPROPS procedure for format=meta-long
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
COLUMNNAME VARCHAR(128) The name of the column in the input table

All properties of each column of the input table are listed.

PROPERTYNAME VARCHAR(64) The name of the column property
PROPERTYTYPE VARCHAR(64) The name of the data type of the property

Mostly, the properties are terms, so the type is VARCHAR. The weight property has a numerical type, for example, INTEGER or DOUBLE.

PROPERTYVALUE VARCHAR(64) The value of the column property

Example

CALL IDAX.LIST_COLPROPS('where=PROPERTYNAME=''COLDATATYPE''');