sa_describe_query( 
query 
[, add_keys ] 
)

sa_describe_query プロシージャーは、API に依存しないメカニズムによって、クエリの結果セットに含まれる式に関する名前とタイプの情報を記述します。

add_keys に 1 が指定されている場合、sa_describe_query プロシージャーはクエリ対象のオブジェクトからカラムセットを検索しようとします。このカラムセットは、記述されるクエリの結果セットのローをユニークに識別するときに使用されます。キーの形式は、クエリ対象のオブジェクトに含まれる 1 つ以上のカラムです。また、クエリで明示的に参照されないカラムがキーに含まれる場合があります。オプティマイザーによってキーが見つかった場合、キーで使用されるカラムは、結果で値が 1 の is_key_column によって識別されます。キーが見つからない場合はエラーが返されます。

キーに含まれていてもクエリで明示的に参照されていないカラムについては、is_added_key_column の値が 1 に設定されます。これはプロシージャーの結果にカラムが追加されていることを示します。それ以外の場合、is_added_key_column の値は 0 です。

add_keys を指定しない場合、または 0 の値を指定する場合、オプティマイザーは結果セットのキーを検索しません。is_key_column と is_added_key_column には NULL が含まれます。

declared_width 値と width 値のどちらもカラムのサイズを記述します。declared_width は、CREATE TABLE 文またはクエリによって定義されたカラムのサイズを記述します。width 値は、クライアントにフェッチされるときのカラムのサイズを示します。クライアントの型表記は、データベースサーバーとは異なることがあります。たとえば、return_date_time_as_string オプションがオンの場合、日付と時間のデータ型は文字列に変換されます。文字列の場合、character-length セマンティックで宣言されたカラムは、CREATE TABLE のサイズと一致する declared_width 値を持ちます。width 値は、戻り値の文字列を格納するために必要な最大バイト数を示します。次に例を示します。

なし。

なし。

• EXPRTYPE 関数 [その他]
• 文字データ型
• return_date_time_as_string オプション
• SYSDOMAIN システムビュー
• SYSDOMAIN システムビュー
• SYSUSERTYPE システムビュー
• SYSTAB システムビュー
• SYSUSER システムビュー

次の例は、Departments テーブルのすべてのカラムを問い合わせると返される情報を記述します。

SELECT *  
FROM sa_describe_query( 'SELECT * FROM Departments DEPT' );

add_keys パラメーターが指定されなかったため、結果では is_key_column と is_added_key_column の値が NULL になります。

次の例は、Departments テーブルとジョインした Employees テーブルの DepartmentName カラムと Surname カラムを問い合わせることで返される情報を記述します。

SELECT  *
FROM  sa_describe_query( 'SELECT DepartmentName, Surname
 FROM Employees E JOIN Departments D ON E.EmployeeID = D.DepartmentHeadId',
 add_keys = 1 );

この結果、結果セットのロー 3 と 4 に 1 が示され、クエリの結果セットに含まれるローをユニークに識別するときに必要なカラムが Employees.EmployeeID と Departments.DepartmentID であることを示します。また、ロー 3 と 4 の is_added_key_column には 1 が指定されます。これは Employees.EmployeeID と Departments.DepartmentID が、記述されたクエリで明示的に参照されなかったためです。