be/src/storage/index/inverted/query/phrase_query.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#pragma once

#include "storage/index/inverted/inverted_index_query_type.h"
#include "storage/index/inverted/query/phrase_query/exact_phrase_matcher.h"
#include "storage/index/inverted/query/phrase_query/ordered_sloppy_phrase_matcher.h"
#include "storage/index/inverted/query/phrase_query/sloppy_phrase_matcher.h"
#include "storage/index/inverted/query/query.h"
#include "storage/index/inverted/query/term_query.h"
#include "storage/olap_common.h"

CL_NS_USE(index)
CL_NS_USE(search)

namespace doris::segment_v2 {

using namespace inverted_index;

// ExactPhraseMatcher: x match_phrase 'aaa bbb'
// SloppyPhraseMatcher: x match_phrase 'aaa bbb ~2', support slop
// OrderedSloppyPhraseMatcher: x match_phrase 'aaa bbb ~2+', ensuring that the words appear in the specified order.
using Matcher = std::variant<ExactPhraseMatcher, SloppyPhraseMatcher, OrderedSloppyPhraseMatcher>;

class PhraseQuery : public Query {
public:
    PhraseQuery(SearcherPtr searcher, IndexQueryContextPtr context);
    ~PhraseQuery() override = default;

    void add(const InvertedIndexQueryInfo& query_info) override;
    void search(roaring::Roaring& roaring) override;

private:
    // Use skiplist for merging inverted lists
    void search_by_skiplist(roaring::Roaring& roaring);

    int32_t do_next(int32_t doc);
    bool matches(int32_t doc);
    float count_phrase_freq(int32_t doc);

    void init_exact_phrase_matcher(const InvertedIndexQueryInfo& query_info, bool is_similarity);
    void init_sloppy_phrase_matcher(const InvertedIndexQueryInfo& query_info, bool is_similarity);
    void init_ordered_sloppy_phrase_matcher(const InvertedIndexQueryInfo& query_info,
                                            bool is_similarity);

    void init_similarities(const std::wstring& field_name, bool is_similarity);

public:
    static void parser_slop(std::string& query, InvertedIndexQueryInfo& query_info);
    static void parser_info(OlapReaderStatistics* stats, std::string& query,
                            const std::map<std::string, std::string>& properties,
                            InvertedIndexQueryInfo& query_info);

private:
    SearcherPtr _searcher;
    IndexQueryContextPtr _context;

    TermQuery _term_query;

    DISI* _lead1 = nullptr;
    DISI* _lead2 = nullptr;
    std::vector<DISI*> _others;
    std::vector<DISI> _iterators;

    std::vector<Matcher> _matchers;

    SimilarityPtr _phrase_similarity;
};

} // namespace doris::segment_v2