ジャンプ先

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

すべての表の列の取得

get

/database/objects/columns/

実行時のロールに応じてDBA_TAB_COLUMNSビューまたはALL_TAB_COLUMNSビューから、すべてのレコードを返します。レスポンスに含まれるレコードでは、そのロールでアクセスできるすべての表、ビューおよびクラスタの列が説明されます。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

問合せパラメータ

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

  例

  例の選択 FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

データベース内のすべての列。

本文 ()

ルート・スキーマ: DatabaseObjectsColumns

タイプ: object

ソースの表示

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatabaseObjectsColumnsItem"
            }
        },
        "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":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト DatabaseObjectsColumnsItem
  データベース内の表、ビューまたはクラスタの列を説明します。

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

データベース内の表、ビューまたはクラスタの列を説明します。

ソースの表示

• avg_col_len: integer
  列の平均の長さ(バイト)
• char_col_decl_length: number
  キャラクタ・タイプ列の宣言の長さ
• char_length: integer
  列の長さが文字単位で表示されます。
• char_used: string
  列がBYTEの長さセマンティクス(B)を使用するかCHARの長さセマンティクス(C)を使用するか、またはデータ型がCHAR、VARCHAR2、NCHAR、NVARCHAR2でない(NULL)かどうか
• character_set_name: string
  文字セットの名前
• collation: string
  列の照合。文字データ型を持つ列にのみ適用される。
• column_id: integer
  列が作成された際の順序番号。
• column_name: string
  列名。
• data_default: integer
  列のデフォルト値
• data_length: integer
  列の長さ(バイト数)。
• data_precision: integer
  NUMBERデータ型の10進精度。FLOATデータ型の場合は2進精度、その他すべてのデータ型についてはNULL。
• data_scale: integer
  数値による小数点の右側の桁数。
• data_type: string
  列のデータ型。
• data_type_mod: string
  列のデータ型修飾子
• data_type_owner: string
  列のデータ型の所有者
• data_upgraded: string
  列データが最新のタイプ・バージョン形式にアップグレードされたかどうか(YES | NO)
• default_length: number
  列のデフォルト値の長さ
• default_on_null: string
  列のセマンティクスがDEFAULT ON NULLかどうか(YES | NO)
• density: number
  COLUMN_NAMEに対してヒストグラムが使用可能な場合、この列にはヒストグラム内の1つ以下のエンドポイントにわたる値の選択性が示される。複数のエンドポイントにわたる値の選択性は示されない。COLUMN_NAMEに対してヒストグラムが使用可能ではない場合、この列の値は1/NUM_DISTINCTである。
• evaluation_edition: string
  式列で参照されるエディション化オブジェクトが解決されるエディションの名前
• global_stats: string
  統計情報が収集されるか、増分保持される場合、GLOBAL_STATSはYESで、それ以外の場合はNO
• high_value: string
  列内の上限値
• histogram: string
  ヒストグラムの有無およびタイプ
• identity_column: string
  これがID列かどうか(YES | NO)
• last_analyzed: string
  この列が分析された最新の日付
• links: array links
• low_value: string
  列内の下限値
• nullable: string
  列にNULLを指定できるかどうかを示す。列にNOT NULL制約がある場合、または列が主キーの一部である場合、値はN。制約はENABLE VALIDATE状態である必要がある。
• num_buckets: integer
  列のヒストグラム内のバケット数
• num_distinct: number
  列内で異なる値の数
• num_nulls: integer
  列内のNULLの数
• owner: string
  表、ビューまたはクラスタの所有者
• sample_size: integer
  この列の分析で使用されたサンプル・サイズ
• sensitive_column: string
  機密列かどうか(YES | NO)
• table_name: string
  表、ビューまたはクラスタの名前
• unusable_before: string
  索引を問合せプランの一部として使用可能な最も古いエディション名
• unusable_beginning: string
  索引をこのエディションまたはその子孫のいずれかで問合せプランの一部として使用できないエディション名
• user_stats: string
  統計がユーザーによって直接入力された(YES)か直接入力されていない(NO)かを示します。
• v80_fmt_image: string
  列データがリリース8.0のイメージ形式であるかどうか(YES | NO)

