SQLColumnPrivileges() - 列特権の取得

SQLColumnPrivileges() は、指定された表の列とそれに関連した特権のリストを戻します。情報は、SQL 結果セットとして戻されます。 この結果セットは、照会で生成される結果セットの処理に使用するものと同じ関数を使用して、 取り出すことができます。

SQLColumnPrivileges() の ODBC 仕様

表 1. SQLColumnPrivileges() の仕様
ODBC 仕様レベル X/Open CLI CAE 仕様 ISO CLI 仕様
1.0 なし なし

構文

SQLRETURN SQLColumnPrivileges  (SQLHSTMT        hstmt,
                                SQLCHAR    FAR  *szCatalogName,
                                SQLSMALLINT     cbCatalogName,
                                SQLCHAR    FAR  *szSchemaName,
                                SQLSMALLINT     cbSchemaName,
                                SQLCHAR    FAR  *szTableName,
                                SQLSMALLINT     cbTableName,
                                SQLCHAR    FAR  *szColumnName,
                                SQLSMALLINT     cbColumnName);

関数の引数

表 2 は、この関数のそれぞれの引数ごとに、 データ・タイプ、用途、および説明を示しています。

表 2. SQLColumnPrivileges() の引数
データ・タイプ 引数 使用法 説明
SQLHSTMT hstmt 入力 ステートメント・ハンドル。
SQLCHAR * szCatalogName 入力 3 部構成の表名のカタログ修飾子。 これは、NULL ポインターまたは長さゼロの ストリングでなければなりません。
SQLSMALLINT cbCatalogName 入力 szCatalogName の長さ (バイト) を指定します。これは、0 に設定する必要があります。
SQLCHAR * szSchemaName 入力 表名のスキーマ修飾子。
SQLSMALLINT cbSchemaName 入力 szSchemaName の長さ (バイト)。
SQLCHAR * szTableName 入力 表名。
SQLSMALLINT cbTableName 入力 szTableName の長さ (バイト)。
SQLCHAR * szColumnName 入力 列名によって結果セットを修飾するパターン値を入れる ことができるバッファー。
SQLSMALLINT cbColumnName 入力 szColumnName の長さ (バイト)。

使用法

結果は 表 3 にリストされている列を含む標準結果セット として戻されます。結果セットは、TABLE_CAT、TABLE_SCHEM、TABLE_NAME、 COLUMN_NAME、および PRIVILEGE の順序になります。 複数の特権がいずれか特定の列に関連付けられている場合、それぞれの特権は 個別の行として戻されます。 一般には、SQLColumns() を呼び出して列特権情報を判別してから、 この関数を呼び出します。 アプリケーションは、SQLColumns() 結果セットの TABLE_SCHEM、 TABLE_NAME、COLUMN_NAME 列に戻される文字ストリングを、この関数への入力引数として使用する必要があります。

SQLColumnPrivileges() を頻繁に呼び出すと、結果として複雑で高価なカタログ照会になるため、 この呼び出しは慎重に使用し、呼び出しを繰り返すよりも結果を保管するようにしてください。

カタログ関数の結果セットの VARCHAR 列は、128 バイトの最大長属性で 宣言されています (ANSI/ISO SQL 規格 (1992) の制限と整合性あり)。Db2® 名は 128 文字より 短いため、アプリケーションでは 128 文字 (NUL 終止符をプラス) を 出力バッファーとして必ず設定しておいて構いません。 あるいは、引数 InfoType を以下のそれぞれの値に 設定して、SQLGetInfo() を呼び出すことができます。
  • SQL_MAX_CATALOG_NAME_LEN -- 接続されたデータベース管理システムがサポートする TABLE_CAT 列の長さを判別
  • SQL_MAX_SCHEMA_NAME_LEN -- 接続されたデータベース管理システムがサポートする TABLE_SCHEM 列の長さを判別
  • SQL_MAX_TABLE_NAME_LEN -- 接続されたデータベース管理システムがサポートする TABLE_NAME 列の長さを判別
  • SQL_MAX_COLUMN_NAME_LEN -- 接続されたデータベース管理システムがサポートする COLUMN_NAME 列の長さを判別

szColumnName 引数は検索パターンを受け入れることに注意 してください。

将来のリリースでは、列が新たに追加されたり、既存の列の名前が 変更される可能性はありますが、現行の列の位置が変更されることはありま せん。次の表は、現在、SQLColumnPrivileges() が戻す結果セット の列を示しています。

