Tair (Redis® OSS-Compatible):Commandes TairSearch

TFT.CREATEINDEX index mappings [settings]

Options de mappage

L'objet mappings prend en charge les champs de premier niveau suivants :

dynamic

Mode de mappage. Valeurs possibles :

• "strict" -- Les données ne peuvent être écrites que dans les champs définis dans properties. L'écriture dans des champs non définis échoue.

• Non spécifié (par défaut) -- Mode non strict. Le système ne vérifie pas si les champs écrits sont définis dans properties.

enabled

Contrôle la vérification de type pour les champs non indexés (index défini sur false). Valeurs possibles : true (par défaut) et false. Lorsque true, une écriture échoue si le type de champ ne correspond pas au type défini dans properties. Les champs indexés font toujours l'objet d'une vérification de type, indépendamment de ce paramètre.

_source

Contrôle si le document original est stocké. Ce paramètre n'affecte pas la création de l'index.

• enabled -- true (par défaut) stocke le document original. false ne le stocke pas.

• includes -- Tableau de motifs de noms de champs à inclure. Les caractères génériques sont pris en charge.

• excludes -- Tableau de motifs de noms de champs à exclure. Les caractères génériques sont pris en charge. Si un champ correspond à la fois à includes et à excludes, excludes a la priorité (le champ n'est pas stocké).

Exemples :

"_source": {"enabled": true}

Il s'agit de la valeur par défaut : tous les champs sont stockés. Équivalent à "_source": {"enabled": true, "excludes": [], "includes": []}.

"_source": {"enabled": true, "excludes": [], "includes": ["id", "name"]}

Stocke uniquement les champs id et name.

properties

Collection de définitions de champs. Chaque champ prend en charge les attributs suivants :

Types de champs

Prise en charge des tableaux (ARRAY) : Tous les types de champs prennent en charge les variantes de tableau. Ajoutez [] au nom du type. Par exemple, keyword[] déclare un tableau de mots-clés.

TFT.CREATEINDEX idx:products '{"mappings":{"properties":{"tags":{"type":"keyword[]"}}}}'

Options de l'analyseur de texte

Paramètres d'index

L'objet settings facultatif prend en charge les champs suivants :

analysis

Définit des analyseurs personnalisés. Pour plus de détails, consultez la section Analyseurs personnalisés.

index

Configure des algorithmes de similarité personnalisés. Utilisez cette option pour personnaliser les paramètres Okapi BM25 :

Exemple :

TFT.CREATEINDEX idx:products '{"mappings":{"properties":{"name":{"type":"keyword","similarity":"my_bm25"}}},"settings":{"index":{"similarity":{"my_bm25":{"type":"BM25","k1":1.0,"b":1.0}}}}}'

queries_cache

Configure le cache des résultats de requête. Par défaut, le cache stocke jusqu'à 10 000 résultats sans limite de mémoire. Lorsqu'il est plein, les résultats sont évincés selon l'algorithme Least Recently Used (LRU).

Exemple :

"settings": {"queries_cache": {"size": "100mb", "ttl": 3}}

queries_cache est un paramètre au niveau du nœud. Sa configuration sur un index affecte tous les autres index du même processus. Utilisez la même configuration queries_cache sur tous les index.

compress_doc

Configure la compression transparente des documents. L'activation de la compression augmente la consommation de CPU et la latence en lecture/écriture. Activez cette option uniquement lorsque l'index est volumineux (de l'ordre du kilooctet ou plus) et que le coût de stockage est la préoccupation principale.

Exemple :

"settings": {"compress_doc": {"size": "1kb", "enable": true}}

La compression s'applique uniquement aux documents écrits ou mis à jour après l'activation du paramètre avec TFT.UPDATEINDEX. Les documents existants ne sont pas compressés rétroactivement.

Valeur de retour

• En cas de succès : OK

• En cas d'échec : Un message d'erreur

Exemple

TFT.CREATEINDEX idx:product '{"mappings":{"_source":{"enabled":true},"properties":{"product_id":{"type":"keyword","ignore_above":128},"product_name":{"type":"text"},"product_title":{"type":"text","analyzer":"jieba"},"price":{"type":"double"}}}}'

OK

Voir aussi : TFT.UPDATEINDEX, TFT.GETINDEX

TFT.UPDATEINDEX index mappings [settings]

TFT.UPDATEINDEX idx:product '{"mappings":{"properties":{"product_group":{"type":"text","analyzer":"chinese"}}}}'

OK

TFT.GETINDEX index

TFT.GETINDEX idx:product

{"idx:product0310":{"mappings":{"_source":{"enabled":true,"excludes":[],"includes":["product_id"]},"dynamic":"false","properties":{"price":{"boost":1.0,"enabled":true,"ignore_above":-1,"index":true,"similarity":"classic","type":"double"},"product_id":{"boost":1.0,"enabled":true,"ignore_above":128,"index":true,"similarity":"classic","type":"keyword"},"product_name":{"boost":1.0,"enabled":true,"ignore_above":-1,"index":true,"similarity":"classic","type":"text"},"product_title":{"analyzer":"chinese","boost":1.0,"enabled":true,"ignore_above":-1,"index":true,"similarity":"classic","type":"text"}}}}}

TFT.ADDDOC index document [WITH_ID doc_id]

TFT.ADDDOC idx:product '{"product_id":"product test"}' WITH_ID 00001

{"_id":"00001"}

TFT.ADDDOC idx:product '{"product_id":["an","2","3df"]}' WITH_ID 00001

TFT.MADDDOC index document doc_id [document1 doc_id1] ...

TFT.MADDDOC idx:product '{"product_id":"test1"}' 00011 '{"product_id":"test2"}' 00012

OK

TFT.UPDATEDOCFIELD index doc_id document

TFT.UPDATEDOCFIELD idx:product 00011 '{"product_id":"test8","product_group":"BOOK"}'

OK

TFT.DELDOCFIELD index doc_id field [field1 field2 ...]

TFT.DELDOCFIELD idx:product 00011 product_group

(integer) 1

TFT.INCRLONGDOCFIELD index doc_id field increment

TFT.INCRLONGDOCFIELD idx:product 00011 stock 100

(integer)100

TFT.INCRFLOATDOCFIELD index doc_id field increment

TFT.INCRFLOATDOCFIELD idx:product 00011 stock 299.6

"299.6"

TFT.GETDOC index doc_id

TFT.GETDOC idx:product 00011

{"_id":"00011","_source":{"product_id":"test8"}}

TFT.EXISTS index doc_id

TFT.EXISTS idx:product 00011

(integer) 1

TFT.DOCNUM index

TFT.DOCNUM idx:product

(integer) 3

TFT.SCANDOCID index cursor [MATCH *value*] [COUNT count]

TFT.SCANDOCID idx:product 0 COUNT 3

1) "0"
2) 1) "00001"
   2) "00011"
   3) "00012"

