分析驱动程序性能数据（ODBC）

2017-03-06

此示例显示了用于记录性能统计信息的 SQL Server ODBC 驱动程序特定选项。此示例创建一个文件：odbcperf.log。此示例演示了如何创建性能数据日志文件，以及直接从 SQLPERF 数据结构显示性能数据（SQLPERF 结构在 Odbcss.h 中定义）。此示例是为 ODBC 3.0 或更高版本开发的。

重要

请尽可能使用 Windows 身份验证。如果 Windows 身份验证不可用，则提示用户在运行时输入其凭据。避免将凭据存储在文件中。如果必须保留凭据，则应使用 Win32 加密 API 对其进行加密。

使用 ODBC 管理员记录驱动程序性能数据

在“控制面板”中，双击“管理工具”，然后双击“数据源”（ODBC）。 或者，可以调用 odbcad32.exe。
单击“ 用户 DSN”、“ 系统 DSN”或“ 文件 DSN ”选项卡。
单击要记录其性能的数据源。
单击 “配置” 。
在Microsoft SQL Server 配置 DSN 向导中，导航到包含 Log ODBC 驱动程序统计信息的页面，转到日志文件。
选择 日志文件的 Log ODBC 驱动程序统计信息。在框中，放置应记录统计信息的文件的名称。（可选）单击“ 浏览” 浏览文件系统以获取统计信息日志。

以编程方式记录驱动程序性能数据

使用SQL_COPT_SS_PERF_DATA_LOG以及性能数据日志文件的完整路径和文件名调用 SQLSetConnectAttr 。例如：
```
"C:\\Odbcperf.log"  
```
使用 SQL_COPT_SS_PERF_DATA 和 SQL_PERF_START 调用 SQLSetConnectAttr 以开始记录性能数据。
（可选）使用 SQL_COPT_SS_LOG_NOW 和 NULL 调用 SQLSetConnectAttr ，将性能数据以制表符分隔的记录写入性能数据日志文件。应用程序运行时，此作可以多次完成。
使用 SQL_COPT_SS_PERF_DATA 和 SQL_PERF_STOP 调用 SQLSetConnectAttr 以停止记录性能数据。

将驱动程序性能数据拉取到应用程序中

使用 SQL_COPT_SS_PERF_DATA 和 SQL_PERF_START 调用 SQLSetConnectAttr 以开始分析性能数据。
使用指向 SQLPERF 结构的指针SQL_COPT_SS_PERF_DATA和地址调用 SQLGetConnectAttr 。第一个此类调用设置指向包含当前性能数据的有效 SQLPERF 结构的地址的指针。驱动程序不会持续刷新性能结构中的数据。应用程序必须随时重复对 SQLGetConnectAttr 的调用，以使用更当前的性能数据刷新结构。
使用 SQL_COPT_SS_PERF_DATA 和 SQL_PERF_STOP 调用 SQLSetConnectAttr 以停止记录性能数据。

示例：

需要一个名为 AdventureWorks 的 ODBC 数据源，其默认数据库是 AdventureWorks 示例数据库。（可以从 Microsoft SQL Server 示例和社区项目主页下载 AdventureWorks 示例数据库。此数据源必须基于作系统提供的 ODBC 驱动程序（驱动程序名称为“SQL Server”）。如果要在 64 位作系统上生成并运行此示例作为 32 位应用程序，则必须在 %windir%\SysWOW64\odbcad32.exe中使用 ODBC 管理员创建 ODBC 数据源。

此示例连接到计算机的默认 SQL Server 实例。若要连接到命名实例，请更改 ODBC 数据源的定义，以使用以下格式指定实例：服务器\namedinstance。默认情况下，SQL Server Express 安装到命名实例。

使用 odbc32.lib 进行编译。

// compile with: odbc32.lib  
#include <stdio.h>  
#include <string.h>  
#include <windows.h>  
#include <sql.h>  
#include <sqlext.h>  
#include <odbcss.h>  
  
SQLHENV henv = SQL_NULL_HENV;  
SQLHDBC hdbc1 = SQL_NULL_HDBC;       
SQLHSTMT hstmt1 = SQL_NULL_HSTMT;  
  
void Cleanup() {  
   if (hstmt1 != SQL_NULL_HSTMT)  
      SQLFreeHandle(SQL_HANDLE_STMT, hstmt1);  
  
   if (hdbc1 != SQL_NULL_HDBC) {  
      SQLDisconnect(hdbc1);  
      SQLFreeHandle(SQL_HANDLE_DBC, hdbc1);  
   }  
  
   if (henv != SQL_NULL_HENV)  
      SQLFreeHandle(SQL_HANDLE_ENV, henv);  
}  
  
