用于 SQL Server 的提供程序统计信息

Microsoft.Data.SqlClient 支持运行时统计信息。 通过将有效 对象上的 属性设置为 来启用统计信息。

启用统计信息后，调用 RetrieveStatistics 以获取 IDictionary 对象中的时间点快照。 枚举其无序名称/值对以读取计数器。 若要重置计数器，请调用 ResetStatistics。

如果尚未启用统计信息，RetrieveStatistics 则返回每个计数器的初始值，而不会引发异常。 禁用统计信息后，计数器将保留收集到该点的值。

所有收集的统计值都是以每个连接为单位的。

可用的统计信息值

Microsoft SQL Server提供程序公开 18 个统计值。 读取字典的 Count 属性以获取可用条目数。 所有计数器都使用 Int64，这种 64 位类型在 C# 中名为 Long，在 Visual Basic 中名为 long。

最大值 Int64.MaxValue为 （2^63）-1。 在该限制下，计数器不再准确。 因此 Int64.MaxValue - 1，统计信息的最大有效值为 （2^63）-2。

备注

字典用于返回提供程序统计信息，因为返回的统计信息的数量、名称和顺序可能会在将来发生变化。 应用程序不应依赖于在字典中找到的特定值，而应检查该值是否存在，并相应地设置分支。

下表描述了可用的统计值。 在 .NET Framework 的地区版本中，各个值的键名未本地化。

键名	说明
BuffersReceived	返回应用程序开始使用提供程序并启用统计信息后，提供程序从 SQL Server 接收到的表格格式数据流 (TDS) 数据包的数量。
BuffersSent	返回启用了统计信息之后，提供程序向 SQL Server 发送的 TDS 数据包的数量。 如果命令较大，可能需要多个缓冲区。 例如，如果将较大的命令发送到服务器，并且它需要六个数据包，则将 ServerRoundtrips 增加 1，将 BuffersSent 增加 6。
BytesReceived	返回在应用程序使用提供程序启动并启用了统计信息之后，提供程序从 SQL Server 接收的 TDS 数据包中的数据字节数。
BytesSent	在应用程序开始使用提供程序并启用统计信息之后，返回发送到 SQL Server 的 TDS 数据包中的数据字节数。
ConnectionTime	连接在统计信息启用之后已打开的时间（如果在打开连接之前就启用了统计信息，则为总连接时间），以毫秒为单位。
CursorOpens	返回在应用程序使用提供程序启动并启用了统计信息之后，通过连接打开游标的次数。 请注意，SELECT 语句返回的只读/仅向前结果不被视为游标，因此不会影响此计数器。
ExecutionTime	返回在启用统计信息之后，提供程序用于处理方面的累计时间（以毫秒为单位），包括等待服务器回复所用的时间以及执行提供程序本身的代码所用的时间。 包含计时代码的类如下： SqlConnection SqlCommand SqlDataReader SqlDataAdapter SqlTransaction SqlCommandBuilder 为了尽可能减少性能关键成员数，不会对以下成员计时： SqlDataReader this[] 运算符 （所有重载） GetBoolean GetChar GetDateTime GetDecimal GetDouble GetFloat GetGuid GetInt16 GetInt32 GetInt64 GetName GetOrdinal GetSqlBinary GetSqlBoolean GetSqlByte GetSqlDateTime GetSqlDecimal GetSqlDouble GetSqlGuid GetSqlInt16 GetSqlInt32 GetSqlInt64 GetSqlMoney GetSqlSingle GetSqlString GetString IsDBNull
IduCount	返回自应用程序开始使用该提供程序并启用统计信息后，通过该连接执行的 INSERT、DELETE 和 UPDATE 语句总数。
IduRows	返回自应用程序开始使用该提供程序并启用统计信息后，通过该连接执行的 INSERT、DELETE 和 UPDATE 语句所影响的总行数。
NetworkServerTime	返回在应用程序使用提供程序启动并启用了统计信息之后，提供程序等待服务器回复所用的累计时间（以毫秒为单位）。
PreparedExecs	返回应用程序开始使用提供程序并启用统计信息后，通过连接执行的预准备命令数量。
Prepares	返回在应用程序使用提供程序启动并启用了统计信息之后，通过连接准备的语句数。
SelectCount	返回应用程序启用统计信息后通过连接执行的 SELECT 语句数。 包括用于从游标中检索行的 FETCH 语句。 对于 SELECT 语句，当 SqlDataReader 到达结果末尾时，提供程序更新计数。
SelectRows	应用程序开始使用提供程序并启用统计信息后，返回选定的行数。 计数器反映了由 SQL 语句生成的所有行，即使调用方实际上未占用这些行。 例如，在读取整个结果集之前关闭数据读取器不会影响计数。 这包括通过 FETCH 语句从游标检索的行。
ServerRoundtrips	返回在应用程序使用提供程序启动并启用了统计信息之后，连接将命令发送到服务器并收到回复的次数。
SumResultSets	返回在应用程序使用提供程序启动并启用了统计信息之后已使用的结果集的数目。 例如，这将包括返回到客户端的任何结果集。 对于游标，每个提取或块提取操作都被视为独立的结果集。
Transactions	返回在应用程序使用提供程序启动并启用了统计信息（包括回滚）后启动的用户事务数。 如果在自动提交启用的情况下运行连接，则每个命令均被视为事务。 无论事务是提交还是稍后回滚，此计数器都会在一执行 BEGIN TRAN 语句就递增事务计数。
UnpreparedExecs	应用程序开始使用提供程序并启用统计信息后，返回通过连接执行的未准备语句的数量。

