sys.dm_xe_object_columns (Transact-SQL)

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance

Returns the schema information for all the objects.

Note

Event objects expose fixed schemas for both read-only and read-write data.

Column name Data type Description
name nvarchar(256) The name of the column. name is unique within the object. Is not nullable.
column_id int The identifier of the column. column_id is unique within the object when used with column_type. Is not nullable.
object_name nvarchar(256) The name of the object to which this column belongs. There is a many-to-one relationship with sys.dm_xe_objects.id. Is not nullable.
object_package_guid uniqueidentifier The GUID of the package that contains the object. Is not nullable.
type_name nvarchar(256) The name of the type for this column. Is not nullable.
type_package_guid uniqueidentifier The GUID of the package that contains the column data type. Is not nullable.
column_type nvarchar(60) Indicates how this column is used. Is not nullable. column_type can be one of the following:

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.

Note: Changing this value can modify the behavior of the object.
column_value nvarchar(256) Displays static values associated with the object column. Is nullable.
capabilities int A bitmap describing the capabilities of the column. Is nullable.
capabilities_desc nvarchar(256) A description of this object column's capabilities. This value can be one of the following:

Mandatory. The value must be set when binding the parent object to an event session.

Is nullable.
description nvarchar(3072) The description of this object column. Is nullable.

Permissions

Requires VIEW SERVER STATE permission on the server.

Permissions for SQL Server 2022 and later

Requires VIEW SERVER PERFORMANCE STATE permission on the server.

Relationship cardinalities

From To Relationship
sys.dm_xe_object_columns.object_name, sys.dm_xe_object_columns.object_package_guid sys.dm_xe_objects.name,

sys.dm_xe_objects.package_guid
Many-to-one
sys.dm_xe_object_columns.type_name

sys.dm_xe_object_columns.type_package_guid
sys.dm_xe_objects.name

sys.dm_xe_objects.package_guid
Many-to-one

Next steps

Learn more about related concepts in the following articles: