3.1.4.2.2.1.3.26.1 Columns

  • Article

The DMSCHEMA_MINING_COLUMNS rowset contains the following columns.

Name

Type

Restriction

Description

MODEL_CATALOG

xsd:string

Yes

The catalog name.

MODEL_SCHEMA

xsd:string

Yes

The unqualified schema name.<281>

MODEL_NAME

xsd:string

Yes

The mining model name.

COLUMN_NAME

xsd:string

Yes

The name of the column.

COLUMN_GUID

uuid

The column GUID.

COLUMN_PROPID

xsd:unsignedInt

The column property ID.

ORDINAL_POSITION

xsd:unsignedInt

The ordinal position of the column. Columns are numbered starting from 1. This column contains NULL if there is no stable ordinal value for the column.

COLUMN_HAS_DEFAULT

xsd:boolean

A Boolean that indicates whether the column has a default value.

True if the column has a default value; otherwise false.

COLUMN_DEFAULT

xsd:string

The default value of the column.

If the default value is the NULL value, COLUMN_HAS_DEFAULT contains TRUE and COLUMN_DEFAULT contains NULL.

COLUMN_FLAGS

xsd:unsignedInt

A bitmask that describes characteristics of the column. The bitmask is the same as is described for the COLUMN_FLAGS column in section 3.1.4.2.2.1.3.3.This column is never empty.

IS_NULLABLE

xsd:boolean

A Boolean that indicates whether the column is nullable.

False if the column is known not to be nullable; otherwise, true.

DATA_TYPE

xsd:unsignedShort

This enumeration is the same as LEVEL_DBTYPE for MDSCHEMA_LEVELS. (See 3.1.4.2.2.1.3.8)

TYPE_GUID

uuid

The GUID of the column's data type.

CHARACTER_MAXIMUM_LENGTH

xsd:unsignedInt

The maximum possible length of a value in the column. For character, binary, or bit columns, this is one of the following:

  • The maximum length of the column in characters, bytes, or bits, respective to the column type, if a length is defined. For example, a CHAR(5) column in an SQL table has a maximum length of 5.

  • The maximum length of the data type in characters, bytes, or bits, respective to the column type, if the column does not have a defined length.

  • Zero (0) if neither the column nor the data type has a defined maximum length.

  • NULL for all other types of columns.

CHARACTER_OCTET_LENGTH

xsd:unsignedInt

The maximum length in octets (bytes) of the column, if the type of the column is Character or Binary. A value of zero (0) means the column has no maximum length. This column contains NULL for all other types of columns.

NUMERIC_PRECISION

xsd:unsignedShort

The maximum precision of the column if the column's data type is of a numeric data type other than DBTYPE_VARNUMERIC.

NULL if the column's data type is not numeric or is DBTYPE_VARNUMERIC.

The precision of columns with a data type of DBTYPE_DECIMAL or DBTYPE_NUMERIC depends on the column definition.

NUMERIC_SCALE

xsd:short

The number of digits to the right of the decimal point if the column's type indicator is DBTYPE_DECIMAL, DBTYPE_NUMERIC, or DBTYPE_VARNUMERIC. Otherwise, this column contains NULL.<282>

DATETIME_PRECISION

xsd:unsignedInt

The date/time precision (number of digits in the fractional seconds portion) of the column if the column data type is a DateTime or Interval type; otherwise, NULL.

CHARACTER_SET_CATALOG

xsd:string

The catalog name in which the character set is defined.<283>

CHARACTER_SET_SCHEMA

xsd:string

An unqualified schema name in which the character set is defined.<284>

CHARACTER_SET_NAME

xsd:string

The character set name.

COLLATION_CATALOG

xsd:string

The catalog name in which the collation is defined.<285>

COLLATION_SCHEMA

xsd:string

An unqualified schema name in which the collation is defined.<286>

COLLATION_NAME

xsd:string

The collation name.<287>

