backends/brass/brass_database.h

Go to the documentation of this file.

/* brass_database.h: C++ class definition for brass database
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2003,2004,2005,2006,2007,2008,2009,2010,2012 Olly Betts
 * Copyright 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

#ifndef OM_HGUARD_BRASS_DATABASE_H
#define OM_HGUARD_BRASS_DATABASE_H

#include "database.h"
#include "brass_dbstats.h"
#include "brass_inverter.h"
#include "brass_positionlist.h"
#include "brass_postlist.h"
#include "brass_record.h"
#include "brass_spelling.h"
#include "brass_synonym.h"
#include "brass_termlisttable.h"
#include "brass_values.h"
#include "brass_version.h"
#include "../flint_lock.h"
#include "brass_types.h"
#include "valuestats.h"

#include "noreturn.h"

#include <map>

class BrassTermList;
class BrassAllDocsPostList;
class RemoteConnection;

class BrassDatabase : public Xapian::Database::Internal {
    friend class BrassWritableDatabase;
    friend class BrassTermList;
    friend class BrassPostList;
    friend class BrassAllTermsList;
    friend class BrassAllDocsPostList;
    private:
        std::string db_dir;

        bool readonly;

        BrassVersion version_file;

        mutable BrassPostListTable postlist_table;

        BrassPositionListTable position_table;

        BrassTermListTable termlist_table;

        mutable BrassValueManager value_manager;

        mutable BrassSynonymTable synonym_table;

        mutable BrassSpellingTable spelling_table;

        BrassRecordTable record_table;

        FlintLock lock;

        unsigned int max_changesets;

        BrassDatabaseStats stats;

        bool database_exists();

        void create_and_open_tables(unsigned int blocksize);

        void open_tables_consistent();

        void get_database_write_lock(bool creating);

        void open_tables(brass_revision_number_t revision);

        brass_revision_number_t get_revision_number() const;

        brass_revision_number_t get_next_revision_number() const;

        void set_revision_number(brass_revision_number_t new_revision);

        void reopen();

        void close();

        void modifications_failed(brass_revision_number_t old_revision,
                                  brass_revision_number_t new_revision,
                                  const std::string & msg);

        void apply();

        void cancel();

        void send_whole_database(RemoteConnection & conn, double end_time);

        void get_changeset_revisions(const string & path,
                                     brass_revision_number_t * startrev,
                                     brass_revision_number_t * endrev) const;

    public:
        BrassDatabase(const string &db_dir_, int action = XAPIAN_DB_READONLY,
                       unsigned int block_size = 0u);

        ~BrassDatabase();

        BrassCursor * get_postlist_cursor() const {
            return postlist_table.cursor_get();
        }

        Xapian::doccount  get_doccount() const;
        Xapian::docid get_lastdocid() const;
        totlen_t get_total_length() const;
        Xapian::doclength get_avlength() const;
        Xapian::termcount get_doclength(Xapian::docid did) const;
        Xapian::doccount get_termfreq(const string & tname) const;
        Xapian::termcount get_collection_freq(const string & tname) 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(const string & term) const;
        bool term_exists(const string & tname) const;
        bool has_positions() const;

        LeafPostList * open_post_list(const string & tname) const;
        ValueList * open_value_list(Xapian::valueno slot) const;
        Xapian::Document::Internal * open_document(Xapian::docid did, bool lazy) const;

        PositionList * open_position_list(Xapian::docid did, const string & term) const;
        TermList * open_term_list(Xapian::docid did) const;
        TermList * open_allterms(const string & prefix) const;

        TermList * open_spelling_termlist(const string & word) const;
        TermList * open_spelling_wordlist() const;
        Xapian::doccount get_spelling_frequency(const string & word) const;

        TermList * open_synonym_termlist(const string & term) const;
        TermList * open_synonym_keylist(const string & prefix) const;

        string get_metadata(const string & key) const;
        TermList * open_metadata_keylist(const std::string &prefix) const;
        void write_changesets_to_fd(int fd,
                                    const string & start_revision,
                                    bool need_whole_db,
                                    Xapian::ReplicationInfo * info);
        string get_revision_info() const;
        string get_uuid() const;

        XAPIAN_NORETURN(void throw_termlist_table_close_exception() const);
};

class BrassWritableDatabase : public BrassDatabase {
        mutable Inverter inverter;

        mutable map<Xapian::valueno, ValueStats> value_stats;

        mutable Xapian::doccount change_count;

        Xapian::doccount flush_threshold;

        mutable Xapian::Document::Internal * modify_shortcut_document;

        mutable Xapian::docid modify_shortcut_docid;

        void flush_postlist_changes() const;

        void close();

        void apply();


        void commit();

        void cancel();

        Xapian::docid add_document(const Xapian::Document & document);
        Xapian::docid add_document_(Xapian::docid did, const Xapian::Document & document);
        // Stop the default implementation of delete_document(term) and
        // replace_document(term) from being hidden.  This isn't really
        // a problem as we only try to call them through the base class
        // (where they aren't hidden) but some compilers generate a warning
        // about the hiding.
#ifndef _MSC_VER
        using Xapian::Database::Internal::delete_document;
        using Xapian::Database::Internal::replace_document;
#endif
        void delete_document(Xapian::docid did);
        void replace_document(Xapian::docid did, const Xapian::Document & document);

        Xapian::Document::Internal * open_document(Xapian::docid did,
                                                   bool lazy) const;


    public:
        BrassWritableDatabase(const string &dir, int action, int block_size);

        ~BrassWritableDatabase();

        Xapian::termcount get_doclength(Xapian::docid did) const;
        Xapian::doccount get_termfreq(const string & tname) const;
        Xapian::termcount get_collection_freq(const string & tname) 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;
        bool term_exists(const string & tname) const;

        LeafPostList * open_post_list(const string & tname) const;
        ValueList * open_value_list(Xapian::valueno slot) const;
        TermList * open_allterms(const string & prefix) const;

        void add_spelling(const string & word, Xapian::termcount freqinc) const;
        void remove_spelling(const string & word, Xapian::termcount freqdec) const;
        TermList * open_spelling_wordlist() const;

        TermList * open_synonym_keylist(const string & prefix) const;
        void add_synonym(const string & word, const string & synonym) const;
        void remove_synonym(const string & word, const string & synonym) const;
        void clear_synonyms(const string & word) const;

        void set_metadata(const string & key, const string & value);
        void invalidate_doc_object(Xapian::Document::Internal * obj) const;
};

#endif /* OM_HGUARD_BRASS_DATABASE_H */

---