Tair (Redis® OSS-Compatible)：Pencarian

Item

Deskripsi

Sintaks

TFT.CREATEINDEX index mappings settings

Deskripsi perintah

Membuat indeks dan pemetaan untuk indeks tersebut. Sintaks yang digunakan untuk membuat pemetaan mirip dengan sintaks yang digunakan untuk membuat pemetaan eksplisit di Elasticsearch. Anda harus membuat indeks sebelum dapat menambahkan dokumen ke indeks tersebut.

Parameter

• index: Nama indeks yang ingin Anda buat.

• mappings: Konten pemetaan. Sintaks yang didukung adalah sebagai berikut:

  • dynamic: Mode pemetaan. Mode pemetaan strict didukung, di mana data hanya dapat ditulis ke bidang yang didefinisikan dalam properties. Upaya menulis data ke bidang yang tidak didefinisikan akan gagal. Jika parameter ini tidak ditentukan, mode pemetaan non-strict digunakan secara default, di mana sistem tidak memeriksa apakah bidang yang akan ditulis didefinisikan dalam properties.

  • enabled: Menentukan apakah akan memaksa memeriksa apakah tipe bidang dokumen yang akan ditulis sama dengan tipe yang ditentukan dalam properties. Jika tipe berbeda, operasi penulisan gagal. Nilai valid: true (default) dan false. Parameter ini hanya berlaku untuk bidang non-terindeks (index diatur ke false). Tipe bidang untuk bidang terindeks selalu diperiksa secara paksa.

  • _source: Menentukan apakah akan menyimpan dokumen asli. Parameter ini tidak memengaruhi pembuatan indeks bidang. Nilai valid:

    enabled: Menentukan apakah akan menyimpan dokumen asli. Nilai valid:

    • true (default): Menyimpan dokumen asli. Secara default, semua bidang disimpan.

      Anda dapat menentukan excludes untuk bidang yang tidak ingin disimpan dan includes untuk bidang yang ingin disimpan. Karakter wildcard diterima. Jika suatu bidang ditentukan baik dalam excludes maupun includes, excludes memiliki prioritas lebih tinggi daripada includes, yang berarti bidang tersebut tidak disimpan dalam dokumen asli. Berikut adalah contohnya.

      Contoh 1: "_source":{"enabled":true} (default) menentukan untuk menyimpan semua bidang dan bekerja seperti "_source":{"enabled":true,"excludes":[],"includes":[]}.

      Contoh 2: "_source":{"enabled":true,"excludes":[],"includes":["id","name"]} menentukan untuk hanya menyimpan bidang id dan name.

    • false: Tidak menyimpan dokumen asli.

  • properties: Kumpulan bidang yang dipetakan. Anda dapat mengatur atribut berikut untuk setiap bidang.

    • index: Menentukan apakah akan mengatur bidang sebagai bidang indeks. Nilai valid adalah sebagai berikut:

      • true (default): Bidang terindeks. Anda hanya dapat menanyakan dokumen dengan menggunakan bidang terindeks.

        Tair menyimpan dokumen asli semua bidang indeks dalam memori. Jika suatu bidang dikonfigurasi dalam _source untuk tidak disimpan, bidang tersebut tidak termasuk dalam dokumen asli yang dikembalikan oleh kueri.

      • false: Bidang tersebut adalah bidang non-terindeks.

    • boost: Bobot bidang. Nilai default: 1. Nilai parameter harus berupa bilangan titik mengambang positif. Tair secara otomatis menghitung skor relatif perkiraan untuk setiap bidang.

    • type: Tipe data bidang. Tipe data ARRAY didukung. Properti ini memiliki nilai valid berikut.

      Catatan

      Sebagai contoh, tipe array untuk keyword adalah keyword[], dan tipe data lainnya didefinisikan secara serupa. Contoh: TFT.CREATEINDEX idx:pro '{"mappings":{"properties":{"f0":{"type":"keyword[]"}}}}'.

      • keyword: String yang tidak dapat dibagi. Nilai valid:

        • ignore_above: Panjang string maksimum untuk keyword. Nilai default adalah 128. Contoh, "ignore_above":128.

        • similarity: Algoritma kemiripan. Nilai valid: classic (default, menunjukkan algoritma TF-IDF) dan BM25 (algoritma Okapi BM25). Contoh: TFT.CREATEINDEX idx:pro '{"mappings":{"properties":{"fs0":{"type":"keyword","similarity":"BM25"}}}}'. Anda juga dapat menyesuaikan parameter untuk algoritma BM25 dalam settings.

      • text: String yang dapat diurai oleh alat analisis dan kemudian disimpan dalam indeks. Nilai valid:

        • analyzer: Mengurai text dan menyimpan hasilnya dalam indeks.

          • Anda dapat memilih alat analisis bawaan TairSearch, termasuk standard (default), jieba (alat analisis Tiongkok yang direkomendasikan yang bekerja lebih baik daripada chinese), stop, IK, pattern, whitespace, simple, keyword, chinese, french, dutch, dan russian. Contoh, "analyzer":"jieba" menunjukkan bahwa alat analisis Tiongkok Jieba digunakan. Untuk informasi selengkapnya, lihat Alat analisis bawaan.

          • Anda juga dapat mendefinisikan alat analisis kustom, misalnya, "analyzer":"my_custom_analyzer", lalu mengonfigurasi alat analisis tersebut menggunakan parameter analysis dalam settings.

        • search_analyzer: Alat analisis yang digunakan untuk pencarian. Jenis alat analisis yang didukung sama dengan parameter analyzer. Nilai default adalah pengaturan parameter analyzer.

        • similarity: Algoritma kemiripan. Nilai valid: classic dan BM25. Nilai default: classic. classic menunjukkan algoritma TF-IDF. BM25 menunjukkan algoritma Okapi BM25. Anda juga dapat menentukan parameter kustom algoritma Okapi BM25 menggunakan parameter settings.

      • long: Tipe data LONG. Anda dapat mengonversi titik waktu menjadi timestamp Unix dan menyimpannya dalam tipe data ini.

      • integer: Tipe data INTEGER.

      • double: Tipe data DOUBLE. Tipe data khusus seperti NaN, Inf, dan -Inf tidak didukung.