TFT.DELDOC index doc_id [doc_id] ...

TFT.DELDOC idx:product 00011 00014

"1"    # Document 00014 does not exist, so only document 00011 is deleted.

TFT.DELALL index

TFT.DELALL idx:product

OK

TFT.ANALYZER analyzer_name text [INDEX index_name] [SHOW_TIME]

TFT.ANALYZER standard "Tair is a nosql database"

{
    "tokens": [
        {"token": "Tair", "start_offset": 0, "end_offset": 4, "position": 0},
        {"token": "nosql", "start_offset": 10, "end_offset": 15, "position": 3},
        {"token": "database", "start_offset": 16, "end_offset": 24, "position": 4}
    ]
}

DEL key [key ...]

TFT.SEARCH index query

{
    "hits": {
        "hits": [
            {"_id": "...", "_index": "...", "_score": 1.0, "_source": {...}}
        ],
        "max_score": 1.0,
        "total": {
            "relation": "eq",
            "value": 3
        }
    }
}

TFT.SEARCH idx:product '{"sort":[{"price":{"order":"desc"}}]}'

{"hits":{"hits":[{"_id":"fruits_3","_index":"idx:product","_score":1.0,"_source":{"product_id":"fruits_3","product_name":"orange","price":30.2,"stock":3000}},{"_id":"fruits_2","_index":"idx:product","_score":1.0,"_source":{"product_id":"fruits_2","product_name":"banana","price":24.0,"stock":2000}},{"_id":"fruits_1","_index":"idx:product","_score":1.0,"_source":{"product_id":"fruits_1","product_name":"apple","price":19.5,"stock":1000}}],"max_score":1.0,"total":{"relation":"eq","value":3}}}

Types de requêtes

Le champ query du langage DSL de requête prend en charge les types de requêtes suivants.

Tri