int main() {  
   RETCODE retcode;  
  
   // Pointer to the ODBC driver performance structure.  
   SQLPERF *PerfPtr;  
   SQLINTEGER cbPerfPtr;  
  
   // Allocate the ODBC environment and save handle.  
   retcode = SQLAllocHandle (SQL_HANDLE_ENV, NULL, &henv);  
   if( (retcode != SQL_SUCCESS_WITH_INFO) && (retcode != SQL_SUCCESS)) {  
      printf("SQLAllocHandle(Env) Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Notify ODBC that this is an ODBC 3.0 app.  
   retcode = SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION, (SQLPOINTER) SQL_OV_ODBC3, SQL_IS_INTEGER);  
   if( (retcode != SQL_SUCCESS_WITH_INFO) && (retcode != SQL_SUCCESS)) {  
      printf("SQLSetEnvAttr(ODBC version) Failed\n\n");  
      Cleanup();  
      return(9);      
   }  
  
   // Allocate ODBC connection handle and connect.  
   retcode = SQLAllocHandle(SQL_HANDLE_DBC, henv, &hdbc1);  
   if( (retcode != SQL_SUCCESS_WITH_INFO) && (retcode != SQL_SUCCESS)) {  
      printf("SQLAllocHandle(hdbc1) Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // This sample use Integrated Security. Please create the SQL Server   
   // DSN by using the Windows NT authentication.   
   retcode = SQLConnect(hdbc1, (UCHAR*)"AdventureWorks", SQL_NTS, (UCHAR*)"", SQL_NTS, (UCHAR*)"", SQL_NTS);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLConnect() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Set options to log performance statistics.  Specify file to use for the log.  
   retcode = SQLSetConnectAttr( hdbc1, SQL_COPT_SS_PERF_DATA_LOG, &"odbcperf.log", SQL_NTS);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLSetConnectAttr() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Start the performance statistics log.  
   retcode =   
      SQLSetConnectAttr( hdbc1, SQL_COPT_SS_PERF_DATA, (SQLPOINTER)SQL_PERF_START, SQL_IS_UINTEGER);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLSetConnectAttr() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Allocate statement handle, then execute command.  
   retcode = SQLAllocHandle(SQL_HANDLE_STMT, hdbc1, &hstmt1);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLAllocHandle() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   retcode = SQLExecDirect(hstmt1, (UCHAR*)"SELECT * FROM Purchasing.Vendor", SQL_NTS);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLExecDirect() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Clear any result sets generated.  
   while ( ( retcode = SQLMoreResults(hstmt1) ) != SQL_NO_DATA ) {  
      if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
         printf("SQLMoreResults() Failed\n\n");  
         Cleanup();  
         return(9);  
      }  
   }  
  
   retcode = SQLExecDirect(hstmt1, (UCHAR*)"SELECT * FROM Sales.Store", SQL_NTS);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLExecDirect() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Clear any result sets generated.  
   while ( ( retcode = SQLMoreResults(hstmt1) ) != SQL_NO_DATA ) {  
      if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
         printf("SQLMoreResults() Failed\n\n");  
         Cleanup();  
         return(9);  
      }  
   }  
  
   // Generate a long-running query.  
   retcode = SQLExecDirect(hstmt1, (UCHAR*)"waitfor delay '00:00:04' ", SQL_NTS);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLExecDirect() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Clear any result sets generated.  
   while ( ( retcode = SQLMoreResults(hstmt1) ) != SQL_NO_DATA ) {  
      if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
         printf("SQLMoreResults() Failed\n\n");  
         Cleanup();  
         return(9);  
      }  
   }  
  
   // Write current statistics to the performance log.  
   retcode =   
      SQLSetConnectAttr( hdbc1, SQL_COPT_SS_PERF_DATA_LOG_NOW, (SQLPOINTER)NULL, SQL_IS_UINTEGER);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLSetConnectAttr() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   // Get pointer to current SQLPerf structure.  
   // Print a couple of statistics.  
   retcode =   
      SQLGetConnectAttr( hdbc1, SQL_COPT_SS_PERF_DATA, (SQLPOINTER)&PerfPtr, SQL_IS_POINTER, &cbPerfPtr);  
   if( (retcode != SQL_SUCCESS) && (retcode != SQL_SUCCESS_WITH_INFO) ) {  
      printf("SQLGetConnectAttr() Failed\n\n");  
      Cleanup();  
      return(9);  
   }  
  
   printf("SQLSelects = %d, SQLSelectRows = %d\n", PerfPtr->SQLSelects, PerfPtr->SQLSelectRows);  
  
   // Cleanup  
   SQLFreeHandle(SQL_HANDLE_STMT, hstmt1);  
   SQLDisconnect(hdbc1);  
   SQLFreeHandle(SQL_HANDLE_DBC, hdbc1);  
   SQLFreeHandle(SQL_HANDLE_ENV, henv);  
}

另请参阅

分析 ODBC 驱动程序性能作指南主题（ODBC）
分析 ODBC 驱动程序性能

通过

分析驱动程序性能数据（ODBC）

使用 ODBC 管理员记录驱动程序性能数据

以编程方式记录驱动程序性能数据

将驱动程序性能数据拉取到应用程序中

示例：

另请参阅

其他资源