{
    "type":"object",
    "description":"Describes the column of table, view, or cluster in the database.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the table, view, or cluster."
        },
        "table_name":{
            "type":"string",
            "description":"Name of the table, view, or cluster."
        },
        "column_name":{
            "type":"string",
            "description":"Column name."
        },
        "data_type":{
            "type":"string",
            "description":"Data type of the column."
        },
        "data_type_mod":{
            "type":"string",
            "description":"Data type modifier of the column."
        },
        "data_type_owner":{
            "type":"string",
            "description":"Owner of the data type of the column."
        },
        "data_length":{
            "type":"integer",
            "description":"Length of the column (in bytes)."
        },
        "data_precision":{
            "type":"integer",
            "description":"Decimal precision for NUMBER data type; binary precision for FLOAT data type; NULL for all other data types."
        },
        "data_scale":{
            "type":"integer",
            "description":"Digits to the right of the decimal point in a number."
        },
        "nullable":{
            "type":"string",
            "description":"Indicates whether a column allows NULLs. The value is N if there is a NOT NULL constraint on the column or if the column is part of a PRIMARY KEY. The constraint should be in an ENABLE VALIDATE state."
        },
        "column_id":{
            "type":"integer",
            "description":"Sequence number of the column as created."
        },
        "default_length":{
            "type":"number",
            "description":"Length of the default value for the column."
        },
        "data_default":{
            "type":"integer",
            "description":"Default value for the column."
        },
        "num_distinct":{
            "type":"number",
            "description":"Number of distinct values in the column."
        },
        "low_value":{
            "type":"string",
            "description":"Low value in the column."
        },
        "high_value":{
            "type":"string",
            "description":"High value in the column."
        },
        "density":{
            "type":"number",
            "description":"If a histogram is available on COLUMN_NAME, then this column displays the selectivity of a value that spans fewer than 2 endpoints in the histogram. It does not represent the selectivity of values that span 2 or more endpoints. If a histogram is not available on COLUMN_NAME, then the value of this column is 1/NUM_DISTINCT."
        },
        "num_nulls":{
            "type":"integer",
            "description":"Number of NULLs in the column."
        },
        "num_buckets":{
            "type":"integer",
            "description":"Number of buckets in the histogram for the column."
        },
        "last_analyzed":{
            "type":"string",
            "description":"Date on which this column was most recently analyzed."
        },
        "sample_size":{
            "type":"integer",
            "description":"Sample size used in analyzing this column."
        },
        "character_set_name":{
            "type":"string",
            "description":"Name of the character set."
        },
        "char_col_decl_length":{
            "type":"number",
            "description":"Declaration length of the character type column."
        },
        "global_stats":{
            "type":"string",
            "description":"GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO."
        },
        "user_stats":{
            "type":"string",
            "description":"Indicates whether statistics were entered directly by the user (YES) or not (NO)."
        },
        "avg_col_len":{
            "type":"integer",
            "description":"Average length of the column (in bytes)."
        },
        "char_length":{
            "type":"integer",
            "description":"Displays the length of the column in characters."
        },
        "char_used":{
            "type":"string",
            "description":"Indicates that the column uses BYTE length semantics (B) or CHAR length semantics (C), or whether the data type is not any of the following (NULL): CHAR, VARCHAR2, NCHAR, NVARCHAR2."
        },
        "v80_fmt_image":{
            "type":"string",
            "description":"Indicates whether the column data is in release 8.0 image format (YES) or not (NO)."
        },
        "data_upgraded":{
            "type":"string",
            "description":"Indicates whether the column data has been upgraded to the latest type version format (YES) or not (NO)."
        },
        "histogram":{
            "type":"string",
            "description":"Indicates existence/type of histogram."
        },
        "default_on_null":{
            "type":"string",
            "description":"Indicates whether the column has DEFAULT ON NULL semantics (YES) or not (NO)."
        },
        "identity_column":{
            "type":"string",
            "description":"Indicates whether this is an identity column (YES) or not (NO)."
        },
        "sensitive_column":{
            "type":"string",
            "description":"Indicates whether this is a sensitive column (YES) or not (NO)."
        },
        "evaluation_edition":{
            "type":"string",
            "description":"Name of the edition in which editioned objects referenced in an expression column are resolved."
        },
        "unusable_before":{
            "type":"string",
            "description":"Name of the oldest edition in which the index may be used as part of a query plan."
        },
        "unusable_beginning":{
            "type":"string",
            "description":"Name of the edition for which the index may not be used as part of a query plan in this edition or any of its descendants."
        },
        "collation":{
            "type":"string",
            "description":"Collation for the column. Only applies to columns with character data types."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: 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"
    ]
}

先頭に戻る