typesense/include/index.h

#pragma once

#include <string>
#include <vector>
#include <mutex>
#include <condition_variable>
#include <art.h>
#include <number.h>
#include <sparsepp.h>
#include <store.h>
#include <topster.h>
#include <json.hpp>
#include <field.h>
#include <option.h>

struct token_candidates {
    std::string token;
    size_t cost;
    std::vector<art_leaf*> candidates;
};

struct search_args {
    std::string query;
    std::vector<std::string> search_fields;
    std::string simple_filter_query;
    std::vector<facet> facets;
    std::vector<sort_by> sort_fields_std;
    int num_typos;
    size_t per_page;
    size_t page;
    token_ordering token_order;
    bool prefix;
    std::vector<std::pair<int, Topster<100>::KV>> field_order_kvs;
    size_t all_result_ids_len;
    std::vector<std::vector<art_leaf*>> searched_queries;

    search_args() {

    }

    search_args(std::string query, std::vector<std::string> search_fields, std::string simple_filter_query,
                std::vector<facet> facets, std::vector<sort_by> sort_fields_std, int num_typos,
                size_t per_page, size_t page, token_ordering token_order, bool prefix):
            query(query), search_fields(search_fields), simple_filter_query(simple_filter_query), facets(facets),
            sort_fields_std(sort_fields_std), num_typos(num_typos), per_page(per_page), page(page),
            token_order(token_order), prefix(prefix), all_result_ids_len(0) {

    }
};

class Index {
private:
    std::string name;

    uint32_t collection_id;

    size_t num_documents;

    spp::sparse_hash_map<std::string, field> search_schema;

    spp::sparse_hash_map<std::string, field> facet_schema;

    spp::sparse_hash_map<std::string, field> sort_schema;

    spp::sparse_hash_map<std::string, art_tree*> search_index;

    spp::sparse_hash_map<std::string, facet_value> facet_index;

    spp::sparse_hash_map<std::string, spp::sparse_hash_map<uint32_t, number_t>*> sort_index;

    static inline std::vector<art_leaf *> next_suggestion(const std::vector<token_candidates> &token_candidates_vec,
                                                          long long int n);

    void log_leaves(const int cost, const std::string &token, const std::vector<art_leaf *> &leaves) const;

    size_t union_of_ids(std::vector<std::pair<uint32_t*, size_t>> & result_array_pairs, uint32_t **results_out);

    Option<uint32_t> do_filtering(uint32_t** filter_ids_out, const std::string & simple_filter_str);

    void do_facets(std::vector<facet> & facets, uint32_t* result_ids, size_t results_size);

    void populate_token_positions(const std::vector<art_leaf *> &query_suggestion,
                                  spp::sparse_hash_map<const art_leaf *, uint32_t *> &leaf_to_indices,
                                  size_t result_index, std::vector<std::vector<uint16_t>> &token_positions) const;

    void search_field(std::string & query, const std::string & field, uint32_t *filter_ids, size_t filter_ids_length,
                      std::vector<facet> & facets, const std::vector<sort_by> & sort_fields,
                      const int num_typos, const size_t num_results,
                      std::vector<std::vector<art_leaf*>> & searched_queries,
                      Topster<100> & topster, uint32_t** all_result_ids,
                      size_t & all_result_ids_len, const token_ordering token_order = FREQUENCY, const bool prefix = false);

    void search_candidates(uint32_t* filter_ids, size_t filter_ids_length, std::vector<facet> & facets,
                           const std::vector<sort_by> & sort_fields, std::vector<token_candidates> & token_to_candidates,
                           const token_ordering token_order, std::vector<std::vector<art_leaf*>> & searched_queries,
                           Topster<100> & topster, size_t & total_results, uint32_t** all_result_ids,
                           size_t & all_result_ids_len, const size_t & max_results, const bool prefix);

    void index_string_field(const std::string & text, const uint32_t score, art_tree *t, uint32_t seq_id,
                            const bool verbatim) const;

    void index_string_array_field(const std::vector<std::string> & strings, const uint32_t score, art_tree *t,
                                  uint32_t seq_id, const bool verbatim) const;

    void index_int32_field(const int32_t value, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void index_int64_field(const int64_t value, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void index_float_field(const float value, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void index_int32_array_field(const std::vector<int32_t> & values, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void index_int64_array_field(const std::vector<int64_t> & values, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void index_float_array_field(const std::vector<float> & values, const uint32_t score, art_tree *t, uint32_t seq_id) const;

    void remove_and_shift_offset_index(sorted_array &offset_index, const uint32_t *indices_sorted,
                                       const uint32_t indices_length);

public:
    Index() = delete;

    Index(const std::string name, spp::sparse_hash_map<std::string, field> search_schema,
          spp::sparse_hash_map<std::string, field> facet_schema, spp::sparse_hash_map<std::string, field> sort_schema);

    ~Index();

    void run_search();

    Option<size_t> search(std::string query, const std::vector<std::string> search_fields,
                          const std::string & simple_filter_query, std::vector<facet> & facets,
                          std::vector<sort_by> sort_fields_std, const int num_typos,
                          const size_t per_page, const size_t page,
                          const token_ordering token_order, const bool prefix,
                          std::vector<std::pair<int, Topster<100>::KV>> & field_order_kv,
                          size_t & all_result_ids_len, std::vector<std::vector<art_leaf*>> & searched_queries);

    Option<uint32_t> remove(const uint32_t seq_id, nlohmann::json & document);

    void score_results(const std::vector<sort_by> & sort_fields, const int & query_index, const uint32_t total_cost,
                       Topster<100> &topster, const std::vector<art_leaf *> & query_suggestion,
                       const uint32_t *result_ids, const size_t result_size) const;

    Option<uint32_t> index_in_memory(const nlohmann::json & document, uint32_t seq_id, int32_t points);

    static const int MAX_SEARCH_TOKENS = 10;
    static const int MAX_RESULTS = 100;

    // strings under this length will be fully highlighted, instead of showing a snippet of relevant portion
    enum {SNIPPET_STR_ABOVE_LEN = 30};

    // Using a $ prefix so that these meta keys stay above record entries in a lexicographically ordered KV store
    static constexpr const char* COLLECTION_META_PREFIX = "$CM";
    static constexpr const char* COLLECTION_NEXT_SEQ_PREFIX = "$CS";
    static constexpr const char* SEQ_ID_PREFIX = "$SI";
    static constexpr const char* DOC_ID_PREFIX = "$DI";

    /*
     * Concurrency Primitives
    */

    // Used for passing control back and forth between main and worker threads
    std::mutex m;
    std::condition_variable cv;

    bool ready;       // prevents spurious wake up of the worker thread
    bool processed;   // prevents spurious wake up of the main thread
    bool terminate;   // used for interrupting the thread during tear down

    search_args search_params;
};