3.1.4.2.2.1.3.28.1 Columns

  • Article

The DMSCHEMA_MINING_STRUCTURE_COLUMNS rowset contains the following columns.

Name

Type

Restriction

Description

STRUCTURE_CATALOG

xsd:string

Yes

The catalog name.

STRUCTURE_SCHEMA

xsd:string

Yes

The unqualified schema name.<295>

STRUCTURE_NAME

xsd:string

Yes

The structure name. This column cannot contain a NULL.

COLUMN_NAME

xsd:string

Yes

The name of the column. Uniqueness is guaranteed only among columns that share the same pattern. For example, two nested columns can have the same name if they belong to two different nested tables inside the same structure.

COLUMN_GUID

uuid

The column GUID.

COLUMN_PROPID

xsd:unsignedInt

The column property ID.

ORDINAL_POSITION

xsd:unsignedInt

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

COLUMN_HASDEFAULT

xsd:boolean

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

True if the column has a default value.

False if the column does not have a default value or if it is unknown whether the column has a default value.<296>

COLUMN_DEFAULT

xsd:string

The default value of the column.<297>

COLUMN_FLAGS

xsd:unsignedInt

A bitmask that describes column characteristics. The DBCOLUMNFLAGS enumerated type specifies the bits in the bitmask. This column cannot contain a NULL value. Valid values include the following:

0x10 - DBCOLUMNFLAGS_ISFIXEDLENGTH – Set if all data in the column has the same length.

0x20 - DBCOLUMNFLAGS_ISNULLABLE – Set if consumer can set the column to NULL or if the provider cannot determine if the column can be set to NULL.

0x40 - DBCOLUMNFLAGS_MAYBENULL – Set if the column can contain NULL values, or if the provider cannot guarantee that the column cannot contain NULL values.

0x80 - DBCOLUMNFLAGS_ISLONG – Set if the column contains a BLOB that contains very long data.

IS_NULLABLE

xsd:boolean

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

True if the column can contain NULL; otherwise, false.

DATA_TYPE

xsd:unsignedShort

The indicator of the column's data type.

  • "TABLE" = DBTYPE_HCHAPTER (16)

  • "TEXT" = DBTYPE_WSTR (130)

  • "LONG" = DBTYPE_I8 (20)

  • "DOUBLE" = DBTYPE_R8 (5)

  • "DATE" = DBTYPE_DATE (7)

TYPE_GUID

uuid

The GUID of the column's data type. Servers that do not use GUIDs to identify data types are to return NULL in this column.

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, respectively, if the 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, respectively, 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. 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 definition of the column.

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 is NULL.<298>

DATETIME_PRECISION

xsd:unsignedInt

The date/time precision (the number of digits in the fractional seconds portion) of the column if the column is a DateTime or Interval type. If the column's data type is not DateTime, this is NULL.

CHARACTER_SET_CATALOG

xsd:string

The catalog name in which the character set is defined. NULL if the server does not support catalogs or different character sets.

CHARACTER_SET_SCHEMA

xsd:string

The unqualified schema name in which the character set is defined.<299>

CHARACTER_SET_NAME

xsd:string

The character set name. NULL if the server does not support different character sets.

COLLATION_CATALOG

xsd:string

The catalog name in which the collation is defined. NULL if the server does not support catalogs or different collations.

COLLATION_SCHEMA

xsd:string

The unqualified schema name in which the collation is defined. NULL if the server does not support schemas or different collations.

COLLATION_NAME

xsd:string

The collation name. NULL if the server does not support different collations.

DOMAIN_CATALOG

xsd:string

The catalog name in which the domain is defined. NULL if the server does not support catalogs or domains.

DOMAIN_SCHEMA

xsd:string

The unqualified schema name in which the domain is defined. NULL if the server does not support schemas or domains.

DOMAIN_NAME

xsd:string

The domain name. NULL if the server does not support domains.

DESCRIPTION

xsd:string

The human-readable description of the column. NULL if no description is associated with the column.

DISTRIBUTION_FLAG

xsd:string

The distribution of the mining structure column. This value can be empty or be one of the following:

  • NORMAL

  • LOG_NORMAL

  • UNIFORM

CONTENT_TYPE

xsd:string

The content type of the mining structure column. This value is one of the following:

  • KEY

  • DISCRETE

  • CONTINUOUS

  • DISCRETIZED(arguments)

  • ORDERED

  • SEQUENCE_TIME

  • CYCLICAL

  • PROBABILITY

  • VARIANCE

  • STDEV

  • SUPPORT

  • PROBABILITY_VARIANCE

  • PROBABILITY_STDEV

MODELING_FLAG

xsd:string

A comma-delimited list of modeling flags. The only supported MODELING_FLAG column for a mining structure column is "NOT NULL".

IS_RELATED_TO_KEY

xsd:boolean

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

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

RELATED_ATTRIBUTE

xsd:string

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

CONTAINING_COLUMN

xsd:string

The name of the TABLE column containing this column. NULL if no table contains the column.

IS_POPULATED

xsd:boolean

A Boolean that indicates whether this column has learned a set of possible values.

True if the column has learned a set of possible values; otherwise false.

The rowset is sorted on STRUCTURE_CATALOG, STRUCTURE_SCHEMA, STRUCTURE_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="STRUCTURE_CATALOG" name="STRUCTURE_CATALOG" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="STRUCTURE_SCHEMA" name="STRUCTURE_SCHEMA" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="STRUCTURE_NAME" name="STRUCTURE_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_HASDEFAULT" name="COLUMN_HASDEFAULT" 
                            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="CONTAINING_COLUMN" name="CONTAINING_COLUMN" 
                            type="xsd:string" minOccurs="0" />
           <xsd:element sql:field="IS_POPULATED" name="IS_POPULATED" type="xsd:boolean" />
         </xsd:sequence>
       </xsd:complexType>