• settings (Opsional): Pengaturan untuk indeks. Opsi berikut didukung:

  • analysis: Alat analisis kustom. Untuk informasi selengkapnya, lihat Alat analisis kustom.

  • index: Algoritma kemiripan kustom. Anda dapat memodifikasi parameter algoritma Okapi BM25. Contoh: TFT.CREATEINDEX idx:pro15 '{"mappings":{"properties":{"fs0":{"type":"keyword","similarity":"my_similarity"}}},"settings":{"index":{"similarity":{"my_similarity":{"type":"BM25","k1": 1.0,"b": 1.0}}}}}'. Deskripsi parameter:

    • k1: Relevansi frekuensi suatu term tertentu dalam dokumen terhadap pembobotan term tersebut. Semakin besar nilainya, semakin relevan frekuensinya terhadap pembobotan. Nilai default: 1.2. Anda harus menentukan nilai yang lebih besar dari 0.

    • b: Relevansi ukuran dokumen terhadap pembobotan suatu term tertentu. Semakin besar nilainya, semakin relevan ukuran dokumen terhadap pembobotan. Nilai default: 0.75. Nilai valid: 0 hingga 1.

  • queries_cache: Saat Anda menanyakan dokumen, TairSearch mendukung penyimpanan hasil kueri dalam cache kueri. Secara default, cache menyimpan maksimal 10.000 hasil kueri tanpa batas memori. Ketika batas tercapai, hasil dikeluarkan berdasarkan algoritma Least Recently Used (LRU). Anda dapat menggunakan parameter queries_cache untuk mengonfigurasi memori maksimum dan Time to Live (TTL) untuk cache kueri. Setelah dikonfigurasi, memori maksimum cache kueri ditentukan oleh parameter size. Parameter ini memiliki bidang berikut:

    • size: Tipe data: STRING. Ukuran memori maksimum untuk semua cache kueri. Jika batas memori ini tercapai, hasil kueri juga dikeluarkan berdasarkan algoritma LRU.

      Unit default untuk parameter ini adalah byte. Contoh, "size": "1000" menentukan maksimum 1000 byte untuk cache kueri. Unit "kb" dan "mb" juga didukung, seperti "size": "10kb" dan "size": "1mb".

    • ttl: Periode validitas hasil kueri yang di-cache. Tipe data adalah INTEGER, dan nilai default adalah 10 detik.

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

    Parameter queries_cache adalah parameter tingkat node. Setelah Anda mengonfigurasi parameter ini untuk suatu indeks, indeks lain dalam proses yang sama juga terpengaruh. Oleh karena itu, kami menyarankan semua indeks menggunakan konfigurasi queries_cache yang sama.

  • compress_doc: Menentukan apakah akan mengaktifkan kompresi dokumen transparan. Jika Anda mengaktifkan fitur ini, konsumsi sumber daya CPU dan latensi baca/tulis akan meningkat. Oleh karena itu, kami menyarankan Anda hanya mengaktifkan kompresi dokumen jika indeksnya besar (misalnya dalam kilobyte) dan biaya penyimpanan adalah prioritas utama Anda. Nilai valid:

    • size: String yang menentukan ambang batas kompresi. Indeks hanya dikompresi ketika ukurannya mencapai ambang batas ini. Nilai default adalah "10kb".

      Unit default parameter ini adalah byte. Anda juga dapat menggunakan "kb" dan "mb" sebagai unit. Contoh, "size": "1000", "size": "10kb", dan "size": "1mb".

    • enable: Parameter Boolean yang menentukan apakah akan mengaktifkan fitur kompresi dokumen. Nilai valid adalah false (default) dan true.

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

    Pengaturan kompresi dokumen hanya berlaku untuk dokumen yang ditulis atau diperbarui setelah Anda menggunakan perintah TFT.UPDATEINDEX untuk mengaktifkan atau menonaktifkan kompresi dokumen. Misalnya, jika Anda menjalankan perintah TFT.UPDATEINDEX untuk mengaktifkan kompresi dokumen, Tair hanya mengompresi dokumen yang ditulis atau diperbarui setelah kompresi dokumen diaktifkan. Tair tidak mengompresi dokumen yang ditulis sebelum kompresi dokumen diaktifkan.

Parameter respons.

• Jika operasi berhasil, OK dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

# Tentukan ID produk (product_id) bertipe keyword dan atur batas panjang ID menjadi 128 karakter.
# Buat nama produk (product_name) bertipe text.
# Buat judul produk (product_title) bertipe text dan atur analyzer ke jieba.
# Tentukan harga (price) bertipe double.

Contoh keluaran:

OK

Kategori

Deskripsi

Sintaks

TFT.UPDATEINDEX index mappings settings

Deskripsi perintah

Menambahkan bidang properties ke indeks yang ditentukan atau memodifikasi pengaturan indeks.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• mappings: Konten pemetaan. Anda hanya perlu menentukan bidang properties yang baru ditambahkan (tidak perlu memasukkan informasi dynamic, _source, dan lainnya). Bidang properties yang baru ditambahkan tidak boleh bertentangan dengan bidang yang sudah ada. Jika bertentangan, penambahan akan gagal.

