Tair (Redis® OSS-Compatible):TairSearch commands

TFT.CREATEINDEX index mappings [settings]

Opciones de mapeo

El objeto mappings admite los siguientes campos de nivel superior:

Modo de mapeo. Valores válidos:

• "strict" -- Solo se pueden escribir datos en campos definidos en properties. La escritura en campos no definidos falla.

• No especificado (predeterminado) -- Modo no estricto. El sistema no comprueba si los campos escritos están definidos en properties.

Controla la validación de tipos para campos no indexados (index establecido en false). Valores válidos: true (predeterminado) y false. Cuando es true, la escritura falla si el tipo del campo no coincide con el definido en properties. Los campos indexados siempre se validan independientemente de esta configuración.

Controla si se almacena el documento original. Esta configuración no afecta la creación del índice.

• enabled -- true (predeterminado) almacena el documento original. false no lo almacena.

• includes -- Matriz de patrones de nombres de campo que se deben incluir. Se admiten comodines.

• excludes -- Matriz de patrones de nombres de campo que se deben excluir. Se admiten comodines. Si un campo coincide tanto con includes como con excludes, excludes tiene prioridad (el campo no se almacena).

Ejemplos:

"_source": {"enabled": true}

Este es el valor predeterminado: almacena todos los campos. Equivale a "_source": {"enabled": true, "excludes": [], "includes": []}.

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

Almacena únicamente los campos id y name.

Conjunto de definiciones de campos. Cada campo admite los siguientes atributos:

Tipos de campo

Compatibilidad con ARRAY: Todos los tipos de campo admiten variantes de matriz. Agregue [] al nombre del tipo. Por ejemplo, keyword[] declara una matriz de palabras clave.

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

Opciones de analizador de texto

Configuración del índice

El objeto opcional settings admite los siguientes campos:

Define analizadores personalizados. Para más detalles, consulte Custom analyzers.

Configura algoritmos de similitud personalizados. Utilícelo para personalizar los parámetros de Okapi BM25:

Ejemplo:

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

Configura la caché de resultados de consulta. De forma predeterminada, la caché almacena hasta 10,000 resultados sin límite de memoria. Cuando está llena, los resultados se desalojan mediante el algoritmo Least Recently Used (LRU).

Ejemplo:

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

queries_cache es un parámetro a nivel de nodo. Configurar este parámetro en un índice afecta a todos los demás índices del mismo proceso. Utilice la misma configuración de queries_cache en todos los índices.

Configura la compresión transparente de documentos. Habilitar la compresión aumenta el consumo de CPU y la latencia de lectura/escritura. Habilite esta opción solo cuando el índice sea grande (kilobytes o más) y el costo de almacenamiento sea la principal preocupación.

Ejemplo:

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

La compresión se aplica únicamente a los documentos escritos o actualizados después de habilitar la configuración mediante TFT.UPDATEINDEX . Los documentos existentes no se comprimen retroactivamente.

Valor de retorno

• En caso de éxito: OK

• En caso de fallo: Un mensaje de error

Ejemplo

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 también: 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

El campo query en Query DSL admite los siguientes tipos de consulta.

Ordenamiento

Utilice el campo sort para controlar el orden de los resultados. El tipo de datos ARRAY no es compatible con el ordenamiento.

Para ordenar por varios campos, utilice un arreglo. Controle la dirección del ordenamiento con order ("desc" o "asc"):

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

Filtrado de origen

Utilice el campo _source para controlar qué campos del documento aparecen en los resultados:

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

Es compatible con includes y excludes mediante patrones de comodines.

Paginación

El uso conjunto de from y size permite la paginación. El rendimiento de la consulta disminuye a medida que aumenta from .

track_total_hits

Controla si se cuentan todos los documentos coincidentes para consultas term, terms o match (también se admiten consultas compuestas, pero la coincidencia difusa dentro de match se deshabilita).

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

Paginación basada en cursores

Utilice size, reply_with_keys_cursor y keys_cursor de forma conjunta para la paginación:

Funcionamiento:

1. Primera consulta: Establezca reply_with_keys_cursor en true y omita keys_cursor (o establézcalo en 0). Tair recupera size documentos de cada índice; luego recopila, puntúa, ordena y agrega los resultados combinados, y devuelve los mejores size documentos. La respuesta incluye las posiciones de keys_cursor para cada índice.

2. Siguiente consulta: Pase el valor de keys_cursor devuelto en la respuesta anterior. Tair continúa la recuperación desde las posiciones del cursor en cada índice.

Comportamiento de agregación

TFT.MSEARCH agrega conjuntos de resultados secundarios de cada índice en lugar de agregar el conjunto de datos combinado:

• Rate and sort: Puntúa y ordena los conjuntos de resultados secundarios.

• sum, max, min, avg, value_count: Realiza agregaciones en todos los conjuntos de resultados secundarios.

• sum_of_squares, variance, std_deviation: Calcula promedios en todos los conjuntos de resultados secundarios.

• Terms aggregation y filter aggregation: Realiza agregaciones por separado en todos los conjuntos de resultados secundarios.

Valor de retorno

En caso de éxito, devuelve un objeto JSON similar a la salida de TFT.SEARCH, además de un campo aux_info:

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

Ejemplo

Configure tres índices con la misma asignación:

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

Primera 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 (pase el valor de keys_cursor de la respuesta 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 también: 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"}'