Get all indexes
get
/database/objects/indexes/
Describes all the indexes in the database using DBA_INDEXES or ALL_INDEXES view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
Request
Query Parameters
-
limit(optional): integer(int32)
The maximum number of records to return.
-
q(optional): string
Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.
Response
Supported Media Types
- application/json
200 Response
Description of all indexes in the database.
Root Schema : DatabaseObjectsIndexes
Type:
Show Source
object-
count(optional):
integer
Total number of records in the current response.
-
hasMore(optional):
boolean
Indicates if there are more records to be retrieved.
-
items(optional):
array items
-
limit(optional):
integer
The actual page size limit on number of records applied by the server.
-
links(optional):
array links
-
offset(optional):
integer
The actual index from which the item resources are returned.
Nested Schema : items
Type:
Show Source
array-
Array of:
object DatabaseObjectsIndexesItem
Describes an index in the database.
Nested Schema : DatabaseObjectsIndexesItem
Type:
objectDescribes an index in the database.
Show Source
-
avg_data_blocks_per_key(optional):
integer
Average number of data blocks in the table that are pointed to by a distinct value in the index rounded to the nearest integer.
-
avg_leaf_blocks_per_key(optional):
integer
Average number of leaf blocks in which each distinct value in the index appears, rounded to the nearest integer.
-
blevel(optional):
integer
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.
-
buffer_pool(optional):
string
Buffer pool to be used for index blocks.
-
cell_flash_cache(optional):
string
Cell flash cache hint to be used for index blocks.
-
clustering_factor(optional):
number
Indicates the amount of order of the rows in the table based on the values of the index.
-
compression(optional):
string
The type of compression being used for the index.
-
degree(optional):
string
Number of threads per instance for scanning the index, or DEFAULT.
-
distinct_keys(optional):
integer
Number of distinct indexed values.
-
domidx_management(optional):
string
If this is a domain index, indicates whether the domain index is system-managed (SYSTEM_MANAGED) or user-managed (USER_MANAGED).
-
domidx_opstatus(optional):
string
Status of the operation on a domain index.
-
domidx_status(optional):
string
Status of a domain index.
-
dropped(optional):
string
Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO).
-
duration(optional):
string
Indicates the duration of a temporary table.
-
flash_cache(optional):
string
Database Smart Flash Cache hint to be used for index blocks.
-
freelist_groups(optional):
integer
Number of freelist groups allocated to this segment.
-
freelists(optional):
integer
Number of process freelists allocated to this segment.
-
funcidx_status(optional):
string
Status of a function-based index.
-
generated(optional):
string
Indicates whether the name of the index is system-generated (Y) or not (N).
-
global_stats(optional):
string
GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
-
include_column(optional):
integer
Column ID of the last column to be included in index-organized table primary key (non-overflow) index.
-
index_name(optional):
string
Name of the index.
-
index_type(optional):
string
Type of the index.
-
indexing(optional):
string
Indicates whether a global index is decoupled from the underlying table.
-
ini_trans(optional):
integer
Initial number of transactions.
-
initial_extent(optional):
integer
Size of the initial extent.
-
instances(optional):
string
Number of instances across which the indexes to be scanned, or DEFAULT.
-
iot_redundant_pkey_elim(optional):
string
Indicates whether redundant primary key columns are eliminated from secondary indexes on index-organized tables (YES) or not (NO).
-
ityp_name(optional):
string
For a domain index, the name of the indextype.
-
ityp_owner(optional):
string
For a domain index, the owner of the indextype.
-
join_index(optional):
string
Indicates whether the index is a join index (YES) or not (NO).
-
last_analyzed(optional):
string
Date on which this index was most recently analyzed.
-
leaf_blocks(optional):
integer
Number of leaf blocks in the index.
-
links(optional):
array links
-
logging(optional):
string
Indicates whether or not changes to the index are logged.
-
max_extents(optional):
integer
Maximum number of extents allowed in the segment.
-
max_trans(optional):
integer
Maximum number of transactions.
-
min_extents(optional):
integer
Minimum number of extents allowed in the segment.
-
next_extent(optional):
integer
Size of secondary extents.
-
num_rows(optional):
integer
Number of rows in the index.
-
orphaned_entries(optional):
string
Indicates whether a global index contains stale entries because of deferred index maintenance during DROP/TRUNCATE PARTITION, or MODIFY PARTITION INDEXING OFF operations.
-
owner(optional):
string
Owner of the index.
-
parameters(optional):
string
For a domain index, the parameter string.
-
partitioned(optional):
string
Indicates whether the index is partitioned (YES) or not (NO).
-
pct_direct_access(optional):
number
For a secondary index on an index-organized table, the percentage of rows with VALID guess.
-
pct_free(optional):
integer
Minimum percentage of free space in a block.
-
pct_increase(optional):
number
Percentage increase in extent size.
-
pct_threshold(optional):
number
Threshold percentage of block space allowed per index entry.
-
prefix_length(optional):
integer
Number of columns in the prefix of the compression key.
-
sample_size(optional):
integer
Size of the sample used to analyze the index.
-
secondary(optional):
string
Indicates whether the index is a secondary object created by the ODCIIndexCreate method of the Oracle Data Cartridge (Y) or not (N).
-
segment_created(optional):
string
Indicates whether the index segment has been created (YES) or not (NO).
-
status(optional):
string
Indicates whether a nonpartitioned index is VALID or UNUSABLE.
-
table_name(optional):
string
Name of the indexed object.
-
table_owner(optional):
string
Owner of the indexed object.
-
table_type(optional):
string
Type of the indexed object.
-
tablespace_name(optional):
string
Name of the tablespace containing the index.
-
temporary(optional):
string
Indicates whether the index is on a temporary table (Y) or not (N).
-
uniqueness(optional):
string
Indicates whether the index is unique (UNIQUE) or nonunique (NONUNIQUE).
-
user_stats(optional):
string
Indicates whether statistics were entered directly by the user (YES) or not (NO).
-
visibility(optional):
string
Indicates whether the index is VISIBLE or INVISIBLE to the optimizer.