Docs menu · Reference

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

NameTypeRequiredDescription
namestringyesIndex name.

Plus the optional scope: branch and space (default to the session branch and the "default" space).

Returns

MutationAck<JsonIndexDrop>.

Errors

Invocation

  • CLI: strata json index drop
  • Wire type: json_drop_index

agents: this page as markdown → /docs/reference/json/index/drop.md