ジャンプ先

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

すべての索引の取得

get

/database/objects/indexes/

実行時のロールに応じてDBA_INDEXESビューまたはALL_INDEXESビューを使用して、データベース内のすべての索引について説明します。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

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

• application/json

問合せパラメータ

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

データベース内のすべての索引の説明。

本文 ()

ルート・スキーマ: DatabaseObjectsIndexes

タイプ: 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/DatabaseObjectsIndexesItem"
            }
        },
        "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

ソースの表示

• 配列: オブジェクト DatabaseObjectsIndexesItem
  データベース内の1つの索引について説明します。

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

データベース内の1つの索引について説明します。

ソースの表示

• avg_data_blocks_per_key(optional): integer
  表内のデータ・ブロックの平均数で、これらのブロックは、最も近い整数に端数処理された索引内の明確な値によって指し示されます。
• avg_leaf_blocks_per_key(optional): integer
  リーフ・ブロックの平均数。これらのブロックには、最も近い整数に端数処理された索引内の個別の各値が表示されます。
• blevel(optional): integer
  B*ツリー・レベル(ルート・ブロックからリーフ・ブロックまでの索引の深さ)。深さ0は、ルート・ブロックとリーフ・ブロックが同じレベルであることを意味します。
• buffer_pool(optional): string
  索引ブロックに対して使用されるバッファ・プール
• cell_flash_cache(optional): string
  索引ブロックに対して使用されるセル・フラッシュ・キャッシュ・ヒント
• clustering_factor(optional): number
  表内の行数を索引の値に基づいて示します。
• compression(optional): string
  索引に使用されている圧縮のタイプ
• degree(optional): string
  索引をスキャンするための1インスタンス当たりのスレッド数またはDEFAULT
• distinct_keys(optional): integer
  明確に索引付けされた値の数。
• domidx_management(optional): string
  これがドメイン索引の場合、システム管理(SYSTEM_MANAGED)かユーザー管理(USER_MANAGED).か
• domidx_opstatus(optional): string
  ドメイン索引の操作のステータス
• domidx_status(optional): string
  ドメイン索引のステータス
• dropped(optional): string
  不要な主キー列が索引構成表の2次索引から排除されている(YES)か排除されていない(NO)かを示します。
• duration(optional): string
  一時表の継続期間を示します。
• flash_cache(optional): string
  索引ブロックに対して使用されるデータベース・スマート・フラッシュ・キャッシュ・ヒント
• freelist_groups(optional): integer
  このセグメントに割り当てられているフリーリスト・グループ数。
• freelists(optional): integer
  このセグメントに割り当てられているプロセス・フリーリスト数。
• funcidx_status(optional): string
  機能ベース索引のステータス
• generated(optional): string
  索引名がシステムによって生成されたか(Y)、されなかったか(N)
• global_stats(optional): string
  統計情報が収集されるか、増分保持される場合、GLOBAL_STATSはYESで、それ以外の場合はNO
• include_column(optional): integer
  索引編成表の主キー(非オーバーフロー)索引に含まれる最終列の列ID。
• index_name(optional): string
  索引の名前。
• index_type(optional): string
  索引のタイプ
• indexing(optional): string
  グローバル索引が基礎となる表から分離されているかどうか。
• ini_trans(optional): integer
  トランザクションの初期番号。
• initial_extent(optional): integer
  初期エクステントのサイズ。
• instances(optional): string
  索引がいくつかのインスタンスにまたがってスキャンされる場合のインスタンスの数またはDEFAULT
• iot_redundant_pkey_elim(optional): string
  不要な主キー列が索引構成表の2次索引から排除されている(YES)か排除されていない(NO)かを示します。
• ityp_name(optional): string
  ドメイン索引の場合、索引タイプの名前
• ityp_owner(optional): string
  ドメイン索引の場合、索引タイプの所有者
• join_index(optional): string
  索引が結合索引(YES)か結合索引でない(NO)かを示します。
• last_analyzed(optional): string
  この索引が分析された最新の日付。
• leaf_blocks(optional): integer
  索引内のリーフ・ブロック数。
• links(optional): array links
• logging(optional): string
  索引に対する変更がログに記録されるかどうか
• max_extents(optional): integer
  セグメント内の許容最大エクステント数。
• max_trans(optional): integer
  トランザクションの最大番号。
• min_extents(optional): integer
  セグメント内の許容最小エクステント数。
• next_extent(optional): integer
  2次エクステントのサイズ。
• num_rows(optional): integer
  索引内の行数。
