DESCRIBE_PROCEDURE ステートメントは、PLステートメントの簡潔な説明を提供します。
DESCRIBE_PROCEDURE ステートメントは、ステートメントの名前を識別し、そのステートメントの各パラメータに関する情報を返します。
適用対象
この内容はOceanBaseデータベースEnterprise Editionにのみ適用されます。OceanBaseデータベースCommunity EditionはMySQLモードのみを提供します。
構文
DBMS_DESCRIBE.DESCRIBE_PROCEDURE(
object_name IN VARCHAR2,
reserved1 IN VARCHAR2,
reserved2 IN VARCHAR2,
overload OUT NUMBER_TABLE,
position OUT NUMBER_TABLE,
datalevel OUT NUMBER_TABLE,
argument_name OUT VARCHAR2_TABLE,
datatype OUT NUMBER_TABLE,
default_value OUT NUMBER_TABLE,
in_out OUT NUMBER_TABLE,
datalength OUT NUMBER_TABLE,
dataprecision OUT NUMBER_TABLE,
scale OUT NUMBER_TABLE,
radix OUT NUMBER_TABLE,
spare OUT NUMBER_TABLE
include_string_constraints OUT BOOLEAN DEFAULT FALSE);
パラメータの説明
| パラメータ | 説明 |
|---|---|
| object_name | 記述されているストアドプロシージャの名前。このパラメータの構文は、SQLにおける識別子のルールに従います。このオブジェクト名はシノニムである可能性があります。このパラメータは必須であり、空にすることはできません。名前の全長は197バイトを超えてはなりません。 |
| reserved1 reserved2 | 将来の使用を予約しています。NULLまたは空の文字列に設定する必要があります。 |
| overload | ストアドプロシージャ署名に割り当てられた一意の番号。ストアドプロシージャがオーバーロードされている場合、このフィールドはストアドプロシージャの各バージョンごとに異なる値を保持します。 |
| position | パラメータリスト内のパラメータの位置。 |
| datalevel | パラメータがレコードなどの複合型である場合、このパラメータはデータ型のレベルを返します。 |
| argument_name | 記述されているストアドプロシージャに関連付けられたパラメータ名。 |
| datatype | 記述されたパラメータのデータ型。データ型とその数値型コードは以下のとおりです：
|
| default_value | 記述されたパラメータにデフォルト値がある場合、値は1となります。そうでない場合、値は0となります。 |
| in_out | パラメータのモードを記述します。パラメータモードは次のとおりです：
|
| datalength | %rowtype形式のパラメータについては、長さ制約を返します。それ以外の場合は0を返します。include_string_constraintsパラメータがTRUEに設定されている場合、パラメータの長さ制約を返します（適切なパラメータタイプの場合）。文字列タイプは次のとおりです：
|
| dataprecision | 説明されているパラメータがデータ型2 (NUMBER) の場合、このパラメータはその数値の精度を表します。 |
| scale | 説明されているパラメータがデータ型2 (NUMBER) の場合、このパラメータはその数値の小数点以下の桁数を表します。 |
| radix | 説明されているパラメータがデータ型2 (NUMBER) の場合、このパラメータはその数値の基数を表します。 |
| spare | 将来の機能用に予約されています。 |
| include_string_constraints | デフォルト値は FALSE です。パラメータを TRUE に設定すると、パラメータの型制約が返されます（適切なパラメータタイプの場合）。文字列型は以下のとおりです：
|
返される値
DESCRIBE_PROCEDURE のすべての値は、OUT パラメータを通じて返されます。これらのデータ型はPL表として格納され、可変数のパラメータを収容できます。