GET_INDEX_STATUS

Use the GET_INDEX_STATUS procedure to query the status of a vector index creation.

Syntax

DBMS_VECTOR.GET_INDEX_STATUS ('USER_NAME','INDEX_NAME');

USER_NAME

Specify the user name of the vector index owner.

INDEX_NAME

Specify the name of the vector index. You can query the index creation status for both Hierarchical Navigable Small World (HNSW) indexes and Inverted File Flat (IVF) indexes.

Usage Notes

  • You can use the GET_INDEX_STATUS procedure only during a vector index creation.

  • The Percentage value is shown in the output only for Hierarchical Navigable Small World (HNSW) indexes (and not for Inverted File Flat (IVF) indexes).

  • The possible values of Stage for HNSW vector indexes are:

    Value Description

    HNSW Index Initialization

    Initialization phase for the HNSW vector index creation

    HNSW Index Auxiliary Tables Creation

    Creation of the internal auxiliary tables for the HNSW Neighbor Graph vector index

    HNSW Index Graph Allocation

    Allocation of memory from the vector memory pool for the HNSW graph

    HNSW Index Loading Vectors

    Loading of the base table vectors into the vector pool memory

    HNSW Index Graph Construction

    Creation of the multi-layered HNSW graph with the previously loaded vectors

    HNSW Index Load From Checkpoints

    HNSW vector index is loading from checkpoints

    HNSW Index Graph Complete

    HNSW vector index graph is complete

    HNSW Index Creation Completed

    HNSW vector index creation finished

  • The possible values of Stage for IVF vector indexes are:

    Value Description

    IVF Index Initialization

    Initialization phase for the IVF vector index creation

    IVF Index Centroids Creation

    The K-means clustering phase that computes the cluster centroids on a sample of base table vectors

    IVF Index Centroid Partitions Creation

    Centroids assignment phase for the base table vectors

    IVF Index Creation Completed

    IVF vector index creation completed

Examples

exec DBMS_VECTOR.GET_INDEX_STATUS('VECTOR_USER','VIDX_HNSW');

Result:

"VECTOR_USER"."IDX1"  inst# 2 HNSW Index Initialization
"VECTOR_USER"."IDX1"  inst# 1 HNSW Index Graph Construction (76.25%)
exec DBMS_VECTOR.GET_INDEX_STATUS('VECTOR_USER','VIDX_HNSW');

Result:

"VECTOR_USER"."IDX1"  inst# 2 HNSW Index Load Vectors (22%)
"VECTOR_USER"."IDX1"  inst# 1 HNSW Index Graph Construction (100%)
exec DBMS_VECTOR.GET_INDEX_STATUS('VECTOR_USER','VIDX_HNSW');

Result:

"VECTOR_USER"."IDX1" HNSW Index Creation Completed

Parent topic: DBMS_VECTOR