• settings: Memodifikasi pengaturan indeks. Hanya parameter queries_cache, compress_doc, dan index yang dapat dimodifikasi. Untuk parameter index, hanya nilai k1 dan b dalam algoritma BM25 yang dapat dimodifikasi.

Parameter respons

• Jika operasi berhasil, OK dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

OK

Kategori

Deskripsi

Sintaks

TFT.GETINDEX index

Deskripsi perintah

Memperoleh konten pemetaan suatu indeks.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

Parameter respons.

• Jika operasi berhasil, konten pemetaan indeks dalam format JSON dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.GETINDEX idx:product

Contoh keluaran:

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

Item

Deskripsi

Sintaks

TFT.ADDDOC index document [WITH_ID doc_id]

Deskripsi perintah

Menambahkan dokumen ke indeks. Anda dapat menentukan ID unik untuk dokumen dalam indeks menggunakan WITH_ID. Jika ID dokumen sudah ada, ID yang ada akan ditimpa. Jika Anda tidak menentukan WITH_ID (default), ID dokumen akan dibuat secara otomatis.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• document: Dokumen yang akan dimasukkan dalam format JSON. Nilai harus bertipe data yang didefinisikan untuk bidang ini.

  Catatan

  Jika Anda menentukan _source dengan parameter includes untuk hanya menyimpan bidang tertentu, hanya bidang yang ditentukan oleh includes yang disimpan saat Anda menambahkan dokumen ke indeks atau memperbarui dokumen yang telah ditambahkan ke indeks.

• WITH_ID doc_id: Menentukan apakah akan mengonfigurasi ID dokumen. Jika ya, Anda juga harus memasukkan string sebagai nilai doc_id.

Parameter respons

• Jika operasi berhasil, ID dokumen dalam format JSON dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

{"id":"00001"}

Contoh array yang akan ditambahkan:

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

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Menambahkan beberapa dokumen ke indeks. Setiap dokumen harus memiliki ID dokumen yang ditentukan oleh doc_id. Jika sebuah dokumen gagal ditambahkan karena format tidak valid, semua dokumen yang terlibat dalam perintah tersebut tidak akan ditambahkan ke indeks.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• document: Dokumen yang akan dimasukkan dalam format JSON. Nilai harus bertipe data yang didefinisikan untuk bidang ini.

  Catatan

  Jika Anda menentukan _source dengan parameter includes untuk hanya menyimpan bidang tertentu, hanya bidang yang ditentukan oleh includes yang disimpan saat Anda menambahkan dokumen ke indeks atau memperbarui dokumen yang telah ditambahkan ke indeks.

• doc_id: ID dokumen. Nilai harus berupa string.

Parameter respons.

• Jika operasi berhasil, OK dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

OK

Kategori

Deskripsi

Sintaks

TFT.UPDATEDOCFIELD index doc_id document

Deskripsi perintah

Opsi

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• doc_id: ID dokumen.

• document: Konten dokumen dalam format JSON yang ingin Anda perbarui.

  Catatan

  Jika Anda menentukan _source dalam parameter includes untuk hanya menyimpan bidang tertentu, hanya bidang yang ditentukan oleh includes yang disimpan saat Anda menambahkan dokumen ke indeks atau memperbarui dokumen yang telah ditambahkan ke indeks.

Parameter respons.

• Jika operasi berhasil, OK dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

OK

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Opsi

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• doc_id: ID dokumen.

• field: Bidang yang ingin Anda hapus.

Parameter respons.

• Jika operasi berhasil, jumlah bidang yang dihapus dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.DELDOCFIELD idx:product 00011 product_group

Contoh keluaran:

(integer) 1

Kategori

Deskripsi

Sintaks

TFT.INCRLONGDOCFIELD index doc_id field increment

Deskripsi perintah

Opsi

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• doc_id: ID dokumen.

• field: Bidang tempat Anda ingin menambahkan increment. Tipe data bidang hanya dapat berupa LONG atau INTEGER. Tipe data ARRAY tidak didukung.

• increment: Nilai increment yang ingin Anda tambahkan ke bidang. Nilai dapat berupa bilangan bulat positif atau negatif.

Parameter respons.

• Jika operasi berhasil, nilai bidang yang diperbarui dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.INCRLONGDOCFIELD idx:product 00011 stock 100

Contoh keluaran:

(integer)100

Kategori

Deskripsi

Sintaks

TFT.INCRFLOATDOCFIELD index doc_id field increment

Deskripsi perintah

Opsi

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• doc_id: ID dokumen.

• field: Bidang tempat Anda ingin menambahkan increment. Tipe data bidang hanya dapat berupa DOUBLE. Tipe data ARRAY tidak didukung.

• increment: Nilai increment yang ingin Anda tambahkan ke bidang. Nilai dapat berupa bilangan titik mengambang positif atau negatif.

Parameter respons.

• Jika operasi berhasil, nilai bidang yang diperbarui dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.INCRFLOATDOCFIELD idx:product 00011 stock 299.6

Contoh keluaran:

"299.6"

Kategori

Deskripsi

Sintaks

TFT.GETDOC index doc_id

Deskripsi perintah

Memperoleh konten dokumen yang ditentukan oleh doc_id dalam indeks.

Opsi

• index: Nama indeks yang ingin Anda tanyakan.

• doc_id: ID dokumen.

Parameter respons.

• Jika operasi berhasil, ID dan konten dokumen dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.GETDOC idx:product 00011