DOMAIN_CATALOG

xsd:string

The catalog name in which the domain is defined.<288>

DOMAIN_SCHEMA

xsd:string

The unqualified schema name in which the domain is defined.<289>

DOMAIN_NAME

xsd:string

The domain name.<290>

DESCRIPTION

xsd:string

The human-readable description of the column.<291>

DISTRIBUTION_FLAG

xsd:string

A description of the statistical distribution of the column. This column contains one of the following:

  • NORMAL

  • LOG_NORMAL

  • UNIFORM

CONTENT_TYPE

xsd:string

A description of the content of the column. This column contains one of the following:

  • KEY

  • DISCRETE

  • CONTINUOUS

  • DISCRETIZED(arguments)

  • ORDERED

  • KEY TIME

  • CYCLICAL

  • PROBABILITY

  • VARIANCE

  • STDEV

  • SUPPORT

  • PROBABILITY_VARIANCE

  • PROBABILITY_STDEV

  • KEY SEQUENCE

MODELING_FLAG

xsd:string

A comma-delimited list of flags. The defined flags are as follows:

MODEL_EXISTENCE_ONLY

REGRESSOR

Algorithm-specific modeling flags can also be contained in this column.

IS_RELATED_TO_KEY

xsd:boolean

A Boolean that indicates whether the column is related to the key.

True if this column is related to the key. If the key is a single column, the RELATED_ATTRIBUTE field can optionally contain its column name; otherwise false.

RELATED_ATTRIBUTE

xsd:string

The name of the target column to which the current column either relates or is a special property.

IS_INPUT

xsd:boolean

A Boolean that indicates whether the column is an input column.

True if this is an input column; otherwise false.

IS_PREDICTABLE

xsd:boolean

A Boolean that indicates whether the column is predictable.

True if the column is predictable; otherwise false.

CONTAINING_COLUMN

xsd:string

The name of the TABLE column that contains this column. This column contains NULL if the column is not contained in another column.

PREDICTION_SCALAR_FUNCTIONS

xsd:string

A comma-delimited list of scalar functions that can be performed on the column.

PREDICTION_TABLE_FUNCTIONS

xsd:string

A comma-delimited list of functions that can be applied to the column. The functions are to return a table. The list has the following format:

<function name>(<column1> [, <column2>], ...)

The format allows the client application to determine the signature (list of parameters) for the respective function.

IS_POPULATED

xsd:boolean

A Boolean that indicates whether the column has been trained with a set of possible values.

True if the column has been trained with a set of possible values. False if the column is not populated.

PREDICTION_SCORE

xsd:double

The score of the model on predicting the column. Score is used to measure the accuracy of a model.

SOURCE_COLUMN

xsd:string

The name of the source mining structure column for the current mining column.

FILTER

xsd:string

The filter that was used in definition of the nested table.

If the column is a scalar column, the value is always expected to be NULL or an empty string.

If the column is a nested table, NULL or an empty string indicates that no filter is applied to the nested table.

First, the rowset is sorted by mining structure name, which is not a column in the rowset. Then, the rowset is sorted on MODEL_CATALOG, MODEL_SCHEMA, MODEL_NAME, and COLUMN_NAME.

