remote-database.h

Go to the documentation of this file.

 
/* Copyright (C) 2006-2024 Olly Betts
 * Copyright (C) 2007,2009,2010 Lemur Consulting Ltd
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef XAPIAN_INCLUDED_REMOTE_DATABASE_H
#define XAPIAN_INCLUDED_REMOTE_DATABASE_H
 
#include "backends/backends.h"
#include "backends/databaseinternal.h"
#include "api/enquireinternal.h"
#include "api/queryinternal.h"
#include "net/remoteconnection.h"
#include "backends/valuestats.h"
#include "xapian/weight.h"
 
#include <utility>
 
namespace Xapian {
    class RSet;
}
 
class NetworkPostList;
 
class RemoteDatabase : public Xapian::Database::Internal {
    void operator=(const RemoteDatabase &);
 
    RemoteDatabase(const RemoteDatabase &);
 
    mutable OwnedRemoteConnection link;
 
    mutable Xapian::doccount doccount;
 
    mutable Xapian::docid lastdocid;
 
    mutable Xapian::termcount doclen_lbound;
 
    mutable Xapian::termcount doclen_ubound;
 
    mutable Xapian::totallength total_length;
 
    mutable bool has_positional_info;
 
    mutable bool pending_reply = false;
 
    mutable std::string uuid;
 
    mutable bool cached_stats_valid;
 
    mutable ValueStats mru_valstats;
 
    mutable Xapian::valueno mru_slot;
 
    mutable bool uncommitted_changes = false;
 
    bool update_stats(message_type msg_code = MSG_UPDATE,
                      const std::string & body = std::string()) const;
 
  protected:
    RemoteDatabase(std::pair<int, std::string> fd_and_context,
                   double timeout_,
                   bool writable,
                   int flags);
 
    reply_type get_message(std::string& message,
                           reply_type required_type,
                           reply_type required_type2) const;
 
    void get_message(std::string& message,
                     reply_type required_type) const {
        (void)get_message(message, required_type, required_type);
    }
 
    bool get_message_or_done(std::string& message,
                             reply_type required_type) const {
        return get_message(message, required_type, REPLY_DONE) != REPLY_DONE;
    }
 
    void send_message(message_type type, std::string_view data) const;
 
    void do_close();
 
    bool get_posting(Xapian::docid& did, double& w, std::string& value);
 
    double timeout;
 
  public:
    Xapian::termcount positionlist_count(Xapian::docid did,
                                         std::string_view term) const;
 
    void keep_alive();
 
    typedef Xapian::Internal::opt_intrusive_ptr<Xapian::MatchSpy> opt_ptr_spy;
 
    void set_query(const Xapian::Query& query,
                   Xapian::termcount qlen,
                   Xapian::valueno collapse_key,
                   Xapian::doccount collapse_max,
                   Xapian::Enquire::docid_order order,
                   Xapian::valueno sort_key,
                   Xapian::Enquire::Internal::sort_setting sort_by,
                   bool sort_value_forward,
                   double time_limit,
                   int percent_threshold, double weight_threshold,
                   const Xapian::Weight& wtscheme,
                   const Xapian::RSet &omrset,
                   const std::vector<opt_ptr_spy>& matchspies) const;
 
    int get_read_fd() const {
        return link.get_read_fd();
    }
 
    void accumulate_remote_stats(Xapian::Weight::Internal& total) const;
 
    void send_global_stats(Xapian::doccount first,
                           Xapian::doccount maxitems,
                           Xapian::doccount check_at_least,
                           const Xapian::KeyMaker* sorter,
                           const Xapian::Weight::Internal &stats) const;
 
    Xapian::MSet get_mset(const std::vector<opt_ptr_spy>& matchspies) const;
 
    TermList* open_metadata_keylist(std::string_view prefix) const;
 
    TermList * open_term_list(Xapian::docid did) const;
 
    TermList * open_term_list_direct(Xapian::docid did) const;
 
    TermList* open_allterms(std::string_view prefix) const;
 
    bool has_positions() const;
 
    bool reopen();
 
    void close();
 
    PostList* open_post_list(std::string_view term) const;
 
    LeafPostList* open_leaf_post_list(std::string_view term, bool) const;
 
    Xapian::doccount read_post_list(const std::string& term, NetworkPostList & pl) const;
 
    PositionList* open_position_list(Xapian::docid did,
                                     std::string_view tname) const;
 
    Xapian::Document::Internal * open_document(Xapian::docid did, bool lazy) const;
 
    Xapian::doccount get_doccount() const;
 
    Xapian::docid get_lastdocid() const;
 
    Xapian::totallength get_total_length() const;
 
    Xapian::termcount get_doclength(Xapian::docid did) const;
    Xapian::termcount get_unique_terms(Xapian::docid did) const;
    Xapian::termcount get_wdfdocmax(Xapian::docid did) const;
 
    bool term_exists(std::string_view term) const;
 
    void get_freqs(std::string_view term,
                   Xapian::doccount* termfreq_ptr,
                   Xapian::termcount* collfreq_ptr) const;
 
    void read_value_stats(Xapian::valueno slot) const;
    Xapian::doccount get_value_freq(Xapian::valueno slot) const;
    std::string get_value_lower_bound(Xapian::valueno slot) const;
    std::string get_value_upper_bound(Xapian::valueno slot) const;
 
    Xapian::termcount get_doclength_lower_bound() const;
    Xapian::termcount get_doclength_upper_bound() const;
    Xapian::termcount get_wdf_upper_bound(std::string_view term) const;
 
    void commit();
 
    void cancel();
 
    Xapian::docid add_document(const Xapian::Document & doc);
 
    void delete_document(Xapian::docid did);
    void delete_document(std::string_view unique_term);
 
    void replace_document(Xapian::docid did, const Xapian::Document & doc);
    Xapian::docid replace_document(std::string_view unique_term,
                                   const Xapian::Document& document);
 
    std::string get_uuid() const;
 
    std::string get_metadata(std::string_view key) const;
 
    void set_metadata(std::string_view key, std::string_view value);
 
    void request_document(Xapian::docid did) const;
 
    void add_spelling(std::string_view word, Xapian::termcount freqinc) const;
 
    TermList* open_synonym_termlist(std::string_view term) const;
 
    TermList* open_synonym_keylist(std::string_view prefix) const;
 
    void add_synonym(std::string_view word, std::string_view synonym) const;
 
    void remove_synonym(std::string_view word,
                        std::string_view synonym) const;
 
    void clear_synonyms(std::string_view word) const;
 
    Xapian::termcount remove_spelling(std::string_view word,
                                      Xapian::termcount freqdec) const;
 
    int get_backend_info(std::string* path) const {
        if (path) *path = link.get_context();
        return BACKEND_REMOTE;
    }
 
    bool locked() const;
 
    std::string reconstruct_text(Xapian::docid did,
                                 size_t length,
                                 std::string_view prefix,
                                 Xapian::termpos start_pos,
                                 Xapian::termpos end_pos) const;
 
    std::string get_description() const;
};
 
#endif // XAPIAN_INCLUDED_REMOTE_DATABASE_H