检索一个值

下面的控制台应用程序显示了如何启用连接的统计信息，检索四个单独的统计值并将它们写出到控制台窗口。

备注

以下示例使用 SQL Server 附带的示例 AdventureWorks 数据库。 示例代码中提供的连接字符串假定数据库已安装并且在本地计算机上可用。 根据环境需要修改连接字符串。

Option Strict On

Imports System
Imports System.Collections
Imports System.Data
Imports Microsoft.Data.SqlClient

Module Module1

  Sub Main()
    Dim connectionString As String = GetConnectionString()

    Using awConnection As New SqlConnection(connectionString)
      ' StatisticsEnabled is False by default.
      ' It must be set to True to start the
      ' statistic collection process.
      awConnection.StatisticsEnabled = True

      Dim productSQL As String = "SELECT * FROM Production.Product"
      Dim productAdapter As _
          New SqlDataAdapter(productSQL, awConnection)

      Dim awDataSet As New DataSet()

      awConnection.Open()

      productAdapter.Fill(awDataSet, "ProductTable")

      ' Retrieve the current statistics as
      ' a collection of values at this point
      ' and time.
      Dim currentStatistics As IDictionary = _
          awConnection.RetrieveStatistics()

      Console.WriteLine("Total Counters: " & _
          currentStatistics.Count.ToString())
      Console.WriteLine()

      ' Retrieve a few individual values
      ' related to the previous command.
      Dim bytesReceived As Long = _
          CLng(currentStatistics.Item("BytesReceived"))
      Dim bytesSent As Long = _
          CLng(currentStatistics.Item("BytesSent"))
      Dim selectCount As Long = _
          CLng(currentStatistics.Item("SelectCount"))
      Dim selectRows As Long = _
          CLng(currentStatistics.Item("SelectRows"))

      Console.WriteLine("BytesReceived: " & bytesReceived.ToString())
      Console.WriteLine("BytesSent: " & bytesSent.ToString())
      Console.WriteLine("SelectCount: " & selectCount.ToString())
      Console.WriteLine("SelectRows: " & selectRows.ToString())

      Console.WriteLine()
      Console.WriteLine("Press any key to continue")
      Console.ReadLine()
    End Using

  End Sub

  Function GetConnectionString() As String
    ' To avoid storing the connection string in your code,
    ' you can retrieve it from a configuration file.
    Return "..."
  End Function
End Module

using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using Microsoft.Data.SqlClient;

