SQLStatistics 関数

SQLStatistics は、1 つのテーブルとテーブルに関連付けられているインデックスに関する統計の一覧を取得します。 ドライバーは、結果セットとして情報を返します。

準拠

導入されたバージョン: ODBC 1.0 標準コンプライアンス: ISO 92

構文

SQLRETURN SQLStatistics(
     SQLHSTMT        StatementHandle ,
     SQLCHAR *       CatalogName ,
     SQLSMALLINT     NameLength1 ,
     SQLCHAR *       SchemaName ,
     SQLSMALLINT     NameLength2 ,
     SQLCHAR *       TableName ,
     SQLSMALLINT     NameLength3 ,
     SQLUSMALLINT    Unique ,
     SQLUSMALLINT    Reserved);

論争

StatementHandle

[入力]ステートメント ハンドル。

CatalogName

[入力]カタログ名。 ドライバーが一部のテーブルのカタログをサポートしているが、他のテーブルではサポートされていない場合 (ドライバーが異なる DBMS からデータを取得する場合など)、空の文字列 ("") はカタログがないテーブルを示します。 CatalogName に文字列検索パターンを含めることはできません。

SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、CatalogName は識別子として扱われ、大文字と小文字は区別されません。 SQL_FALSEの場合、CatalogName は通常の引数です。リテラルとして扱われ、大文字と小文字は重要です。 詳細については、「 カタログ関数の引数」を参照してください。

NameLength1

[入力] CatalogName の文字数。

SchemaName

[入力]スキーマ名。 ドライバーが一部のテーブルのスキーマをサポートしているが、他のテーブルではサポートされていない場合 (ドライバーが異なる DBMS からデータを取得する場合など)、空の文字列 ("") はスキーマを持たないテーブルを示します。 SchemaName に文字列検索パターンを含めることはできません。

SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、SchemaName は識別子として扱われ、大文字と小文字は区別されません。 SQL_FALSEの場合、SchemaName は通常の引数です。リテラルで扱われ、大文字と小文字は重要です。

NameLength2

[入力] SchemaName の文字数。

テーブル名

[入力]テーブル名。 この引数を null ポインターにすることはできません。 TableName に文字列検索パターンを含めることはできません。

SQL_ATTR_METADATA_ID ステートメント属性が SQL_TRUE に設定されている場合、TableName は識別子として扱われ、大文字と小文字は区別されません。 SQL_FALSEの場合、TableName は通常の引数です。リテラルで扱われ、その大文字と小文字は重要です。

NameLength3

[入力] TableName の文字数。

ユニーク

[入力]インデックスの種類: SQL_INDEX_UNIQUE または SQL_INDEX_ALL。

予約済み

[入力]結果セット内の CARDINALITY 列と PAGES 列の重要度を示します。 次のオプションは、 CARDINALITY 列と PAGES 列の戻り値にのみ影響します。 CARDINALITY および PAGES が返されない場合でも、インデックス情報が返されます。

SQL_ENSURE は、ドライバーが統計を無条件に取得することを要求します。 (Open Group 標準にのみ準拠し、ODBC 拡張機能をサポートしていないドライバーは、 SQL_ENSUREをサポートできません)。

SQL_QUICK は、ドライバーが CARDINALITY を取得し、サーバーからすぐに使用できる場合にのみ PAGES を要求します。 この場合、ドライバーは値が最新であることを確認しません。 (Open Group 標準に書き込まれたアプリケーションは、常に ODBC SQL_QUICK 準拠ドライバーから動作を取得します)。

返品ポリシー

SQL_SUCCESS、 SQL_SUCCESS_WITH_INFO、 SQL_STILL_EXECUTING、 SQL_ERROR、または SQL_INVALID_HANDLE。

Diagnostics

SQLStatisticsがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合は、関連付けられているSQLSTATE値を取得するには、SQLGetDiagRec の HandleType と SQL_HANDLE_STMT のハンドルを使用してを呼び出します。 次の表に、SQLSTATEによって通常返されるSQLStatistics値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。(DM)表記は、ドライバー マネージャーによって返される各SQLSTATEの説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられているリターン コードは SQL_ERROR。

Comments

SQLStatistics は、1 つのテーブルに関する情報を、 NON_UNIQUE、 TYPE、 INDEX_QUALIFIER、 INDEX_NAME、および ORDINAL_POSITION順に並べ替えられた標準の結果セットとして返します。 結果セットは、テーブルの統計情報 (結果セットの CARDINALITY 列と PAGES 列) と各インデックスに関する情報を結合します。 この情報の使用方法については、「 カタログ データの使用」を参照してください。

TABLE_CAT、TABLE_SCHEM、TABLE_NAME、およびCOLUMN_NAMEの列の実際の長さを判断するために、アプリケーションはSQLGetInfo、SQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、およびSQL_MAX_TABLE_NAME_LENオプションを使用してSQL_MAX_COLUMN_NAME_LENを呼び出すことができます。

ODBC 3.x では、次の列の名前が変更されました。 列名の変更は、アプリケーションが列番号でバインドされるため、下位互換性には影響しません。

次の表に、結果セットの列を示します。 列 13 (FILTER_CONDITION) を超える追加の列は、ドライバーによって定義できます。 アプリケーションは、明示的な序数位置を指定するのではなく、結果セットの末尾からカウントダウンすることで、ドライバー固有の列にアクセスできるようにする必要があります。 詳細については、「 カタログ関数によって返されるデータ」を参照してください。

結果セットの行がテーブルに対応する場合、ドライバーは TYPE を SQL_TABLE_STAT に設定し、 NON_UNIQUE、 INDEX_QUALIFIER、 INDEX_NAME、 ORDINAL_POSITION、 COLUMN_NAME、および ASC_OR_DESC を NULLに設定します。 データ ソースから CARDINALITY または PAGES を使用できない場合、ドライバーはそれらを NULLに設定します。

コード例

同様の関数のコード例については、「 SQLColumns 関数」を参照してください。

関連する関数

関連コンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル