backends/quartz/quartz_database.h

Go to the documentation of this file.

/* quartz_database.h: C++ class definition for quartz database
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002,2003,2004,2006,2007 Olly Betts
 *
 * 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_QUARTZ_DATABASE_H
#define OM_HGUARD_QUARTZ_DATABASE_H

#include <xapian/visibility.h>

#include "database.h"
#include "quartz_log.h"
#include "quartz_metafile.h"
#include "quartz_positionlist.h"
#include "quartz_postlist.h"
#include "quartz_record.h"
#include "quartz_termlist.h"
#include "quartz_values.h"

class QuartzTermList;

#include "quartz_types.h"

#include <map>

const int OM_DB_READONLY = 0;

class XAPIAN_VISIBILITY_DEFAULT QuartzDatabase : public Xapian::Database::Internal {
    friend class QuartzWritableDatabase;
    friend class QuartzTermList;
    private:
        std::string db_dir;

        bool readonly;

        QuartzMetaFile metafile;

        QuartzPostListTable postlist_table;

        QuartzPositionListTable positionlist_table;

        QuartzTermListTable termlist_table;

        QuartzValueTable value_table;

        QuartzRecordTable record_table;

        QuartzLog log;

        bool database_exists();

        void create_and_open_tables(unsigned int blocksize);

        void open_tables_consistent();

        void get_database_write_lock();

        void release_database_write_lock();

        void open_tables(quartz_revision_number_t revision);

        quartz_revision_number_t get_revision_number() const;

        quartz_revision_number_t get_next_revision_number() const;

        void set_revision_number(quartz_revision_number_t new_revision);
        
        virtual void reopen();

        void apply();

        void cancel();

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

        ~QuartzDatabase();

        Xapian::doccount  get_doccount() const;
        Xapian::docid get_lastdocid() const;
        Xapian::doclength get_avlength() const;
        Xapian::doclength get_doclength(Xapian::docid did) const;
        Xapian::doccount get_termfreq(const string & tname) const;
        Xapian::termcount get_collection_freq(const string & tname) const;
        bool term_exists(const string & tname) const;
        bool has_positions() const;

        LeafPostList * open_post_list(const string & tname) const;
        TermList * open_term_list(Xapian::docid did) const;
        Xapian::Document::Internal * open_document(Xapian::docid did, bool lazy = false) const;
        PositionList * open_position_list(Xapian::docid did,
                                          const string & tname) const;
        TermList * open_allterms(const string & prefix) const;
};

class XAPIAN_VISIBILITY_DEFAULT QuartzWritableDatabase : public Xapian::Database::Internal {
    private:
        mutable map<string, pair<Xapian::termcount_diff, Xapian::termcount_diff> >
                freq_deltas;

        mutable map<Xapian::docid, Xapian::termcount> doclens;

        mutable map<string, map<Xapian::docid,
                                pair<char, Xapian::termcount> > > mod_plists;

        mutable QuartzDatabase database_ro;

        mutable quartz_totlen_t total_length;

        mutable Xapian::docid lastdocid;

        mutable Xapian::doccount changes_made;

        static size_t flush_threshold;


        void flush();

        void do_flush_const() const;

        void cancel();

        virtual 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.
#if (!defined __GNUC__ && !defined _MSC_VER) || __GNUC__ > 2
        using Xapian::Database::Internal::delete_document;
        using Xapian::Database::Internal::replace_document;
#endif
        virtual void delete_document(Xapian::docid did);
        virtual void replace_document(Xapian::docid did,
                                      const Xapian::Document & document);

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

        ~QuartzWritableDatabase();

        Xapian::doccount  get_doccount() const;
        Xapian::docid get_lastdocid() const;
        Xapian::doclength get_avlength() const;
        Xapian::doclength get_doclength(Xapian::docid did) const;
        Xapian::doccount get_termfreq(const string & tname) const;
        Xapian::termcount get_collection_freq(const string & tname) const;
        bool term_exists(const string & tname) const;
        bool has_positions() const;

        LeafPostList * open_post_list(const string & tname) const;
        TermList * open_term_list(Xapian::docid did) const;
        Xapian::Document::Internal * open_document(Xapian::docid did, bool lazy = false) const;
        PositionList * open_position_list(Xapian::docid did,
                                          const string & tname) const;
        TermList * open_allterms(const string & prefix) const;
};

#endif /* OM_HGUARD_QUARTZ_DATABASE_H */

---