ODBC ドライバーのパフォーマンスのプロファイル

[アーティクル]
01/10/2024

適用対象:SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

このサンプルでは、パフォーマンス統計を記録するための ODBC ドライバー固有のSQL Serverオプションを示します。このサンプルでは、1 つのファイル (odbcperf.log) を作成します。このサンプルを通じて、パフォーマンスデータのログファイルの作成と、SQLPERF データ構造体からのパフォーマンスデータの直接表示の例を確認できます (SQLPERF 構造体は Odbcss.h で定義されます)。このサンプルは、ODBC 3.0 以降のバージョン用に開発されました。

重要

可能な場合は、Windows 認証を使用します。 Windows 認証が使用できない場合は、実行時に資格情報を入力するようユーザーに求めます。資格情報をファイルに保存するのは避けてください。資格情報を保持する必要がある場合は、Win32 Crypto API を使用して暗号化してください。

ODBC アドミニストレーターを使用してドライバーのパフォーマンスデータをログに記録するには

コントロールパネルで、[管理ツール] をダブルクリックし、[データソース (ODBC)] をダブルクリックします。または、odbcad32.exe を呼び出すことができます。
[ ユーザー DSN]、[ システム DSN]、または [ ファイル DSN ] タブをクリックします。
パフォーマンスのログを記録するデータソースをクリックします。
[構成] をクリックします。
Microsoft SQL Server DSN の構成ウィザードで、ODBC ドライバーの統計情報をログファイルに記録するページに移動します。
[ 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 を呼び出して、パフォーマンスデータのプロファイリングを開始します。
SQL_COPT_SS_PERF_DATAと SQLPERF 構造体へのポインターのアドレスを使用して SQLGetConnectAttr を呼び出します。最初の呼び出しでは、現在のパフォーマンスデータを含む有効な SQLPERF 構造体のアドレスを指すポインターが設定されます。ドライバーは、パフォーマンス構造体内のデータを継続的に更新しません。アプリケーションでは、より新しいパフォーマンスデータを使用して構造体を更新する必要がある場合は常に、SQLGetConnectAttr の呼び出しを繰り返す必要があります。
SQL_COPT_SS_PERF_DATAとSQL_PERF_STOPを指定して SQLSetConnectAttr を呼び出して、パフォーマンスデータのログ記録を停止します。

例

AdventureWorks と呼ばれる ODBC データソース (既定のデータベースは AdventureWorks サンプルデータベース) が必要です (AdventureWorks サンプルデータベースは、Microsoft SQL Server サンプルとコミュニティプロジェクトのホームページからダウンロードできます)。このデータソースは、オペレーティングシステムによって提供される ODBC ドライバーに基づいている必要があります (ドライバー名は "SQL Server")。このサンプルを 64 ビットオペレーティングシステムで 32 ビットアプリケーションとしてビルドし、実行する場合、%windir%\SysWOW64\odbcad32.exe の ODBC アドミニストレーターを使用して ODBC データソースを作成する必要があります。

このサンプルでは、コンピューターの既定のSQL Server インスタンスに接続します。名前付きインスタンスに接続するには、ODBC データソースの定義を変更し、server\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 アドミニストレーターを使用してドライバーのパフォーマンスデータをログに記録するには

ドライバーのパフォーマンスデータをプログラムを使用してログに記録するには

ドライバーのパフォーマンスデータをアプリケーションにプルするには

例

参照

フィードバック

フィードバック

その他のリソース

次の方法で共有

ODBC ドライバーのパフォーマンスのプロファイル

ODBC アドミニストレーターを使用してドライバーのパフォーマンス データをログに記録するには

ドライバーのパフォーマンス データをプログラムを使用してログに記録するには

ドライバーのパフォーマンス データをアプリケーションにプルするには

例

参照

フィードバック

フィードバック

その他のリソース

ODBC アドミニストレーターを使用してドライバーのパフォーマンスデータをログに記録するには

ドライバーのパフォーマンスデータをプログラムを使用してログに記録するには

ドライバーのパフォーマンスデータをアプリケーションにプルするには