ジャンプ先

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

特定の外部キーの取得

get

/database/objects/foreign_keys/{owner},{constraint_name}

実行時のロールに応じてDBA_CONSTRAINTSビューとDBA_CONS_COLUMNSビュー、またはALL_CONSTRAINTSビューとALL_CONS_COLUMNSビューから、対応するレコードを返します。レスポンスに含まれるのは、制約タイプがRであるレコードです。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

パス・パラメータ

• constraint_name(required): string
  外部キーの制約の名前。
• owner(required): string
  外部キーの所有者。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

特定の外部キーに関する情報。

本文 ()

ルート・スキーマ: DatabaseObjectsForeignKeysItem

タイプ: object

参照整合性の外部キー制約を説明します。

ソースの表示

• columns: object columns
  所有者constraint_nameを参照するすべての列について説明します。
• constraint_name: string
  制約定義の所有者。
• constraint_type: string
  制約の種類。
• links: array links
• owner: string
  制約定義の所有者。
• r_constraint_name: string
  制約定義の所有者。
• r_owner: string
  参照制約で参照される表の所有者
• table_name: string
  制約定義付きの表(またはビュー)に対応付けられた名前

{
    "type":"object",
    "description":"Describes a foreign key constraint for referential integrity.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_type":{
            "type":"string",
            "description":"Type of constraint."
        },
        "table_name":{
            "type":"string",
            "description":"Name associated with the table (or view) with the constraint definition."
        },
        "r_owner":{
            "type":"string",
            "description":"Owner of the table referred to in a referential constraint."
        },
        "r_constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "columns":{
            "type":"object",
            "description":"Describes all the columns that make reference to  owner, constraint_name.",
            "properties":{
                "r_column_name":{
                    "type":"string",
                    "description":"Name of the column referred to in a referential constraint."
                },
                "r_table_name":{
                    "type":"string",
                    "description":"Name of the table referred to in a referential constraint."
                },
                "column_name":{
                    "type":"string",
                    "description":"Name of the column or attribute of the object type column specified in the constraint definition."
                },
                "position":{
                    "type":"integer",
                    "description":"The position of the column_name and referenced r_column_name."
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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

タイプ: object

所有者constraint_nameを参照するすべての列について説明します。

ソースの表示

• column_name: string
  制約定義に指定されているオブジェクト型の列に対する列名または属性名。
• position: integer
  column_nameおよび参照されるr_column_nameの位置
• r_column_name: string
  参照制約で参照される列の名前
• r_table_name: string
  参照制約で参照される表の名前

{
    "type":"object",
    "description":"Describes all the columns that make reference to  owner, constraint_name.",
    "properties":{
        "r_column_name":{
            "type":"string",
            "description":"Name of the column referred to in a referential constraint."
        },
        "r_table_name":{
            "type":"string",
            "description":"Name of the table referred to in a referential constraint."
        },
        "column_name":{
            "type":"string",
            "description":"Name of the column or attribute of the object type column specified in the constraint definition."
        },
        "position":{
            "type":"integer",
            "description":"The position of the column_name and referenced r_column_name."
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

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

先頭に戻る