• orphaned_entries(optional): string
  DROP/TRUNCATE PARTITIONまたはMODIFY PARTITION INDEXING OFFの操作時に遅延した索引メンテナンスのため、グローバル索引に失効エントリが含まれているかどうか
• owner(optional): string
  索引の所有者。
• parameters(optional): string
  ドメイン索引に対するパラメータ文字列。
• partitioned(optional): string
  索引がパーティション化されている(YES)かいない(NO)かを示します。
• pct_direct_access(optional): number
  索引編成表の2次索引についてVALIDと推測される行の割合。
• pct_free(optional): integer
  ブロック内の空き領域の最小率。
• pct_increase(optional): number
  エクステント・サイズの増分率。
• pct_threshold(optional): number
  索引エントリ当たりの許容ブロック領域のしきい率。
• prefix_length(optional): integer
  圧縮キーの接頭辞の列数。
• sample_size(optional): integer
  索引の分析に使用されるサンプルのサイズ。
• secondary(optional): string
  この索引がOracle Data CartridgeのODCIIndexCreateメソッドによって作成された2次オブジェクトであるかどうかを示します(YまたはN)。
• segment_created(optional): string
  索引セグメントが作成されているかどうか(YES | NO)
• status(optional): string
  非パーティション索引がVALIDかUNUSABLEかを示します。
• table_name(optional): string
  索引オブジェクトの名前。
• table_owner(optional): string
  索引オブジェクトの所有者。
• table_type(optional): string
  索引付きオブジェクトの型
• tablespace_name(optional): string
  索引が格納されている表領域の名前。
• temporary(optional): string
  索引が一時表にあるかどうか(Y | N)
• uniqueness(optional): string
  索引が一意か(UNIQUE)一意でないか(NONUNIQUE)
• user_stats(optional): string
  統計がユーザーによって直接入力された(YES)か直接入力されていない(NO)かを示します。
• visibility(optional): string
  索引がオプティマイザにVISIBLEかINVISIBLEか

