Tair (Redis® OSS-Compatible):TairSearch commands

TFT.CREATEINDEX index mappings [settings]

Eşleme seçenekleri

mappings nesnesi aşağıdaki üst düzey alanları destekler:

dynamic

Eşleme modu. Geçerli değerler:

• "strict" -- Veriler yalnızca properties içinde tanımlanan alanlara yazılabilir. Tanımsız alanlara yazma işlemi başarısız olur.

• Belirtilmemiş (varsayılan) -- Katı olmayan mod. Sistem, yazılan alanların properties içinde tanımlı olup olmadığını kontrol etmez.

enabled

Dizine eklenmemiş alanlar için (index değeri false olarak ayarlanmış) tür denetimini kontrol eder. Geçerli değerler: true (varsayılan) ve false. true olduğunda, alan türü properties içinde tanımlanan türle eşleşmezse yazma işlemi başarısız olur. Dizine eklenen alanlar, bu ayardan bağımsız olarak her zaman tür denetimine tabi tutulur.

_source

Orijinal belgenin depolanıp depolanmayacağını kontrol eder. Bu ayar dizin oluşturmayı etkilemez.

• enabled -- true (varsayılan) orijinal belgeyi depolar. false depolamaz.

• includes -- Dahil edilecek alan adı kalıplarının bir dizisi. Joker karakterler desteklenir.

• excludes -- Hariç tutulacak alan adı kalıplarının bir dizisi. Joker karakterler desteklenir. Bir alan hem includes hem de excludes ile eşleşirse excludes önceliklidir (alan depolanmaz).

Örnekler:

"_source": {"enabled": true}

Bu varsayılandır -- tüm alanları depolar. "_source": {"enabled": true, "excludes": [], "includes": []} ile eşdeğerdir.

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

Yalnızca id ve name alanlarını depolar.

properties

Alan tanımlarının bir koleksiyonu. Her alan aşağıdaki nitelikleri destekler:

Alan türleri

ARRAY desteği: Tüm alan türleri dizi varyantlarını destekler. Tür adına [] ekleyin. Örneğin, keyword[] bir anahtar sözcük dizisi bildirir.

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

Metin çözümleyici seçenekleri

Dizin ayarları

İsteğe bağlı settings nesnesi aşağıdaki alanları destekler:

analysis

Özel çözümleyicileri tanımlar. Ayrıntılar için bkz. Özel çözümleyiciler.

index

Özel benzerlik algoritmalarını yapılandırır. Okapi BM25 parametrelerini özelleştirmek için bunu kullanın:

Örnek:

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

Sorgu sonucu önbelleğini yapılandırır. Varsayılan olarak önbellek, bellek sınırı olmadan en fazla 10.000 sonuç saklar. Dolu olduğunda sonuçlar En Az Son Kullanılan (LRU) algoritması kullanılarak temizlenir.

Örnek:

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

queries_cache düğüm düzeyinde bir parametredir. Bir dizinde yapılandırılması aynı işlemdeki diğer tüm dizinleri etkiler. Tüm dizinlerde aynı queries_cache yapılandırmasını kullanın.

compress_doc

Şeffaf belge sıkıştırmayı yapılandırır. Sıkıştırmayı etkinleştirmek CPU tüketimini ve okuma/yazma gecikme süresini artırır. Bu özelliği yalnızca dizin büyükse (kilobayt veya daha fazla) ve depolama maliyeti birincil endişe ise etkinleştirin.

Örnek:

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

Sıkıştırma yalnızca ayarı TFT.UPDATEINDEX ile etkinleştirdikten sonra yazılan veya güncellenen belgelere uygulanır. Mevcut belgeler geriye dönük olarak sıkıştırılmaz.

Dönüş değeri

• Başarılı olduğunda: OK

• Başarısız olduğunda: Bir hata mesajı

Örnek

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

Ayrıca bkz.: 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}}}

Sorgu türleri

Sorgu DSL'sindeki query alanı aşağıdaki sorgu türlerini destekler.

Sıralama

Sonuç sıralamasını kontrol etmek için sort alanını kullanın. ARRAY veri türü sıralama için desteklenmez.

Çok alanlı sıralama için bir dizi kullanın. Sıralama yönünü order ("desc" veya "asc") ile kontrol edin:

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

Kaynak filtreleme

Hangi belge alanlarının sonuçlarda görüneceğini kontrol etmek için _source alanını kullanın:

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

Joker karakter desenleriyle hem includes hem de excludes öğelerini destekler.

Sayfalama

from ve size birlikte kullanıldığında sayfalama sağlar. from arttıkça sorgu performansı düşer.

track_total_hits

term, terms veya match sorguları için eşleşen tüm belgelerin sayılıp sayılmayacağını kontrol eder (bileşik sorgular da desteklenir ancak match içindeki bulanık eşleştirme devre dışı bırakılır).

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

İmleç tabanlı sayfalama

Sayfalama için size, reply_with_keys_cursor ve keys_cursor öğelerini birlikte kullanın:

Nasıl çalışır:

1. İlk sorgu: reply_with_keys_cursor değerini true olarak ayarlayın ve keys_cursor öğesini atlayın (veya 0 olarak ayarlayın). Tair, her dizinden size belge alır, ardından birleştirilmiş sonuçları toplar, puanlar, sıralar ve toplar; en üstteki size belgeyi döndürür. Yanıt, her dizin için keys_cursor konumlarını içerir.

2. Sonraki sorgu: Önceki yanıttan döndürülen keys_cursor değerini iletin. Tair, her dizindeki imleç konumlarından alım işlemini sürdürür.

Toplama davranışı

TFT.MSEARCH birleştirilen veri kümesini toplamak yerine her dizinden gelen alt sonuç kümelerini toplar:

• Oranlandırma ve sıralama: Alt sonuç kümelerini puanlar ve sıralar.

• sum, max, min, avg, value_count: Alt sonuç kümeleri arasında toplama işlemi yapar.

• sum_of_squares, variance, std_deviation: Alt sonuç kümeleri arasında ortalama alır.

• Terms toplama ve filter toplama: Alt sonuç kümelerini ayrı ayrı toplar.

Dönüş değeri

Başarı durumunda, TFT.SEARCH çıkışına benzer bir JSON nesnesi ve ayrıca bir aux_info alanı döndürülür:

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

Örnek

Aynı kimlik eşlemesine sahip üç dizin ayarlayı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}'

İlk sayfa:

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

İkinci sayfa (önceki yanıttan keys_cursor değerini iletin):

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

Ayrıca bkz.: 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"}'