Skip to main content

RemoveIndex

Removes one index by index_id, or all indexes on a class/property using the legacy selector format. Removing an absent index succeeds.

Parameters​

Use exactly one of these forms:

  • index_id: A positive integer returned by CreateIndex or GetIndexes.
  • index_type, class, property_key: The complete property selector; index_type is entity or connection. Removes every matching definition across all kinds and parameter configurations. Class and property names are matched without case sensitivity.

An index_id cannot be combined with property selector fields. Neither kind nor algorithm is accepted; use an index ID to remove a specific definition.

Examples​

Remove a single definition:


    [{"RemoveIndex": {"index_id": 42}}]

Remove every index on the "name" property of "Person":


    [{
        "RemoveIndex": {
            "index_type": "entity",
            "class": "Person",
            "property_key": "name"
        }
    }]