sys.fn_MSxe_read_event_stream(Transact-SQL)

适用于:SQL ServerAzure SQL 数据库Azure SQL 托管实例

sys.fn_MSxe_read_event_stream 返回二进制数据供 QueryableXEventData .NET 类内部使用。 SQL Server Management Studio (SSMS) 中的扩展事件 UI 使用此类读取事件会话数据。

若要查看人工可读事件数据,请使用以下项之一,而不是直接调用 sys.fn_MSxe_read_event_stream

Transact-SQL 语法约定

语法

sys.fn_MSxe_read_event_stream ( source , source_option )

参数

函数返回的事件数据的特定源。 nvarchar(260), 没有默认值。

根据 source_option的值以不同的方式解释:

source_option 的解释
0 是启动的事件会话的名称。
1 是要读取的事件会话日志文件的路径。

在本地文件系统中与文件一起使用时, 必须包含事件会话日志文件的名称,并且可以作为通配符包含 *

在 Azure 存储容器中与 Blob 一起使用时, 是由两个部分的串联构造的 HTTP URL:

1.Azure 存储存储容器的路径,后跟斜杠(/)。
2. 应读取的容器中 blob 名称的常见前缀。

例如,用作https://<storage-account-name>.blob.core.windows.net/container-name>/xe_session从名称开头xe_session的所有 Blob 检索数据,而不考虑 blob 名称的其余部分(包括扩展)。 无法指定通配符。 必须存在允许访问 Azure 存储容器的凭据。

source_option

确定事件数据源类型的选项。 可能的值为:

价值 说明
0 从启动事件会话 event_stream 目标返回事件数据。 函数无限期执行,在会话生成时返回新事件数据。
1 指定的扩展事件日志文件返回事件数据。

返回的表

列名称 数据类型 说明
类型 int 事件类型。 不可为 Null。
数据 image 二进制事件数据。 可以为 Null。