ジャンプ先

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

すべてのファンクションの取得

get

/database/objects/functions/

実行時のロールに応じてDBA_PROCEDURESビューまたはALL_PROCEDURESビューから、OBJECT_TYPE = 'FUNCTION'であるレコードを返します。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  戻すレコードの最大数。
• q(optional): string
  フィルタリングは、全コレクションで見つかった項目のサブセットが含まれている複数ページのリソース全体に対し、リクエストごとの動的フィルタ定義を使用してコレクション・リソースを制限する処理です。フィルタリングは、大規模なコレクションの効率的な走査を可能にします。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

データベース内のすべてのファンクションの説明。

本文 ()

ルート・スキーマ: DatabaseObjectsFunctions

タイプ: object

ソースの表示

• count(optional): integer
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  取得するレコードがさらにあるかどうか
• items(optional): array items
• limit(optional): integer
  サーバーによって適用されるレコード数に関する実際のページ・サイズ制限
• links(optional): array links
• offset(optional): integer
  項目リソースの返戻元となる実際の索引

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DatabaseObjectsFunctionsItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト DatabaseObjectsFunctionsItem
  データベースで使用可能な1つのファンクションと、関連するプロパティを説明します。属性のリストは、データベースのバージョンによって異なる場合があります。

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

データベースで使用可能な1つのファンクションと、関連するプロパティを説明します。属性のリストは、データベースのバージョンによって異なる場合があります。

ソースの表示

• aggregate(optional): string
  プロシージャが集計関数(YES)か集計関数でない(NO).か
• authid(optional): string
  プロシージャ/ファンクションがDEFINER または CURRENT_USER(実行者).として実行するために宣言されているか
• deterministic(optional): string
  プロシージャ/ファンクションがDETERMINISTICであると宣言されている(YES)か宣言されていない(NO)か
• impltypename(optional): string
  実装タイプがある場合は、その名前
• impltypeowner(optional): string
  実装タイプがある場合は、その所有者
• interface(optional): string
  プロシージャ/ファンクションが、ODCIインタフェースを使用して実装されたテーブル・ファンクション(YES)かそうでない(NO)か
• links(optional): array links
• object_id(optional): integer
  オブジェクトのオブジェクト番号。
• object_name(optional): string
  トップレベルのファンクションの名前
• object_type(optional): string
  オブジェクトの型名
• origin_con_id(optional): integer
  データの発生元のコンテナのID。
• overload(optional): string
  過負荷の一意識別子。
• owner(optional): string
  ファンクションの所有者。
• parallel(optional): string
  プロシージャまたはファンクションがパラレルで使用可能(YES)か使用可能ではない(NO).か
• pipelined(optional): string
  プロシージャがパイプライン・テーブル・ファンクション(YES)かパイプライン・テーブル・ファンクションでない(NO).か
• polymorphic(optional): string
  多相テーブル・ファンクションのタイプ
• procedure_name(optional): string
  プロシージャの名前。
• result_cache(optional): string
  ファンクションの結果がキャッシュされるどうか(YES | NO)
• subprogram_id(optional): integer
  一意のサブプログラム識別子。

{
    "type":"object",
    "description":"Describes a function available in the database, along with associated properties. The list of attributes may vary depending on database version.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the function."
        },
        "object_name":{
            "type":"string",
            "description":"Name of the top-level function."
        },
        "procedure_name":{
            "type":"string",
            "description":"Name of the procedure."
        },
        "object_id":{
            "type":"integer",
            "description":"Object number of the object."
        },
        "subprogram_id":{
            "type":"integer",
            "description":"Unique subprogram identifier."
        },
        "overload":{
            "type":"string",
            "description":"Overload unique identifier."
        },
        "object_type":{
            "type":"string",
            "description":"The typename of the object."
        },
        "aggregate":{
            "type":"string",
            "description":"Indicates whether the procedure is an aggregate function (YES) or not (NO)."
        },
        "pipelined":{
            "type":"string",
            "description":"Indicates whether the procedure is a pipelined table function (YES) or not (NO)."
        },
        "impltypeowner":{
            "type":"string",
            "description":"Owner of the implementation type, if any."
        },
        "impltypename":{
            "type":"string",
            "description":"Name of the implementation type, if any."
        },
        "parallel":{
            "type":"string",
            "description":"Indicates whether the procedure or function is parallel-enabled (YES) or not (NO)."
        },
        "interface":{
            "type":"string",
            "description":"YES, if the procedure/function is a table function implemented using the ODCI interface; otherwise NO."
        },
        "deterministic":{
            "type":"string",
            "description":"YES, if the procedure/function is declared to be deterministic; otherwise NO."
        },
        "authid":{
            "type":"string",
            "description":"Indicates whether the procedure/function is declared to execute as DEFINER or CURRENT_USER (invoker)."
        },
        "result_cache":{
            "type":"string",
            "description":"Indicates whether the function is result???cached (YES) or not (NO)."
        },
        "origin_con_id":{
            "type":"integer",
            "description":"The ID of the container where the data originates."
        },
        "polymorphic":{
            "type":"string",
            "description":"The type of polymorphic table function."
        },
        "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"
    ]
}

先頭に戻る