namespace CS_Stats_Console_GetValue
{
  class Program
  {
    static void Main(string[] args)
    {
      string connectionString = GetConnectionString();

      using (SqlConnection awConnection =
        new SqlConnection(connectionString))
      {
        // StatisticsEnabled is False by default.
        // It must be set to True to start the
        // statistic collection process.
        awConnection.StatisticsEnabled = true;

        string productSQL = "SELECT * FROM Production.Product";
        SqlDataAdapter productAdapter =
          new SqlDataAdapter(productSQL, awConnection);

        DataSet awDataSet = new DataSet();

        awConnection.Open();

        productAdapter.Fill(awDataSet, "ProductTable");
        // Retrieve the current statistics as
        // a collection of values at this point
        // and time.
        IDictionary currentStatistics =
          awConnection.RetrieveStatistics();

        Console.WriteLine("Total Counters: " +
          currentStatistics.Count.ToString());
        Console.WriteLine();

        // Retrieve a few individual values
        // related to the previous command.
        long bytesReceived =
            (long) currentStatistics["BytesReceived"];
        long bytesSent =
            (long) currentStatistics["BytesSent"];
        long selectCount =
            (long) currentStatistics["SelectCount"];
        long selectRows =
            (long) currentStatistics["SelectRows"];

        Console.WriteLine("BytesReceived: " +
            bytesReceived.ToString());
        Console.WriteLine("BytesSent: " +
            bytesSent.ToString());
        Console.WriteLine("SelectCount: " +
            selectCount.ToString());
        Console.WriteLine("SelectRows: " +
            selectRows.ToString());

        Console.WriteLine();
        Console.WriteLine("Press any key to continue");
        Console.ReadLine();
      }

    }
    private static string GetConnectionString()
    {
      // To avoid storing the connection string in your code,
      // you can retrieve it from a configuration file.
      return "...";
    }
  }
}

检索所有值

下面的控制台应用程序显示了如何启用连接的统计信息，如何使用枚举器检索所有可用的统计信息值并将它们写入控制台窗口。

备注

以下示例使用 SQL Server 附带的示例 AdventureWorks 数据库。 示例代码中提供的连接字符串假定数据库已安装并且在本地计算机上可用。 根据环境需要修改连接字符串。

Option Strict On

Imports System
Imports System.Collections
Imports System.Data
Imports Microsoft.Data.SqlClient

Module Module1
  Sub Main()
    Dim connectionString As String = GetConnectionString()

    Using awConnection As New SqlConnection(connectionString)
      ' StatisticsEnabled is False by default.
      ' It must be set to True to start the
      ' statistic collection process.
      awConnection.StatisticsEnabled = True

      Dim productSQL As String = "SELECT * FROM Production.Product"
      Dim productAdapter As _
          New SqlDataAdapter(productSQL, awConnection)

      Dim awDataSet As New DataSet()

      awConnection.Open()

      productAdapter.Fill(awDataSet, "ProductTable")

      ' Retrieve the current statistics as
      ' a collection of values at this point
      ' and time.
      Dim currentStatistics As IDictionary = _
          awConnection.RetrieveStatistics()

      Console.WriteLine("Total Counters: " & _
          currentStatistics.Count.ToString())
      Console.WriteLine()

      Console.WriteLine("Key Name and Value")

      ' Note the entries are unsorted.
      For Each entry As DictionaryEntry In currentStatistics
        Console.WriteLine(entry.Key.ToString() & _
            ": " & entry.Value.ToString())
      Next

      Console.WriteLine()
      Console.WriteLine("Press any key to continue")
      Console.ReadLine()
    End Using

  End Sub

  Function GetConnectionString() As String
    ' To avoid storing the connection string in your code,
    ' you can retrieve it from a configuration file.
    Return "..."
  End Function
End Module

using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
using System.Data;
using Microsoft.Data.SqlClient;

namespace CS_Stats_Console_GetAll
{
  class Program
  {
    static void Main(string[] args)
    {
      string connectionString = GetConnectionString();

      using (SqlConnection awConnection =
        new SqlConnection(connectionString))
      {
        // StatisticsEnabled is False by default.
        // It must be set to True to start the
        // statistic collection process.
        awConnection.StatisticsEnabled = true;

        string productSQL = "SELECT * FROM Production.Product";
        SqlDataAdapter productAdapter =
            new SqlDataAdapter(productSQL, awConnection);

        DataSet awDataSet = new DataSet();

        awConnection.Open();

        productAdapter.Fill(awDataSet, "ProductTable");

        // Retrieve the current statistics as
        // a collection of values at this point
        // and time.
        IDictionary currentStatistics =
            awConnection.RetrieveStatistics();

        Console.WriteLine("Total Counters: " +
            currentStatistics.Count.ToString());
        Console.WriteLine();

        Console.WriteLine("Key Name and Value");

        // Note the entries are unsorted.
        foreach (DictionaryEntry entry in currentStatistics)
        {
          Console.WriteLine(entry.Key.ToString() +
              ": " + entry.Value.ToString());
        }

        Console.WriteLine();
        Console.WriteLine("Press any key to continue");
        Console.ReadLine();
      }

    }
    private static string GetConnectionString()
    {
      // To avoid storing the connection string in your code,
      // you can retrieve it from a configuration file.
      return "...";
    }
  }
}

请参阅

• SQL Server 和 ADO.NET
• ADO.NET 概述