The response has the following definition.

       <xsd:element name="root">
         <xsd:complexType>
           <xsd:sequence minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="row" type="row" />
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:simpleType name="uuid">
         <xsd:restriction base="xsd:string">
           <xsd:pattern value="[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-
                               [0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}" />
         </xsd:restriction>
       </xsd:simpleType>
       <xsd:complexType name="row">
         <xsd:sequence>
           <xsd:element sql:field="MODEL_CATALOG" name="MODEL_CATALOG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="MODEL_SCHEMA" name="MODEL_SCHEMA" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="MODEL_NAME" name="MODEL_NAME" 
                            type="xsd:string" />
           <xsd:element sql:field="COLUMN_NAME" name="COLUMN_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="COLUMN_GUID" name="COLUMN_GUID" 
                            type="uuid" minOccurs="0" />
           <xsd:element sql:field="COLUMN_PROPID" name="COLUMN_PROPID" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="ORDINAL_POSITION" name="ORDINAL_POSITION" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="COLUMN_HAS_DEFAULT" name="COLUMN_HAS_DEFAULT" 
                            type="xsd:boolean" />
           <xsd:element sql:field="COLUMN_DEFAULT" name="COLUMN_DEFAULT" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="COLUMN_FLAGS" name="COLUMN_FLAGS" type="xsd:unsignedInt" />
           <xsd:element sql:field="IS_NULLABLE" name="IS_NULLABLE" type="xsd:boolean" />
           <xsd:element sql:field="DATA_TYPE" name="DATA_TYPE" type="xsd:unsignedShort" />
           <xsd:element sql:field="TYPE_GUID" name="TYPE_GUID" type="uuid" minOccurs="0" />
           <xsd:element sql:field="CHARACTER_MAXIMUM_LENGTH" name="CHARACTER_MAXIMUM_LENGTH" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="CHARACTER_OCTET_LENGTH" name="CHARACTER_OCTET_LENGTH" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="NUMERIC_PRECISION" name="NUMERIC_PRECISION" 
                            type="xsd:unsignedShort" minOccurs="0" />
           <xsd:element sql:field="NUMERIC_SCALE" name="NUMERIC_SCALE" 
                            type="xsd:short" minOccurs="0" />
           <xsd:element sql:field="DATETIME_PRECISION" name="DATETIME_PRECISION" 
                            type="xsd:unsignedInt" minOccurs="0" />
           <xsd:element sql:field="CHARACTER_SET_CATALOG" name="CHARACTER_SET_CATALOG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="CHARACTER_SET_SCHEMA" name="CHARACTER_SET_SCHEMA" 
                             type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="CHARACTER_SET_NAME" name="CHARACTER_SET_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="COLLATION_CATALOG" name="COLLATION_CATALOG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="COLLATION_SCHEMA" name="COLLATION_SCHEMA" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="COLLATION_NAME" name="COLLATION_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DOMAIN_CATALOG" name="DOMAIN_CATALOG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DOMAIN_SCHEMA" name="DOMAIN_SCHEMA" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DOMAIN_NAME" name="DOMAIN_NAME" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DESCRIPTION" name="DESCRIPTION" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="DISTRIBUTION_FLAG" name="DISTRIBUTION_FLAG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="CONTENT_TYPE" name="CONTENT_TYPE" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="MODELING_FLAG" name="MODELING_FLAG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="IS_RELATED_TO_KEY" name="IS_RELATED_TO_KEY" 
                            type="xsd:boolean" />
           <xsd:element sql:field="RELATED_ATTRIBUTE" name="RELATED_ATTRIBUTE" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="IS_INPUT" name="IS_INPUT" type="xsd:boolean" />
           <xsd:element sql:field="IS_PREDICTABLE" name="IS_PREDICTABLE" type="xsd:boolean" />
           <xsd:element sql:field="CONTAINING_COLUMN" name="CONTAINING_COLUMN" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="PREDICTION_SCALAR_FUNCTIONS" 
                             name="PREDICTION_SCALAR_FUNCTIONS" 
                             type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="PREDICTION_TABLE_FUNCTIONS" 
                             name="PREDICTION_TABLE_FUNCTIONS" 
                             type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="IS_POPULATED" name="IS_POPULATED" type="xsd:boolean" />
           <xsd:element sql:field="PREDICTION_SCORE" name="PREDICTION_SCORE" 
                            type="xsd:double" minOccurs="0" />
           <xsd:element sql:field="SOURCE_COLUMN" name="SOURCE_COLUMN" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="FILTER" name="FILTER" type="xsd:string" minOccurs="0" />
         </xsd:sequence>
       </xsd:complexType>