Contoh keluaran:

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

Kategori

Deskripsi

Sintaks

TFT.EXISTS index doc_id

Deskripsi perintah

Memeriksa apakah dokumen yang ditentukan oleh doc_id ada dalam indeks.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

• doc_id: ID dokumen.

Parameter respons.

• Jika operasi berhasil:

  • Jika dokumen ada, nilai 1 dikembalikan.

  • Jika indeks atau dokumen tidak ada, nilai 0 dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.EXISTS idx:product 00011

Contoh keluaran:

(integer) 1

Kategori

Deskripsi

Sintaks

TFT.DOCNUM index

Deskripsi perintah

Memperoleh jumlah dokumen dalam indeks.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

Nilai kembali

• Jika operasi berhasil, jumlah dokumen dalam indeks dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.DOCNUM idx:product

Contoh keluaran:

(integer) 3

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Memperoleh ID semua dokumen dalam indeks.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

• cursor: Kursor yang digunakan untuk pemindaian ini.

• MATCH *value*: Pencocokan pola, di mana value adalah nilai yang akan dicocokkan, misalnya MATCH *redis*.

• COUNT count: Jumlah maksimum item yang dipindai dalam operasi ini, default adalah 100.

Parameter respons.

• Jika operasi berhasil, array dikembalikan.

  • Elemen pertama: cursor untuk kueri berikutnya. Jika kunci telah sepenuhnya dipindai, 0 dikembalikan.

  • Elemen kedua: doc_id dari kueri ini.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.SCANDOCID idx:product 0 COUNT 3

Contoh keluaran:

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

Item

Deskripsi

Sintaks

TFT.DELDOC index doc_id [doc_id] ...

Deskripsi perintah

Menghapus dokumen yang ditentukan oleh doc_id dari indeks. Beberapa ID dokumen dapat ditentukan.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

• doc_id: ID dokumen.

Parameter respons.

• Jika operasi berhasil, jumlah dokumen yang dihapus dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.DELDOC idx:product 00011 00014

Contoh keluaran:

"1"    # Dalam contoh ini, dokumen dengan ID "00014" tidak ada, sehingga hanya dokumen dengan ID "00011" yang dihapus, mengembalikan 1.

Kategori

Deskripsi

Sintaks

TFT.DELALL index

Deskripsi perintah

Menghapus semua dokumen dari indeks tetapi mempertahankan indeks tersebut.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

• doc_id: ID dokumen.

Parameter respons.

• Jika operasi berhasil, OK dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.DELALL idx:product

Contoh keluaran:

OK

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Menanyakan efek tokenisasi dari alat analisis yang ditentukan.

Opsi

• analyzer_name: Nama alat analisis. Anda dapat menentukan alat analisis bawaan atau kustom.

  Jika Anda menentukan alat analisis kustom atau alat analisis bawaan yang kamus atau kata berhentinya telah dimodifikasi, Anda juga harus menentukan nama indeks tempat alat analisis tersebut dibuat (INDEX).

• text: Dokumen yang ingin Anda bagi menggunakan alat analisis. Dokumen harus dikodekan dalam format UTF-8.

• INDEX (opsional): Nama indeks tempat alat analisis tersebut dibuat. Jika Anda menentukan alat analisis kustom atau alat analisis bawaan yang kamus atau kata berhentinya telah dimodifikasi, parameter ini wajib diisi.

• SHOW_TIME (opsional): Menentukan apakah akan mengembalikan jumlah waktu yang dibutuhkan untuk membagi dokumen menjadi token. Satuan: mikrodetik (us).

  Jumlah waktu mencakup waktu yang dibutuhkan untuk memuat kamus. Pertama kali kamus yang relatif besar dimuat, seperti JiebaAnalyzer atau IKAnalyzer, jumlah waktu dapat meningkat hingga beberapa detik.

Parameter respons.

• Jika operasi berhasil, informasi token dikembalikan dalam format JSON.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.ANALYZER standard "Tair is a nosql database"

Contoh keluaran:

'{
    "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
        }
    ]
}'

Kategori

Deskripsi

Sintaks

TFT.SEARCH index query

Deskripsi perintah

Mencari dokumen dalam indeks berdasarkan pernyataan kueri. Sintaks kueri mirip dengan sintaks Elasticsearch.

Opsi

index adalah nama indeks yang ingin Anda kelola dengan menjalankan perintah ini; query adalah pernyataan Query DSL yang mirip dengan sintaks yang digunakan di Elasticsearch. Bidang berikut didukung:

• query: Klausa kueri. Sintaks berikut didukung:

  • match: Kueri pencocokan dasar. Parameter berikut didukung.

    Dalam skenario yang tidak memerlukan pemecahan karakter dokumen menjadi token individual atau tidak memerlukan pencocokan fuzzy, kami menyarankan Anda menggunakan perintah seperti term dan prefix untuk meningkatkan efisiensi kueri.

    • query: Dokumen dalam indeks yang diperoleh menggunakan kueri.

      Catatan

      • Jika pencocokan fuzzy dinonaktifkan menggunakan fuzziness, dokumen yang diperoleh oleh kueri dipecah menjadi token individual oleh pemisah kata yang ditentukan oleh analyzer. Anda juga dapat menentukan hubungan antar token menggunakan operator dan jumlah minimum token yang perlu dicocokkan menggunakan minimum_should_match.

      • Jika pencocokan fuzzy diaktifkan menggunakan fuzziness, parameter di atas tidak berlaku. Dalam kasus ini, Anda dapat menentukan prefix_length.

    • analyzer: Pemisah kata yang digunakan oleh pernyataan match. Nilai valid: standard (default, pemisah kata Inggris), chinese, arabic, cjk, czech, brazilian, german, greek, persian, french, dutch, russian, dan jieba (pemisah kata Tiongkok). Untuk informasi selengkapnya, lihat Alat analisis pencarian.

    • minimum_should_match: Jumlah minimum token yang perlu dicocokkan. Pemisah kata memecah pernyataan kueri menjadi token. Parameter ini berlaku ketika pencocokan fuzzy dinonaktifkan dan operator diatur ke OR.

    • operator: Hubungan antar token. Nilai valid: AND dan OR. Nilai default: OR. Contoh, '{"query":{"match":{"f0":{"query":"redis cluster","operator":"OR"}}}}' menentukan bahwa kondisi pencarian terpenuhi ketika "redis" atau "cluster" terdapat dalam dokumen yang ingin Anda kueri.

    • fuzziness: Menentukan apakah akan mengaktifkan pencocokan fuzzy untuk kueri. Secara default, pencocokan fuzzy dinonaktifkan. "fuzziness":1 menentukan bahwa pencocokan fuzzy diaktifkan. Contoh: '{"query":{"match":{"f0":{"query":"excelentl","fuzziness":1}}}}'.

    • prefix_length: Jumlah karakter awal yang harus dipertahankan untuk pencocokan fuzzy. Nilai default: 0. Parameter ini hanya berlaku ketika pencocokan fuzzy diaktifkan.

  • term: Kueri token. Jika parameter ini ditentukan, pernyataan kueri tidak dibagi. Jenis kueri ini lebih efisien daripada kueri match. Parameter ini mendukung semua tipe bidang. Saat melakukan kueri token, Anda dapat mengatur parameter lowercase untuk mengonversi token yang ingin Anda kueri menjadi huruf kecil. Nilai valid parameter lowercase adalah true dan false. Nilai default adalah true. Contoh: '{"query":{"term":{"f0":{"value":"redis","boost": 2.0}}}}' atau '{"query":{"term":{"f0":{"value":"redis","lowercase": false}}}}'.

    Jika alat analisis yang digunakan saat Anda menambahkan dokumen tidak mengonversi dokumen menjadi huruf kecil, kami menyarankan Anda mengatur parameter lowercase ke false. Jika tidak, dokumen mungkin tidak ditemukan.

  • terms: Kueri multi-token. Maksimal 1024 token diperbolehkan dalam setiap kueri multi-token. Saat melakukan kueri token, Anda dapat mengatur parameter lowercase untuk mengonversi token yang ingin Anda kueri menjadi huruf kecil. Nilai valid parameter lowercase adalah true dan false. Nilai default adalah true. Contoh: '{"query":{"terms":{"f0":["redis","excellent"]}}}'.

    Jika alat analisis yang digunakan saat Anda menambahkan dokumen tidak mengonversi dokumen menjadi huruf kecil, kami menyarankan Anda mengatur parameter lowercase ke false. Jika tidak, dokumen mungkin tidak ditemukan.

  • range: Kueri rentang. Parameter ini mendukung semua tipe bidang. Nilai valid: lt (kurang dari), gt (lebih dari), lte (kurang dari atau sama dengan), dan gte (lebih dari atau sama dengan). Contoh: '{"query":{"range":{"f0":{"lt":"abcd","gt":"ab"}}}}'.

  • wildcard: Kueri wildcard. Format nilai parameter: "wildcard":{"field to query":{"value":"query content"}}. Karakter wildcard yang didukung: * dan ?. Contoh: '{"query":{"wildcard":{"f0":{"value":"*b?Se"}}}}'.

  • prefix: Kueri awalan. Contoh, '{"query":{"prefix":{"f0":"abcd"}}' menentukan untuk menanyakan dokumen yang bidang f0-nya diawali dengan abcd.

  • bool: Kueri majemuk. Maksimal 1.024 token diperbolehkan dalam setiap kueri majemuk. Nilai valid:

    • must: Hasil kueri harus mencocokkan semua klausa kueri dalam daftar must. Contoh, '{"query":{"bool":{"must":[{"match":{"DB":"redis"}},{"match":{"Architectures":"cluster"}}]}}}' menentukan bahwa jenis basis data yang ingin Anda kueri adalah Redis dan arsitektur instans yang berisi basis data tersebut adalah kluster.

    • must_not: Hasil kueri tidak mencocokkan klausa kueri apa pun dalam daftar must_not.

    • should: Daftar should. Jika bool diatur ke should, hasil kueri harus mencocokkan satu klausa kueri dalam daftar ini. Anda dapat mengatur parameter minimum_should_match.

    • minimum_should_match: Menentukan jumlah minimum klausa kueri yang harus dicocokkan. Parameter ini harus digunakan bersama dengan should. Jika pernyataan bool hanya berisi should, minimum_should_match diatur ke 1 secara default. Jika pernyataan bool juga berisi must atau must_not, minimum_should_match diatur ke 0 secara default. Contoh, '{"query":{"bool":{"minimum_should_match":1,"should":[{"match":{"DB":"redis"}},{"match":{"Architectures":"cluster"}}]}}}' menentukan bahwa jenis basis data yang ingin Anda kueri adalah Redis atau arsitektur instans yang berisi basis data tersebut adalah kluster.

    Catatan

    Pernyataan bool dapat memiliki semua jenis klausa kueri bersarang di dalamnya, seperti klausa bool. Contoh: TFT.SEARCH idx:product '{"query":{"bool":{"must":[{"term":{"product_name":"apple"}},{"bool":{"minimum_should_match":1,"should":[{"term":{"price":19.5}},{"term":{"product_id":"fruits_2"}}]}}]}}}'.

  • dis_max: Kueri majemuk untuk pencocokan terbaik. Secara default, parameter ini mengembalikan dokumen yang mencocokkan satu atau beberapa klausa kueri. Jika dokumen yang dikembalikan mencocokkan beberapa klausa kueri, kueri dis_max memberikan dokumen tersebut skor tertinggi dari klausa yang cocok dan penambahan skor pemecah seri ke skor dokumen jika tie_breaker ditentukan.

    Jika Anda menentukan parameter tie_breaker, skor dokumen yang mencocokkan beberapa klausa kueri meningkat. Nilai tie_breaker dapat berkisar dari 0 hingga 1, dan nilai default adalah 0. Setelah Anda menentukan tie_breaker, skor akhir dokumen dihitung menggunakan rumus berikut: skor dari klausa pencocokan terbaik + (jumlah skor dari semua klausa pencocokan lainnya × nilai tie_breaker). Misalnya, jika kueri berisi tiga klausa, nilai tie_breaker adalah 0.5, dan skor dokumen bernama doc1 untuk setiap klausa adalah 5, 1, dan 3, skor akhir untuk doc1 adalah 5 + ((1 + 3) × 0.5).

    Contoh: '{"query":{"dis_max":{"queries":[{"term":{"f0":"redis"}},{"term":{"f1":"database"}},{"match":{"title":"redis memory database"}}],"tie_breaker": 0.5}}}'.

  • constant_score: Kueri majemuk yang mengembalikan skor konstan. Kueri ini membungkus kueri lain dan mengembalikan skor konstan yang sama dengan boost kueri untuk setiap dokumen dalam filter. Nilai boost bertipe DOUBLE, dan nilai boost default adalah 1.0. Contoh: '{"query":{"constant_score":{"filter":{"term":{"f0":"abc"}},"boost":1.2}}}'.

  • match_all: Kueri pencocokan semua. Kueri ini mencocokkan semua dokumen dan memberikan semua dokumen nilai boost. Nilai boost bertipe DOUBLE, dan nilai boost default adalah 1.0. Contoh: '{"query":{"match_all":{"boost":2.3}}}'.

  Catatan

  Jika Anda melakukan kueri majemuk menggunakan bool, dis_max, dan constant_score, Anda dapat mengatur nilai boost untuk term, terms, range, dan wildcard. Nilai boost default adalah 1. Anda harus menentukan parameter tempat nilai boost diterapkan dalam sintaks kueri. Contoh: '{"query":{"bool":{"must":[{"match":{"f0":"v0"}},"term":{"f0":{"value":"redis","boost":2}}]}}}'.