Utilisez le champ sort pour contrôler l'ordre des résultats. Le type de données ARRAY n'est pas pris en charge pour le tri.

Pour un tri sur plusieurs champs, utilisez un tableau. Contrôlez la direction du tri avec order ("desc" ou "asc") :

{"sort": [{"price": {"order": "desc"}}, {"_doc": {"order": "desc"}}]}

Filtrage source

Utilisez le champ _source pour contrôler les champs de document affichés dans les résultats :

{"_source": {"includes": ["f0"]}}

Prend en charge à la fois includes et excludes avec des motifs génériques.

Pagination

L'utilisation conjointe de from et size permet la pagination. Les performances de la requête diminuent à mesure que from augmente.

track_total_hits

Contrôle si tous les documents correspondants doivent être comptés pour les requêtes term, terms ou match (les requêtes composées sont également prises en charge, mais la correspondance floue dans match est désactivée).

TFT.MSEARCH index_count index [index1] ... query

Pagination basée sur un curseur

Utilisez conjointement size, reply_with_keys_cursor et keys_cursor pour la pagination :

Fonctionnement :

1. Première requête : Définissez reply_with_keys_cursor sur true et omettez keys_cursor (ou définissez-le sur 0). Tair récupère size documents de chaque index, puis rassemble, note, trie et agrège les résultats combinés, en renvoyant les size meilleurs documents. La réponse inclut les positions keys_cursor pour chaque index.

2. Requête suivante : Transmettez le keys_cursor renvoyé dans la réponse précédente. Tair poursuit la récupération à partir des positions du curseur dans chaque index.

Comportement d'agrégation

TFT.MSEARCH agrège les ensembles de résultats enfants de chaque index plutôt que d'agréger l'ensemble de données combiné :

• Rate et sort : Note et trie les ensembles de résultats enfants.

• sum, max, min, avg, value_count : Agrège les ensembles de résultats enfants.

• sum_of_squares, variance, std_deviation : Fait la moyenne des ensembles de résultats enfants.

• Terms aggregation et filter aggregation : Agrège séparément les ensembles de résultats enfants.

Valeur de retour

En cas de succès, un objet JSON similaire à la sortie de TFT.SEARCH, plus un champ aux_info :

{
    "aux_info": {
        "index_crc64": 15096806844241479487,
        "keys_cursor": {"key0": 2, "key1": 5, "key2": 3},
        "field_type": {"f0": "long"}
    }
}

Exemple

Configurez trois index avec le même mapping :

TFT.CREATEINDEX key0 '{"mappings":{"properties":{"f0":{"type":"long"}}}}'
TFT.CREATEINDEX key1 '{"mappings":{"properties":{"f0":{"type":"long"}}}}'
TFT.CREATEINDEX key2 '{"mappings":{"properties":{"f0":{"type":"long"}}}}'
TFT.ADDDOC key0 '{"f0":120}'
TFT.ADDDOC key0 '{"f0":130}'
TFT.ADDDOC key1 '{"f0":140}'
TFT.ADDDOC key1 '{"f0":150}'
TFT.ADDDOC key2 '{"f0":160}'
TFT.ADDDOC key2 '{"f0":170}'

Première page :

TFT.MSEARCH 3 key0 key1 key2 '{"size":2,"query":{"range":{"f0":{"gt":120,"lte":170}}},"sort":[{"f0":{"order":"desc"}}],"reply_with_keys_cursor":true}'

{"hits":{"hits":[{"_id":"16625439765504840","_index":"key2","_score":1.0,"_source":{"f0":170}},{"_id":"16625439741096630","_index":"key2","_score":1.0,"_source":{"f0":160}}],"max_score":1.0,"total":{"relation":"eq","value":5}},"aux_info":{"index_crc64":10084399559244916810,"keys_cursor":{"key0":0,"key1":0,"key2":2}}}

Deuxième page (transmettez le keys_cursor de la réponse précédente) :

TFT.MSEARCH 3 key0 key1 key2 '{"size":2,"query":{"range":{"f0":{"gt":120,"lte":170}}},"sort":[{"f0":{"order":"desc"}}],"reply_with_keys_cursor":true,"keys_cursor":{"key0":0,"key1":0,"key2":2}}'