表 3. SQLColumnPrivileges() で戻される列
列番号 列名 データ・タイプ 説明
1 TABLE_CAT VARCHAR(128) これは常に NULL です。
2 TABLE_SCHEM VARCHAR(128) TABLE_NAME を含むスキーマの名前を示します。
3 TABLE_NAME VARCHAR(128) not NULL 表またはビューの名前を示します。
4 COLUMN_NAME VARCHAR(128) not NULL 指定された表またはビューの列の名前を示します。
5 GRANTOR VARCHAR(128) 特権を付与したユーザーの許可 ID を示します。
6 GRANTEE VARCHAR(128) 特権が付与されたユーザーの許可 ID を示します。
7 PRIVILEGE VARCHAR(128) 列特権を示します。 これには、以下のものがあります。
  • ALTER
  • CONTROL
  • DELETE
  • INDEX
  • INSERT
  • REFERENCES
  • SELECT
  • UPDATE

サポートされる特権は、接続しているデータ・ソースに基づいています。

ほとんどの IBM® リレーショナル・データベース管理システムでは、列レベルでの列レベル特権は提供されていま せん。Db2 for z/OS® および DB2® for VSE & VM は UPDATE 列特権を サポートします。この結果セットには更新可能な列ごとに 1 つの行があり ます。Db2 for z/OS と DB2 for VSE & VM のその他のすべての特権、 および他の IBM リレーショナル・データベース管理システムのすべての特権については、表レベルで特権が 付与されている場合は、この結果セットに 1 つの行があります。

8 IS_GRANTABLE VARCHAR(3) 被付与者が他のユーザーに特権を付与できるかどうかを示します。

"YES" または "NO" のいずれか。

Db2 ODBC が使用する列名は、X/Open CLI CAE 仕様のスタイルに従っています。列タイプ、内容、および順序は、ODBC の SQLColumnPrivileges() 結果セットで定義されているものと同じです。

ある列に関連した特権が複数ある場合、それぞれの特権は結果セットの別々の行として 戻されます。

戻りコード

SQLColumnPrivileges() は、呼び出された後、次のいずれかの値を戻します。
  • SQL_SUCCESS
  • SQL_SUCCESS_WITH_INFO
  • SQL_ERROR
  • SQL_INVALID_HANDLE

診断

表 4 は、この関数が生成する各 SQLSTATE について、 それぞれの値ごとの記述と説明とともに示しています。

表 4. SQLColumnPrivileges() の SQLSTATE
SQLSTATE 説明 説明
08S01 通信リンクに障害が起きました。 関数が完了する前に、アプリケーションとデータ・ソース間の 通信リンクで障害が発生しました。
24000 カーソル状態が無効です。 ステートメント・ハンドルでカーソルがオープン状態です。
HY001 メモリーの割り振りに失敗しました。 Db2 ODBC は、関数の実行または完了をサポートするのに必要なメモリーを割り振ることができません。
HY009 NULL ポインターの使用は無効です。 引数 szTableName が NULL です。
HY014 これ以上ハンドルがありません。 Db2 ODBC は、内部リソースが少ないためにハンドルを割り振ることができません。
HY090 ストリングまたはバッファーの長さが無効です。 名前の長さ引数のうちの 1 つの値は 0 より小さい値ですが、SQL_NTS と等しくありません。
HYC00 ドライバーは使用できません。 Db2 ODBC は、表名の修飾子として 'catalog' はサポートしていません。

例

以下の例は、表に対する列特権のリストを 印刷するアプリケーションを示しています。
図 1. 表列のユーザー特権を取り出すアプリケーション
/* ... */
SQLRETURN
list_column_privileges(SQLHDBC hdbc, SQLCHAR *schema, SQLCHAR *tablename )
{
/* ... */
    rc = SQLColumnPrivileges(hstmt, NULL, 0, schema, SQL_NTS,
                             tablename, SQL_NTS, columnname.s, SQL_NTS);
    rc = SQLBindCol(hstmt, 4, SQL_C_CHAR, (SQLPOINTER) columnname.s, 129,
                    &columnname.ind);
    rc = SQLBindCol(hstmt, 5, SQL_C_CHAR, (SQLPOINTER) grantor.s, 129,
                    &grantor.ind);
    rc = SQLBindCol(hstmt, 6, SQL_C_CHAR, (SQLPOINTER) grantee.s, 129,
                    &grantee.ind);
    rc = SQLBindCol(hstmt, 7, SQL_C_CHAR, (SQLPOINTER) privilege.s, 129,
                    &privilege.ind);
    rc = SQLBindCol(hstmt, 8, SQL_C_CHAR, (SQLPOINTER) is_grantable.s, 4,
                    &is_grantable.ind);
    printf("Column Privileges for 
    /* Fetch each row, and display */
    while ((rc = SQLFetch(hstmt)) == SQL_SUCCESS) {
        sprintf(cur_name, " Column: 
        if (strcmp(cur_name, pre_name) != 0) {
            printf("¥nname);
            printf("   Grantor         Grantee         Privilege  Grantable¥n");
            printf("   --------------- --------------- ---------- ---¥n");
        }
        strcpy(pre_name, cur_name);
        printf("   
        printf(" 
        printf(" 
        printf(" grantable.s);
    }                           /* endwhile */
/* ... */