• sort: Mengurutkan hasil kueri berdasarkan faktor. Tipe data ARRAY tidak didukung. Nilai default: _score. Nilai valid:

  • _score: Mengurutkan hasil kueri berdasarkan bobot dalam urutan menurun. Contoh: "sort":"_score".

  • _doc: Mengurutkan hasil kueri berdasarkan ID dokumen dalam urutan menaik. Contoh: "sort":"_doc".

  • Bidang yang ditentukan: Mengurutkan hasil kueri berdasarkan bidang yang ditentukan dalam urutan menaik. Bidang tersebut harus merupakan bidang terindeks (index diatur ke true) atau bidang yang diperiksa secara paksa (enabled diatur ke true). Bidang tersebut harus bertipe keyword, long, integer, atau double. Misalnya, "sort":"price" menentukan untuk mengurutkan hasil kueri berdasarkan harga dalam urutan menaik.

  Anda juga dapat menggunakan array untuk mengurutkan hasil kueri. Dalam kasus ini, hasil kueri diurutkan berdasarkan urutan array. Anda dapat menggunakan order untuk memodifikasi urutan array default. Nilai valid order: desc dan acs. Misalnya, '{"sort":[{"price":{"order":"desc"}},{"_doc":{"order":"desc"}}]}' menentukan untuk mengurutkan hasil kueri berdasarkan harga atau berdasarkan ID dokumen jika harganya sama.