{"hits":{"hits":[{"_id":"16625439652681160","_index":"key1","_score":1.0,"_source":{"f0":150}},{"_id":"16625439624704580","_index":"key1","_score":1.0,"_source":{"f0":140}}],"max_score":1.0,"total":{"relation":"eq","value":5}},"aux_info":{"index_crc64":10084399559244916810,"keys_cursor":{"key0":0,"key1":2,"key2":2}}}

Voir aussi : TFT.SEARCH

TFT.EXPLAINCOST index query

TFT.EXPLAINCOST idx:product '{"sort":[{"price":{"order":"desc"}}]}'

{
    "QUERY_COST": {
        "query": "MATCHALL_QUERY",
        "doc_num": 1,
        "time_cost_us": 2
    },
    "COLLECTOR_COST": {
        "collector_type": "CustomSortCollector",
        "time_cost_us": 20
    }
}

TFT.EXPLAINSCORE index query [doc_id] ...

TFT.EXPLAINSCORE today_shares '{"query":{"wildcard":{"shares_name":{"value":"*BY"}}}}'

{
    "hits": {
        "hits": [
            {
                "_id": "17036492095306830",
                "_index": "today_shares",
                "_score": 1.0,
                "_source": {
                    "shares_name": "YBY",
                    "logictime": 14300410,
                    "purchase_type": 1,
                    "purchase_price": 11.1,
                    "purchase_count": 100,
                    "investor": "Mila"
                },
                "_explanation": {
                    "score": 1.0,
                    "description": "score, computed as query_boost",
                    "field": "shares_name",
                    "term": "*BY",
                    "query_boost": 1.0
                }
            }
        ],
        "max_score": 1.0,
        "total": {"relation": "eq", "value": 1}
    }
}

TFT.ADDSUG index text weight [text weight] ...

TFT.ADDSUG idx:redis 'redis is a memory database' 3 'redis cluster' 10

(integer) 2

TFT.DELSUG index text [text] ...

TFT.DELSUG idx:redis 'redis is a memory database' 'redis cluster'

(integer) 2

TFT.SUGNUM index

TFT.SUGNUM idx:redis

(integer) 3

TFT.GETSUG index prefix [MAX_COUNT count] [FUZZY]

TFT.GETSUG idx:redis res MAX_COUNT 2 FUZZY

1) "redis cluster"
2) "redis lock"

TFT.GETALLSUGS index

TFT.GETALLSUGS idx:redis

1) "redis cluster"
2) "redis lock"
3) "redis is a memory database"

TFT.SEARCH shares '{"query":{"term":{"investor":"Jay"}},"aggs":{"Jay_Sum":{"sum":{"field":"purchase_price"}}}}'

{"hits":{"hits":[{"_id":"16581351808123930","_index":"today_shares0718","_score":1.0,"_source":{"shares_name":"XAX","logictime":14300210,"purchase_type":1,"purchase_price":101.1,"purchase_count":100,"investor":"Jay"}},{"_id":"16581351809626430","_index":"today_shares0718","_score":1.0,"_source":{"shares_name":"XAX","logictime":14300310,"purchase_type":1,"purchase_price":111.1,"purchase_count":100,"investor":"Jay"}}],"max_score":1.0,"total":{"relation":"eq","value":2}},"aggregations":{"Jay_Sum":{"value":212.2}}}

{
    "aggregations": {
        "Per_Investor_Freq": {
            "buckets": [
                {"doc_count": 2, "key": "Jay"},
                {"doc_count": 1, "key": "Mila"}
            ]
        }
    }
}

{"aggs": {"Per_Investor_Freq": {"terms": {"field": "investor"}}}}

TFT.CREATEINDEX today_shares '{"mappings":{"properties":{"shares_name":{"type":"keyword"},"logictime":{"type":"long"},"purchase_type":{"type":"integer"},"purchase_price":{"type":"double"},"purchase_count":{"type":"long"},"investor":{"type":"keyword"}}}}'

TFT.ADDDOC today_shares '{"shares_name":"XAX","logictime":14300210,"purchase_type":1,"purchase_price":101.1,"purchase_count":100,"investor":"Jay"}'
TFT.ADDDOC today_shares '{"shares_name":"XAX","logictime":14300310,"purchase_type":1,"purchase_price":111.1,"purchase_count":100,"investor":"Jay"}'
TFT.ADDDOC today_shares '{"shares_name":"YBY","logictime":14300410,"purchase_type":1,"purchase_price":11.1,"purchase_count":100,"investor":"Mila"}'