GetIndexes

Lists index definitions. Each class/property has at most one definition per kind.

Parameters

• target (optional): entity or connection; defaults to both.
• class (optional): Filter by entity or connection class.
• property (optional): Filter by property.
• kind (optional): ordered, trigram, similarity, fulltext, type, or array; defaults to all.

Response

The response contains indexes and returned (the number of definitions). indexes groups definitions by target (entity or connection), then class, then property; each property maps to a list of its definitions. Each definition contains kind, normalized params, version, and type_versions:

    {
        "indexes": {
            "entity": {
                "Person": {
                    "name": [
                        {"kind": "ordered", "params": {"text": "case_sensitive"},
                         "version": 1, "type_versions": [...]},
                        {"kind": "trigram", "params": {"text": "dual_case"},
                         "version": 1, "type_versions": [...]}
                    ]
                }
            }
        },
        "returned": 2
    }

An empty result has indexes: {} and returned: 0. Array definitions report params: {"positions": []} for membership-only indexing, or a sorted, deduplicated list of the configured element positions, or "all" when every position is indexed. type_postings: false is included when explicitly disabled; the default enabled setting is omitted from normalized parameters. Full-text definitions report params: {"analyzer": "unicode_v1"}.

Examples

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