ジャンプ先

• リクエスト
• レスポンス

引数の取得

get

/database/objects/arguments/{object_id},{subprogram_id},{argument_name}

実行時のロールに応じてDBA_ARGUMENTSビューまたはALL_ARGUMENTSビューから、指定された引数情報を返します。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• argument_name: string
  引数の名前。
• object_id: number
  引数が属するオブジェクトの識別子。
• subprogram_id: number
  引数が属するサブプログラムの識別子。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

指定された引数の情報。

本文 ()

ルート・スキーマ: DatabaseArgumentsItem

タイプ: object

このオブジェクトは、データベースで使用可能なファンクションおよびプロシージャの引数を表します。属性のリストは、データベースのバージョンによって異なる場合があります。

ソースの表示

• argument_name(optional): string
  引数がスカラー型の場合、引数名はその引数の名前です。引数名がnullの場合、ファンクションの戻り値を示すために使用される。ファンクションの戻り値または引数がコンポジット型の場合、このビューには、コンポジット型の各属性につき1つの行が表示されます。コンポジット型の属性は、再帰的に展開されます。
• char_length(optional): integer
  文字列データ型の文字制限
• char_used(optional): string
  バイトの制限(B)または文字制限(C)のどちらが文字列の正式な制限か
• character_set_name(optional): string
  引数の文字セット名。
• data_length(optional): integer
  列の長さ(バイト数)。
• data_level(optional): integer
  コンポジット型に対する引数のネストの深さ。
• data_precision(optional): integer
  10進数(NUMBER)または2進数(FLOAT)の長さ。
• data_scale(optional): integer
  数値による小数点の右側の桁数。
• data_type(optional): string
  引数のデータ型。
• default_length(optional): integer
  将来の使用のために予約されています。
• default_value(optional): integer
  将来の使用のために予約されています。
• defaulted(optional): string
  引数がデフォルトであるかどうかを指定する。
• in_out(optional): string
  引数の方向。IN、OUT、IN/OUT。
• links(optional): array links
• object_id(optional): integer
  オブジェクトのディクショナリ・オブジェクト番号
• object_name(optional): string
  プロシージャまたはファンクションの名前。
• origin_con_id(optional): integer
  データの発生元のコンテナのID。
• overload(optional): string
  ソース内でn番目に発生したオーバーロード。あるいはNULL。
• owner(optional): string
  オブジェクトの所有者。
• package_name(optional): string
  パッケージの名前。
• pls_type(optional): string
  数値引数の場合は引数のPL/SQL型の名前。そうでない場合、NULL。
• position(optional): integer
  DATA_LEVELが0の場合、この列には引数リスト内でのこの項目の位置、またはファンクションの戻り値の場合は0が保持される。DATA_LEVELが0より大きい場合、この列には、同じDATA_LEVELでのその兄弟に対するこの項目の位置が保持される。このため、参照レコード・フィールドの場合はレコード内のフィールドの索引となる。参照コレクション要素の場合は1(コレクション要素が兄弟関係でないため。)
• radix(optional): integer
  数値に対する引数の基数。
• sequence(optional): integer
  引数およびその属性の順序を定義します。引数の順序は1から開始する。最初に戻り型およびその再帰展開(木の先行順巡回)属性が、次にその再帰展開(木の先行順巡回)属性を持つ各引数が続く。
• subprogram_id(optional): integer
  一意のサブプログラム識別子
• type_link(optional): string
  TYPE_NAME列で識別されるパッケージがリモート・パッケージの場合は、パッケージ・ローカル型にのみ関係します。この列には、リモート・パッケージの参照に使用されるデータベース・リンクが表示されます。
• type_name(optional): string
  引数の型の名前。型がパッケージ・ローカル型(つまり、パッケージ仕様部に宣言されている)の場合、この列にはパッケージの名前が表示されます。
• type_object_type(optional): string
  TYPE_OWNER、TYPE_NAMEおよびTYPE_SUBNAMEの各列によって記述される型のタイプが表示されます。
• type_owner(optional): string
  引数の型の所有者。