• _source: Bidang yang ditampilkan dalam hasil kueri. Anda dapat menggunakan includes untuk menentukan bidang yang ingin Anda simpan dan menggunakan excludes untuk menentukan bidang yang tidak ingin Anda simpan. Karakter wildcard diterima. Misalnya, "_source":{"includes":["f0"] menentukan untuk hanya mengembalikan bidang f0 dalam hasil kueri.

• aggs: Mengagregasi hasil klausa query. Jika bidang bertipe data ARRAY, hanya agregasi terms yang didukung. Untuk informasi selengkapnya, lihat Agregasi.

• track_total_hits: Menentukan apakah akan menanyakan semua dokumen saat Anda menggunakan kueri term, terms, atau match. Dalam kasus ini, kueri majemuk didukung. Jika Anda menggunakan kueri match, pencocokan fuzzy dinonaktifkan. Nilai valid:

  • false: Hanya 100 dokumen teratas yang ditanyakan. Dokumen diurutkan berdasarkan skor.

  • true: Semua dokumen ditanyakan.

    Peringatan

    Jika track_total_hits diatur ke true dan jumlah dokumen yang ditanyakan besar, kueri lambat terjadi. Harap berhati-hati.

• from: Dokumen awal yang dikembalikan. Nilai default adalah 0, yang menentukan untuk mengembalikan dokumen pertama dan semua dokumen berikutnya yang ditanyakan.

• size: Jumlah dokumen yang dapat dikembalikan. Nilai default: 10. Nilai valid: 0 hingga 10000. Nilai 0 menentukan untuk hanya mengembalikan jumlah total dokumen yang diperoleh, bukan dokumen spesifik.

  Catatan

  Kombinasi from dan size bekerja seperti paging. Namun, performa kueri menurun seiring bertambahnya jumlah halaman diskrit.

Keluaran

• Jika operasi berhasil, dokumen dalam indeks dikembalikan.

  Catatan

  Dalam contoh keluaran berikut, relation menunjukkan jumlah dokumen yang dikembalikan. Nilai valid relation: eq (sama dengan nilai yang ditentukan oleh value) dan gte (lebih besar dari atau sama dengan nilai yang ditentukan oleh value).

  {
      "hits": {
          "hits": [],
          "max_score": null,
          "total": {
              "relation": "gte",
              "value": 100
          }
      }
  }

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

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

Item

Deskripsi

Sintaks

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

Deskripsi perintah

Menanyakan dokumen dalam beberapa indeks yang memiliki mappings dan settings diatur ke nilai yang sama menggunakan klausa kueri dan mengumpulkan hasil dari indeks-indeks tersebut. Kemudian, hasilnya dinilai, diurutkan, diagregasi, dan dikembalikan.

Parameter

• index_cout: Jumlah indeks yang ingin Anda tanyakan. Nilai valid: 1 hingga 100.

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini. Indeks-indeks ini harus memiliki mappings dan settings diatur ke nilai yang sama. Jika konfigurasi mappings berbeda untuk indeks yang berbeda atau jika suatu indeks tidak ada, kesalahan dilaporkan.

• query: Pernyataan agregasi. Parameter berikut didukung:

  • query: Klausa kueri.

  • sort: Mengurutkan hasil kueri berdasarkan faktor. Tipe data ARRAY tidak didukung.

  • _source: Bidang yang dikembalikan dalam hasil.

  • aggs: Mengagregasi hasil klausa kueri. Jika bidang bertipe data ARRAY, hanya agregasi terms yang didukung.

  • track_total_hits: Menentukan apakah akan menanyakan semua dokumen saat Anda menggunakan kueri term, terms, atau match. Dalam kasus ini, kueri majemuk didukung. Jika Anda menggunakan kueri match, pencocokan fuzzy dinonaktifkan.

  • size: Jumlah dokumen yang dikembalikan.

    Kueri berhalaman dapat diimplementasikan menggunakan size, reply_with_keys_cursor, dan keys_cursor. Jika keys_cursor diatur ke nilai default 0, Tair mengambil jumlah dokumen yang ditentukan mulai dari dokumen pertama dari hasil yang diperoleh dari indeks. Jika keys_cursor tidak diatur ke 0, jumlah dokumen tertentu diambil mulai dari posisi tertentu. Kemudian, hasil dari indeks-indeks ini dikumpulkan untuk dinilai, diurutkan, diagregasi, dan dikembalikan sebagai keluaran.

    Sebagai contoh, asumsikan Anda ingin menanyakan tiga indeks key0, key1, dan key2 sekaligus dan Anda mengatur parameter size ke 10:

    • Untuk kueri pertama, atur keys_cursor ke 0. Tair mengambil 10 dokumen pertama dari ketiga indeks tersebut masing-masing. Kemudian, Tair mengumpulkan, menilai, mengurutkan, dan mengagregasi 30 dokumen ini dan mengembalikan 10 dokumen teratas. Contoh nilai kembalian keys_cursor: {"keys_cursor":{"key0":2,"key1":5,"key2":3}}.

    • Untuk kueri kedua, gunakan pernyataan kueri yang sama dan tambahkan {"keys_cursor":{"key0":2,"key1":5,"key2":3}}. Tair mengambil 10 dokumen pertama dari posisi yang ditentukan dalam indeks-indeks tersebut. Misalnya, Tair mengambil 10 dokumen mulai dari yang ketiga dalam indeks key0. Kemudian, Tair mengumpulkan, menilai, mengurutkan, dan mengagregasi dokumen yang diambil, lalu mengembalikan keluaran.

  • reply_with_keys_cursor: Menentukan apakah akan mengembalikan posisi awal kueri berikutnya untuk setiap indeks. Nilai valid: true dan false. Nilai default: false.

  • keys_cursor: Menentukan posisi kursor dalam setiap indeks untuk kueri. Untuk mengimplementasikan kueri berhalaman, atur keys_cursor ke nilai kembalian kueri sebelumnya. Nilai default adalah 0, yang menunjukkan bahwa kueri dimulai dari dokumen pertama.

Parameter respons.

• Jika operasi berhasil, dokumen yang diperoleh dan aux_info dikembalikan, yang mirip dengan keluaran perintah TFT.SEARCH.

  Bidang aux_info mencakup nilai CRC-64 dari mappings dan settings (yang dapat diabaikan untuk permintaan bisnis), nilai keys_cursor (opsional, menunjukkan posisi kursor untuk kueri berikutnya dalam setiap indeks), dan nilai field_type (tipe data bidang, hanya dikembalikan saat pengurutan berdasarkan bidang indeks). Contoh aux_info:

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

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

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

Contoh perintah:

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

Contoh respons:

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

Contoh perintah untuk menanyakan halaman kedua:

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}}'
# Pernyataan kueri sama dengan kueri pertama, tetapi Anda perlu menambahkan informasi keys_cursor yang dikembalikan dari kueri sebelumnya.

Contoh respons:

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

Item

Deskripsi

Sintaks

TFT.EXPLAINCOST index query

Deskripsi perintah

