Tair (Redis® OSS-Compatible):Comandos do TairSearch

TFT.CREATEINDEX index mappings [settings]

Opções de mapeamento

O objeto mappings suporta os seguintes campos de nível superior:

dynamic

Modo de mapeamento. Valores válidos:

• "strict" -- Dados só podem ser escritos em campos definidos em properties. A escrita em campos não definidos falha.

• Não especificado (padrão) -- Modo não estrito. O sistema não verifica se os campos escritos estão definidos em properties.

enabled

Controla a verificação de tipo para campos não indexados (index definido como false). Valores válidos: true (padrão) e false. Quando true, uma escrita falha se o tipo do campo não corresponder ao tipo definido em properties. Campos indexados sempre passam por verificação de tipo, independentemente desta configuração.

_source

Controla se o documento original é armazenado. Esta configuração não afeta a criação do índice.

• enabled -- true (padrão) armazena o documento original. false não o armazena.

• includes -- Um array de padrões de nomes de campos a incluir. Há suporte para curingas.

• excludes -- Um array de padrões de nomes de campos a excluir. Há suporte para curingas. Se um campo corresponder tanto a includes quanto a excludes, excludes tem precedência (o campo não é armazenado).

Exemplos:

"_source": {"enabled": true}

Esta é a configuração padrão — armazena todos os campos. Equivalente a "_source": {"enabled": true, "excludes": [], "includes": []}.

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

Armazena apenas os campos id e name.

properties

Coleção de definições de campos. Cada campo suporta os seguintes atributos:

Tipos de campo

Suporte a ARRAY: Todos os tipos de campo suportam variantes de array. Acrescente [] ao nome do tipo. Por exemplo, keyword[] declara um array de keywords.

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

Opções de analisador de texto

Configurações do índice

O objeto opcional settings suporta os seguintes campos:

analysis

Define analisadores personalizados. Para mais detalhes, consulte Custom analyzers.

index

Configura algoritmos de similaridade personalizados. Use esta opção para personalizar os parâmetros do Okapi BM25:

Exemplo:

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

Configura o cache de resultados de consulta. Por padrão, o cache armazena até 10.000 resultados sem limite de memória. Quando cheio, os resultados são removidos usando o algoritmo Least Recently Used (LRU).

Exemplo:

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

queries_cache é um parâmetro de nível de nó. Configurá-lo em um índice afeta todos os outros índices no mesmo processo. Utilize a mesma configuração de queries_cache em todos os índices.

compress_doc

Configura a compressão transparente de documentos. Ativar a compressão aumenta o consumo de CPU e a latência de leitura/escrita. Ative esta opção apenas quando o índice for grande (quilobytes ou mais) e o custo de armazenamento for a principal preocupação.

Exemplo:

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

A compressão aplica-se apenas a documentos escritos ou atualizados após você ativar a configuração com TFT.UPDATEINDEX . Documentos existentes não são comprimidos retroativamente.

Valor de retorno

• Em caso de sucesso: OK

• Em caso de falha: Uma mensagem de erro

Exemplo

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

Consulte também: 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}}}

Tipos de consulta

O campo query na Query DSL suporta os seguintes tipos de consulta.

Ordenação

Use o campo sort para controlar a ordem dos resultados. O tipo de dado ARRAY não é suportado para ordenação.

Para ordenação por múltiplos campos, use um array. Controle a direção da ordenação com order ("desc" ou "asc"):

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

Filtragem de source

Use o campo _source para controlar quais campos do documento aparecem nos resultados:

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

Suporta tanto includes quanto excludes com padrões curinga.

Paginação

Usar from e size juntos fornece paginação. O desempenho da consulta diminui à medida que from aumenta.

track_total_hits

Controla se deve contar todos os documentos correspondentes para consultas term, terms ou match (consultas compostas também são suportadas, mas a correspondência difusa dentro de match é desativada).

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

Paginação baseada em cursor

Use size, reply_with_keys_cursor e keys_cursor juntos para paginação:

Como funciona:

1. Primeira consulta: Defina reply_with_keys_cursor como true e omita keys_cursor (ou defina como 0). O Tair recupera size documentos de cada índice, depois reúne, pontua, ordena e agrega os resultados combinados, retornando os principais size documentos. A resposta inclui posições keys_cursor para cada índice.

2. Próxima consulta: Passe o keys_cursor retornado da resposta anterior. O Tair continua a recuperação a partir das posições do cursor em cada índice.

Comportamento de agregação

TFT.MSEARCH agrega conjuntos de resultados filhos de cada índice em vez de agregar o conjunto de dados combinado:

• Taxa e ordenação: Pontua e ordena conjuntos de resultados filhos.

• sum, max, min, avg, value_count: Agrega através dos conjuntos de resultados filhos.

• sum_of_squares, variance, std_deviation: Calcula médias através dos conjuntos de resultados filhos.

• Agregação Terms e agregação Filter: Agrega através dos conjuntos de resultados filhos separadamente.

Valor de retorno

Em caso de sucesso, um objeto JSON semelhante à saída de TFT.SEARCH, mais um campo aux_info:

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

Exemplo

Configure três índices com o mesmo mapeamento:

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}'

Primeira página:

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}}}

Segunda página (passe o keys_cursor da resposta anterior):

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}}}

Consulte também: 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"}'