• type_subname(optional): string
  パッケージ・ローカル型の場合にのみ関係します。TYPE_NAME列で識別されるパッケージ内に宣言されている型の名前が表示されます。

{
    "type":"object",
    "description":"This object represents arguments of the functions and procedures that are available in the database. The list of attributes may vary depending on database version.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the object."
        },
        "object_name":{
            "type":"string",
            "description":"Name of the procedure or function."
        },
        "package_name":{
            "type":"string",
            "description":"Name of the package."
        },
        "object_id":{
            "type":"integer",
            "description":"Dictionary object number of the object."
        },
        "overload":{
            "type":"string",
            "description":"Indicates the nth overloading ordered by its appearance in the source; otherwise, it is NULL."
        },
        "subprogram_id":{
            "type":"integer",
            "description":"Unique subprogram identifier."
        },
        "argument_name":{
            "type":"string",
            "description":"If the argument is a scalar type, then the argument name is the name of the argument. A null argument name is used to denote a function return. If the function return or argument is a composite type, this view will have one row for each attribute of the composite type. Attributes are recursively expanded if they are composite."
        },
        "position":{
            "type":"integer",
            "description":"If DATA_LEVEL is zero, then this column holds the position of this item in the argument list, or zero for a function return value.If DATA_LEVEL is greater than zero, then this column holds the position of this item with respect to its siblings at the same DATA_LEVEL. So, for a referenced record field, this is the index of the field within the record. For a referenced collection element, this is 1 (because collection elements do not have siblings.)"
        },
        "sequence":{
            "type":"integer",
            "description":"Defines the sequential order of the argument and its attributes. Argument sequence starts from 1. Return type and its recursively expanded (preorder tree walk) attributes will come first, and each argument with its recursively expanded (preorder tree walk) attributes will follow."
        },
        "data_level":{
            "type":"integer",
            "description":"Nesting depth of the argument for composite types."
        },
        "data_type":{
            "type":"string",
            "description":"Datatype of the argument."
        },
        "defaulted":{
            "type":"string",
            "description":"Specifies whether or not the argument is defaulted."
        },
        "default_value":{
            "type":"integer",
            "description":"Reserved for future use."
        },
        "default_length":{
            "type":"integer",
            "description":"Reserved for future use."
        },
        "in_out":{
            "type":"string",
            "description":"Direction of the argument: IN, OUT, IN/OUT."
        },
        "data_length":{
            "type":"integer",
            "description":"Length of the column (in bytes)."
        },
        "data_precision":{
            "type":"integer",
            "description":"Length in decimal digits (NUMBER) or binary digits (FLOAT)."
        },
        "data_scale":{
            "type":"integer",
            "description":"Digits to the right of the decimal point in a number."
        },
        "radix":{
            "type":"integer",
            "description":"Argument radix for a number."
        },
        "character_set_name":{
            "type":"string",
            "description":"Character set name for the argument."
        },
        "type_owner":{
            "type":"string",
            "description":"Owner of the type of the argument."
        },
        "type_name":{
            "type":"string",
            "description":"Name of the type of the argument. If the type is a package local type (that is, it is declared in a package specification), then this column displays the name of the package."
        },
        "type_subname":{
            "type":"string",
            "description":"Relevant only for package local types. Displays the name of the type declared in the package identified in the TYPE_NAME column."
        },
        "type_link":{
            "type":"string",
            "description":"Relevant only for package local types when the package identified in the TYPE_NAME column is a remote package. This column displays the database link used to refer to the remote package."
        },
        "type_object_type":{
            "type":"string",
            "description":"Displays the type of the type described by the TYPE_OWNER, TYPE_NAME, and TYPE_SUBNAME columns."
        },
        "pls_type":{
            "type":"string",
            "description":"For numeric arguments, the name of the PL/SQL type of the argument. Null otherwise."
        },
        "char_length":{
            "type":"integer",
            "description":"Character limit for string datatypes."
        },
        "char_used":{
            "type":"string",
            "description":"Indicates whether the byte limit (B) or char limit (C) is official for the string."
        },
        "origin_con_id":{
            "type":"integer",
            "description":"The ID of the container where the data originates."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る