Skip to main content

GetIndexes

Gets all the indexes present in the database, with optional filtering by class, property key, or index type.

Parameters​

  • index_type (Optional): Specifies if you want to retrieve indexes for "entity" or "connection". If omitted, indexes for both are returned.
  • class (Optional): Limits the results to the specified entity or connection class.
  • property_key (Optional): Limits the results to indexes on the specified property key.

Details​

This command returns the list of all indexes in the database that match the provided criteria. It is useful for database introspection.

Examples​

Retrieve all indexes for the entity class "Person":


    [{
        "GetIndexes": {
            "index_type": "entity",
            "class": "Person"
        }
    }]