Menanyakan durasi eksekusi pernyataan kueri. Keluaran mencakup jumlah dokumen yang terlibat dalam kueri dan jumlah waktu yang dikonsumsi oleh setiap operasi dalam kueri.

Opsi

• index: Nama indeks yang ingin Anda tanyakan.

• query: Pernyataan kueri yang memiliki sintaks yang sama dengan perintah TFT.SEARCH.

Parameter respons.

• Jika operasi berhasil, keluaran dikembalikan dalam format JSON. Keluaran dapat berisi item berikut:

  • QUERY_COST: Durasi eksekusi kueri dalam mikrodetik (time_cost_us). Juga mencakup informasi tampilan kueri (query) dan jumlah dokumen yang terlibat dalam kueri (doc_num). Jika metode kueri bool digunakan, waktu eksekusi setiap langkah dalam proses kueri bool (steps) akan ditampilkan.

  • AGGS_COST: Waktu yang dihabiskan untuk agregasi selama proses kueri, dalam mikrodetik (time_cost_us). Jika tidak ada kueri agregasi yang ditentukan dalam pernyataan kueri, biaya ini tidak akan disertakan.

  • COLLECTOR_COST: Waktu yang dihabiskan untuk mengumpulkan dan mengurutkan hasil kueri, dalam mikrodetik (time_cost_us). Juga mencakup jenis pengurutan (collector_type), dengan nilai kembalian berupa pengurutan skor (ScoreCollector) dan pengurutan kustom (CustomSortCollector).

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

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

Kategori

Deskripsi

Sintaks

TFT.EXPLAINSCORE index query [doc_id] ...

Deskripsi perintah

Menanyakan informasi skor terperinci dari dokumen yang dihasilkan dari eksekusi pernyataan kueri. Anda dapat menggunakan perintah ini untuk memahami proses perhitungan skor dokumen. Kemudian, Anda dapat mengoptimalkan kueri pencarian untuk meningkatkan efektivitas pengambilan dokumen.

Perintah ini hanya tersedia untuk instans berbasis DRAM yang kompatibel dengan Redis 6.0.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• query: Pernyataan kueri yang memiliki sintaks yang sama dengan perintah TFT.SEARCH.

• doc_id: ID dokumen. Jika parameter ini ditentukan, hanya dokumen yang ditentukan oleh doc_id yang dikembalikan.

Parameter respons.

• Jika operasi berhasil, informasi dokumen yang ditanyakan dikembalikan. Informasi skor terperinci untuk setiap dokumen (_explanation) merupakan tambahan pada set hasil dasar yang dikembalikan oleh perintah TFT.SEARCH. Objek _explanation berisi bidang-bidang berikut:

  • score: Skor dokumen.

  • description: Rumus yang digunakan untuk perhitungan skor.

  • field: Bidang dokumen yang cocok dengan term yang ditentukan dalam kueri.

  • term: Term dari kueri yang ditemukan dalam dokumen.

  • query_boost: Bobot penilaian yang diterapkan pada dokumen dalam kueri.

  • details: Metadata dan proses penilaian untuk dokumen.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

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

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Menambahkan satu atau beberapa teks penyelesaian otomatis dan bobotnya ke indeks yang ditentukan.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• text: Entri teks penyelesaian otomatis.

• weight: Bobot penilaian teks yang sesuai, yang harus berupa bilangan bulat positif.

Parameter respons

• Jika operasi berhasil, jumlah entri teks yang ditambahkan dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

(integer) 2

Kategori

Deskripsi

Sintaks

TFT.DELSUG index text [text] ...

Deskripsi perintah

Menghapus satu atau beberapa entri teks penyelesaian otomatis dari indeks yang ditentukan.

Parameter

• index: Nama indeks yang ingin Anda kelola dengan menjalankan perintah ini.

• text: Entri teks yang ingin Anda hapus dari indeks. Entri teks harus lengkap dan akurat.

Keluaran

• Jika operasi berhasil, jumlah entri teks yang dihapus dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

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

Contoh keluaran:

(integer) 2

Kategori

Deskripsi

Sintaks

TFT.SUGNUM index

Deskripsi perintah

Memperoleh jumlah teks penyelesaian otomatis dalam indeks yang ditentukan.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

Parameter respons.

• Jika operasi berhasil, jumlah teks dalam indeks dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.SUGNUM idx:redis

Contoh keluaran:

(integer) 3

Kategori

Deskripsi

Sintaks

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

Deskripsi perintah

Memperoleh teks penyelesaian otomatis yang dapat dicocokkan berdasarkan awalan yang ditentukan. Teks dikembalikan dalam urutan menurun berdasarkan bobot.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

• prefix: Awalan kueri yang ditentukan.

• MAX_COUNT count: Mengonfigurasi jumlah maksimum entri teks yang dikembalikan, dengan nilai count berkisar dari [0,255].

• FUZZY: Apakah akan mengaktifkan pencocokan fuzzy.

Parameter respons.

• Jika operasi berhasil, daftar entri teks penyelesaian otomatis dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.GETSUG idx:redis res MAX_COUNT 2 FUZZY

Contoh keluaran:

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

Kategori

Deskripsi

Sintaks

TFT.GETALLSUGS index

Deskripsi perintah

Memperoleh semua entri teks penyelesaian otomatis dalam indeks yang ditentukan.

Parameter

• index: Nama indeks yang ingin Anda tanyakan.

Parameter respons.

• Jika operasi berhasil, daftar entri teks penyelesaian otomatis dikembalikan.

• Jika tidak, pesan kesalahan dikembalikan.

Contoh

Contoh perintah:

TFT.GETALLSUGS idx:redis

Contoh keluaran:

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