{
    "type":"object",
    "description":"Describes an index in the database.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the index."
        },
        "index_name":{
            "type":"string",
            "description":"Name of the index."
        },
        "index_type":{
            "type":"string",
            "description":"Type of the index."
        },
        "table_owner":{
            "type":"string",
            "description":"Owner of the indexed object."
        },
        "table_name":{
            "type":"string",
            "description":"Name of the indexed object."
        },
        "table_type":{
            "type":"string",
            "description":"Type of the indexed object."
        },
        "uniqueness":{
            "type":"string",
            "description":"Indicates whether the index is unique (UNIQUE) or nonunique (NONUNIQUE)."
        },
        "compression":{
            "type":"string",
            "description":"The type of compression being used for the index."
        },
        "prefix_length":{
            "type":"integer",
            "description":"Number of columns in the prefix of the compression key."
        },
        "tablespace_name":{
            "type":"string",
            "description":"Name of the tablespace containing the index."
        },
        "ini_trans":{
            "type":"integer",
            "description":"Initial number of transactions."
        },
        "max_trans":{
            "type":"integer",
            "description":"Maximum number of transactions."
        },
        "initial_extent":{
            "type":"integer",
            "description":"Size of the initial extent."
        },
        "next_extent":{
            "type":"integer",
            "description":"Size of secondary extents."
        },
        "min_extents":{
            "type":"integer",
            "description":"Minimum number of extents allowed in the segment."
        },
        "max_extents":{
            "type":"integer",
            "description":"Maximum number of extents allowed in the segment."
        },
        "pct_increase":{
            "type":"number",
            "description":"Percentage increase in extent size."
        },
        "pct_threshold":{
            "type":"number",
            "description":"Threshold percentage of block space allowed per index entry."
        },
        "include_column":{
            "type":"integer",
            "description":"Column ID of the last column to be included in index-organized table primary key (non-overflow) index."
        },
        "freelists":{
            "type":"integer",
            "description":"Number of process freelists allocated to this segment."
        },
        "freelist_groups":{
            "type":"integer",
            "description":"Number of freelist groups allocated to this segment."
        },
        "pct_free":{
            "type":"integer",
            "description":"Minimum percentage of free space in a block."
        },
        "logging":{
            "type":"string",
            "description":"Indicates whether or not changes to the index are logged."
        },
        "blevel":{
            "type":"integer",
            "description":"B*-Tree level (depth of the index from its root block to its leaf blocks). A depth of 0 indicates that the root block and leaf block are the same."
        },
        "leaf_blocks":{
            "type":"integer",
            "description":"Number of leaf blocks in the index."
        },
        "distinct_keys":{
            "type":"integer",
            "description":"Number of distinct indexed values."
        },
        "avg_leaf_blocks_per_key":{
            "type":"integer",
            "description":"Average number of leaf blocks in which each distinct value in the index appears, rounded to the nearest integer."
        },
        "avg_data_blocks_per_key":{
            "type":"integer",
            "description":"Average number of data blocks in the table that are pointed to by a distinct value in the index rounded to the nearest integer."
        },
        "clustering_factor":{
            "type":"number",
            "description":"Indicates the amount of order of the rows in the table based on the values of the index."
        },
        "status":{
            "type":"string",
            "description":"Indicates whether a nonpartitioned index is VALID or UNUSABLE."
        },
        "num_rows":{
            "type":"integer",
            "description":"Number of rows in the index."
        },
        "sample_size":{
            "type":"integer",
            "description":"Size of the sample used to analyze the index."
        },
        "last_analyzed":{
            "type":"string",
            "description":"Date on which this index was most recently analyzed."
        },
        "degree":{
            "type":"string",
            "description":"Number of threads per instance for scanning the index, or DEFAULT."
        },
        "instances":{
            "type":"string",
            "description":"Number of instances across which the indexes to be scanned, or DEFAULT."
        },
        "partitioned":{
            "type":"string",
            "description":"Indicates whether the index is partitioned (YES) or not (NO)."
        },
        "temporary":{
            "type":"string",
            "description":"Indicates whether the index is on a temporary table (Y) or not (N)."
        },
        "generated":{
            "type":"string",
            "description":"Indicates whether the name of the index is system-generated (Y) or not (N)."
        },
        "secondary":{
            "type":"string",
            "description":"Indicates whether the index is a secondary object created by the ODCIIndexCreate method of the Oracle Data Cartridge (Y) or not (N)."
        },
        "buffer_pool":{
            "type":"string",
            "description":"Buffer pool to be used for index blocks."
        },
        "flash_cache":{
            "type":"string",
            "description":"Database Smart Flash Cache hint to be used for index blocks."
        },
        "cell_flash_cache":{
            "type":"string",
            "description":"Cell flash cache hint to be used for index blocks."
        },
        "user_stats":{
            "type":"string",
            "description":"Indicates whether statistics were entered directly by the user (YES) or not (NO)."
        },
        "duration":{
            "type":"string",
            "description":"Indicates the duration of a temporary table."
        },
        "pct_direct_access":{
            "type":"number",
            "description":"For a secondary index on an index-organized table, the percentage of rows with VALID guess."
        },
        "ityp_owner":{
            "type":"string",
            "description":"For a domain index, the owner of the indextype."
        },
        "ityp_name":{
            "type":"string",
            "description":"For a domain index, the name of the indextype."
        },
        "parameters":{
            "type":"string",
            "description":"For a domain index, the parameter string."
        },
        "global_stats":{
            "type":"string",
            "description":"GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO."
        },
        "domidx_status":{
            "type":"string",
            "description":"Status of a domain index."
        },
        "domidx_opstatus":{
            "type":"string",
            "description":"Status of the operation on a domain index."
        },
        "funcidx_status":{
            "type":"string",
            "description":"Status of a function-based index."
        },
        "join_index":{
            "type":"string",
            "description":"Indicates whether the index is a join index (YES) or not (NO)."
        },
        "iot_redundant_pkey_elim":{
            "type":"string",
            "description":"Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO)."
        },
        "dropped":{
            "type":"string",
            "description":"Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO)."
        },
        "visibility":{
            "type":"string",
            "description":"Indicates whether the index is VISIBLE or INVISIBLE to the optimizer."
        },
        "domidx_management":{
            "type":"string",
            "description":"If this is a domain index, indicates whether the domain index is system-managed (SYSTEM_MANAGED) or user-managed (USER_MANAGED)."
        },
        "segment_created":{
            "type":"string",
            "description":"Indicates whether the index segment has been created (YES) or not (NO)."
        },
        "orphaned_entries":{
            "type":"string",
            "description":"Indicates whether a global index contains stale entries because of deferred index maintenance during DROP/TRUNCATE PARTITION, or MODIFY PARTITION INDEXING OFF operations."
        },
        "indexing":{
            "type":"string",
            "description":"Indicates whether a global index is decoupled from the underlying table."
        },
        "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"
    ]
}

先頭に戻る