3.1.4.2.2.1.3.68.1 Columns

  • Article

The DISCOVER_XEVENT_OBJECT_COLUMNS rowset contains the following columns.

Name

Type

Restriction

Description

NAME

xsd:string

The name of the column. The name is unique within the object.

COLUMN_ID

xsd:int

The identifier of the column. The COLUMN_ID is unique within the object.

OBJECT_NAME

xsd:string

Yes

The name of the object class to which this column belongs.

OBJECT_PACKAGE_ID

uuid

The unique identifier of the XEvent package that contains the object, as a GUID.

TYPE_NAME

xsd:string

The name of the type for this column.

TYPE_PACKAGE_ID

uuid

The unique identifier of the XEvent package that contains the column data type, as a GUID.

DESCRIPTION

xsd:string

The description of the object column.

COLUMN_VALUE

xsd:string

Displays static values associated with the object column.

COLUMN_TYPE

xsd:string

Indicates how this column is used. Valid values are:

  • Readonly - The column contains a static value that cannot be changed.

  • Data - The column contains run-time data exposed by the object.

  • Customizable - The column contains a value that can be changed.

CAPABILITIES

xsd:int

A bitmask that describes the capabilities of the column.

CAPABILITIES_DESC

xsd:string

A description of the capabilities of this object column. Valid values are:

  • Mandatory - The value MUST be set when binding the parent object to an event session.

  • NULL

The rowset is not sorted.

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="NAME" name="NAME" type="xsd:string" minOccurs="0" />
     <xsd:element sql:field="COLUMN_ID" name="COLUMN_ID" type="xsd:int" minOccurs="0" />
     <xsd:element sql:field="OBJECT_NAME" name="OBJECT_NAME" type="xsd:string" 
                  minOccurs="0" />
     <xsd:element sql:field="OBJECT_PACKAGE_ID" name="OBJECT_PACKAGE_ID" type="uuid" 
                  minOccurs="0" />
     <xsd:element sql:field="TYPE_NAME" name="TYPE_NAME" type="xsd:string" minOccurs="0" />
     <xsd:element sql:field="TYPE_PACKAGE_ID" name="TYPE_PACKAGE_ID" type="uuid" 
                  minOccurs="0" />
     <xsd:element sql:field="DESCRIPTION" name="DESCRIPTION" type="xsd:string" 
                  minOccurs="0" />
     <xsd:element sql:field="COLUMN_VALUE" name="COLUMN_VALUE" type="xsd:string" 
                  minOccurs="0" />
     <xsd:element sql:field="COLUMN_TYPE" name="COLUMN_TYPE" type="xsd:string" 
                  minOccurs="0" />
     <xsd:element sql:field="CAPABILITIES" name="CAPABILITIES" type="xsd:int" minOccurs="0" />
     <xsd:element sql:field="CAPABILITIES_DESC" name="CAPABILITIES_DESC" type="xsd:string" 
                  minOccurs="0" />
   </xsd:sequence>
 </xsd:complexType>