RemoveIndex

Removes the index of the specified kind on an entity or connection property. Other kinds on that property are retained. Removing an absent index succeeds. Built-in indexes cannot be removed.

Requires indexes.delete permission. No input or output blobs are used.

Parameters

Parameter	Type / required	Default and behavior
target	string / required	No default; entity or connection.
class	string / required	No default; nonempty entity or connection class.
property	string / required	No default; indexed property, valid for the target/class.
kind	string / optional	Defaults to ordered.

Class and property names are matched without case sensitivity. The selector consists of the target, class, property, and kind; parameters are not part of it.

To change an index’s parameters, remove it and create its replacement in the same transaction. If the replacement fails, the transaction restores the original index.

Index selection

Allowed kinds are ordered, trigram, similarity, fulltext, type, and array. An omitted kind selects only the ordered index.

Response and recovery

Success returns status: 0, including when the selected index is absent. Attempting to remove a built-in index returns status: -1. Invalid selectors or unknown kinds fail validation. See Responses for error envelopes and transaction rollback behavior.

Examples

Remove the ordered index on the “name” property of “Person”:

[{
    "RemoveIndex": {
        "kind": "ordered",
        "target": "entity",
        "class": "Person",
        "property": "name"
    }
}]