Drops the named JSON secondary index and its stored entries. Documents are unaffected. The current wire response is a transitional boolean status.
Successful mutations return an acknowledgement that identifies the affected target, the mutation effect, and commit facts when the operation changed stored state.
Examples
Drop a secondary index.
CLI
$ strata json index create by_name $.name tag
$ strata json index drop by_name
$ strata json index list
Wire
{"field_path":"$.name","index_type":"tag","name":"by_name","type":"json_create_index"}
{"name":"by_name","type":"json_drop_index"}
{"type":"json_list_indexes"}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Index name. |
Plus the optional scope: branch and space (default to the session branch and the "default" space).
Returns
MutationAck<JsonIndexDrop>.
Errors
failed_precondition.engine.runtime_closednot_found.engine.branchinvalid_argument.engine.product_spaceinvalid_argument.engine.json_index_nameinvalid_argument.engine.json_index_name_reserved
Invocation
- CLI:
strata json index drop - Wire type:
json_drop_index