honey_database.h

Go to the documentation of this file.

 
/* Copyright 2004,2006,2007,2008,2009,2011,2014,2015,2016,2017,2024 Olly Betts
 * Copyright 2007,2008 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_HONEY_DATABASE_H
#define XAPIAN_INCLUDED_HONEY_DATABASE_H
 
#include "backends/databaseinternal.h"
 
#include "honey_alldocspostlist.h"
#include "honey_docdata.h"
#include "honey_postlisttable.h"
#include "honey_positionlist.h"
#include "honey_spelling.h"
#include "honey_synonym.h"
#include "honey_termlisttable.h"
#include "honey_values.h"
#include "honey_version.h"
#include "xapian/compactor.h"
 
#include <string_view>
 
class HoneyAllTermsList;
class HoneyCursor;
class HoneyPostList;
class HoneySynonymTermList;
class HoneySpellingWordsList;
class HoneyTermList;
 
class HoneyDatabase : public Xapian::Database::Internal {
    friend class HoneyAllTermsList;
    friend class HoneyPosPostList;
    friend class HoneyPostList;
    friend class HoneySpellingWordsList;
    friend class HoneySynonymTermList;
    friend class HoneyTermList;
 
    HoneyDatabase& operator=(const HoneyDatabase&) = delete;
 
    HoneyDatabase(const HoneyDatabase&) = delete;
 
    std::string path;
 
    HoneyVersion version_file;
 
    HoneyDocDataTable docdata_table;
 
    HoneyPostListTable postlist_table;
 
    HoneyPositionTable position_table;
 
    mutable HoneySpellingTable spelling_table;
 
    HoneySynonymTable synonym_table;
 
    HoneyTermListTable termlist_table;
 
    HoneyValueManager value_manager;
 
    mutable Honey::DocLenChunkReader doclen_chunk_reader;
 
    mutable HoneyCursor* doclen_cursor = NULL;
 
    [[noreturn]]
    void throw_termlist_table_close_exception() const;
 
  public:
    explicit
    HoneyDatabase(std::string_view path_, int flags = Xapian::DB_READONLY_);
 
    explicit
    HoneyDatabase(int fd, int flags = Xapian::DB_READONLY_);
 
    ~HoneyDatabase();
 
    void readahead_for_query(const Xapian::Query& query) 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;
 
    // Return the max_wdf in the document
    Xapian::termcount get_wdfdocmax(Xapian::docid did) const;
 
    void get_freqs(std::string_view term,
                   Xapian::doccount* termfreq_ptr,
                   Xapian::termcount* collfreq_ptr) 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;
 
    Xapian::termcount get_unique_terms_lower_bound() const;
 
    Xapian::termcount get_unique_terms_upper_bound() const;
 
    bool term_exists(std::string_view term) const;
 
    bool has_positions() const;
 
    PostList* open_post_list(std::string_view term) const;
 
    LeafPostList* open_leaf_post_list(std::string_view term,
                                      bool need_read_pos) const;
 
    ValueList* open_value_list(Xapian::valueno slot) 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;
 
    PositionList* open_position_list(Xapian::docid did,
                                     std::string_view term) const;
 
    Xapian::Document::Internal* open_document(Xapian::docid did,
                                              bool lazy) const;
 
    TermList* open_spelling_termlist(std::string_view word) const;
 
    TermList* open_spelling_wordlist() const;
 
    Xapian::doccount get_spelling_frequency(std::string_view word) const;
 
    void add_spelling(std::string_view word,
                      Xapian::termcount freqinc) const;
 
    Xapian::termcount remove_spelling(std::string_view word,
                                      Xapian::termcount freqdec) 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 term,
                     std::string_view synonym) const;
 
    void remove_synonym(std::string_view term,
                        std::string_view synonym) const;
 
    void clear_synonyms(std::string_view term) const;
 
    std::string get_metadata(std::string_view key) const;
 
    TermList* open_metadata_keylist(std::string_view prefix) const;
 
    void set_metadata(std::string_view key, std::string_view value);
 
    bool reopen();
 
    void close();
 
    void request_document(Xapian::docid did) const;
 
    Xapian::rev get_revision() const;
 
    std::string get_uuid() const;
 
    int get_backend_info(std::string* path) const;
 
    void get_used_docid_range(Xapian::docid& first, Xapian::docid& last) const;
 
    static
    void compact(Xapian::Compactor* compactor,
                 const char* destdir,
                 int fd,
                 int source_backend,
                 const std::vector<const Xapian::Database::Internal*>& sources,
                 const std::vector<Xapian::docid>& offset,
                 Xapian::Compactor::compaction_level compaction,
                 unsigned flags,
                 Xapian::docid last_docid);
 
    bool has_uncommitted_changes() const {
        return false;
    }
 
    bool single_file() const {
        return false;
    }
 
    HoneyCursor* get_postlist_cursor() const {
        return postlist_table.cursor_get();
    }
 
    std::string get_description() const;
};
 
#endif // XAPIAN_INCLUDED_HONEY_DATABASE_H