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表の形式で格納され、可変数のパラメータを収容します。