inmemory_database.cc

Go to the documentation of this file.

 
/* Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2002-2026 Olly Betts
 * Copyright 2006,2009 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/>.
 */
 
#include <config.h>
 
#include "inmemory_database.h"
 
#include "debuglog.h"
 
#include "backends/contiguousalldocspostlist.h"
#include "clamp_cast.h"
#include "expand/expandweight.h"
#include "inmemory_document.h"
#include "inmemory_alltermslist.h"
#include "str.h"
#include "backends/valuestats.h"
 
#include <algorithm>
#include <string>
#include <string_view>
#include <vector>
#include <map>
 
#include <xapian/error.h>
#include <xapian/valueiterator.h>
 
using namespace std;
using Xapian::Internal::intrusive_ptr;
 
inline void
InMemoryTerm::add_posting(Xapian::docid did,
                          Xapian::termcount wdf,
                          Xapian::termpos position,
                          bool use_position)
{
    InMemoryPosting posting;
    posting.did = did;
 
    // Find the right place in the sorted list.
    vector<InMemoryPosting>::iterator p;
    p = lower_bound(docs.begin(), docs.end(),
                    posting, InMemoryPostingLessThan());
    if (p == docs.end() || InMemoryPostingLessThan()(posting, *p)) {
        // Adding new entry.
        if (use_position) {
            posting.positions.push_back(position);
        }
        posting.wdf = wdf;
        posting.valid = true;
        docs.insert(p, std::move(posting));
    } else if (!p->valid) {
        // Resurrecting deleted entry.
        p->did = did;
        p->positions.clear();
        if (use_position) {
            p->positions.push_back(position);
        }
        p->wdf = wdf;
        p->valid = true;
    } else if (use_position) {
        // Adding position to existing entry.
        p->add_position(position);
    }
}
 
inline void
InMemoryDoc::add_posting(const string& term,
                         Xapian::termcount wdf,
                         Xapian::termpos position,
                         bool use_position)
{
    InMemoryTermEntry termentry;
    termentry.term = term;
 
    // Find the right place in the sorted list.
    vector<InMemoryTermEntry>::iterator p;
    p = lower_bound(terms.begin(), terms.end(),
                    termentry, InMemoryTermEntryLessThan());
    if (p == terms.end() || InMemoryTermEntryLessThan()(termentry, *p)) {
        // Adding new entry.
        if (use_position) {
            termentry.positions.push_back(position);
        }
        termentry.wdf = wdf;
        terms.insert(p, std::move(termentry));
    } else if (use_position) {
        p->add_position(position);
    }
}
 
// Postlist //
 
InMemoryPostList::InMemoryPostList(const InMemoryDatabase* db_,
                                   const InMemoryTerm & imterm,
                                   std::string_view term_)
        : LeafPostList(term_),
          pos(imterm.docs.begin()),
          end(imterm.docs.end()),
          started(false),
          db(db_),
          wdf_upper_bound(0)
{
    termfreq = imterm.term_freq;
    collfreq = imterm.collection_freq;
    while (pos != end && !pos->valid) ++pos;
    if (pos != end) {
        auto first_wdf = (*pos).wdf;
        wdf_upper_bound = max(first_wdf, imterm.collection_freq - first_wdf);
    }
}
 
Xapian::docid
InMemoryPostList::get_docid() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(started);
    Assert(!at_end());
    return (*pos).did;
}
 
PostList *
InMemoryPostList::next(double /*w_min*/)
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    if (started) {
        Assert(!at_end());
        ++pos;
        while (pos != end && !pos->valid) ++pos;
    } else {
        started = true;
    }
    return NULL;
}
 
PostList *
InMemoryPostList::skip_to(Xapian::docid did, double w_min)
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    // FIXME - see if we can make more efficient, perhaps using better
    // data structure.  Note, though, that a binary search of
    // the remaining list may NOT be a good idea (search time is then
    // O(log {length of list}), as opposed to O(distance we want to skip)
    // Since we will frequently only be skipping a short distance, this
    // could well be worse.
 
    // If we've not started, it's OK to call skip_to().
    Assert(!at_end() || !started);
    started = true;
    while (!at_end() && (*pos).did < did) {
        (void) next(w_min);
    }
    return NULL;
}
 
bool
InMemoryPostList::at_end() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return (pos == end);
}
 
void
InMemoryPostList::get_docid_range(Xapian::docid& first,
                                  Xapian::docid& last) const
{
    Assert(!started);
    if (pos != end) {
        first = pos->did;
        last = (end - 1)->did;
    } else {
        last = 0;
    }
}
 
string
InMemoryPostList::get_description() const
{
    return term + ":" + str(termfreq);
}
 
Xapian::termcount
InMemoryPostList::get_wdfdocmax() const
{
   return db->get_wdfdocmax(get_docid());
}
 
PositionList *
InMemoryPostList::read_position_list()
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    mypositions.assign(pos->positions.copy());
    return &mypositions;
}
 
PositionList *
InMemoryPostList::open_position_list() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    if (pos->positions.empty()) return nullptr;
    return new InMemoryPositionList(pos->positions.copy());
}
 
Xapian::termcount
InMemoryPostList::get_wdf() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return (*pos).wdf;
}
 
Xapian::termcount
InMemoryPostList::get_wdf_upper_bound() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return wdf_upper_bound;
}
 
// Termlist //
 
InMemoryTermList::InMemoryTermList(intrusive_ptr<const InMemoryDatabase> db_,
                                   Xapian::docid did_,
                                   const InMemoryDoc & doc,
                                   Xapian::termcount len)
        : pos(doc.terms.begin()), end(doc.terms.end()), terms(doc.terms.size()),
          started(false), db(db_), did(did_), document_length(len)
{
    LOGLINE(DB, "InMemoryTermList::InMemoryTermList(): " <<
                terms << " terms starting from " << pos->term);
}
 
Xapian::termcount
InMemoryTermList::get_wdf() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(started);
    Assert(pos != end);
    return (*pos).wdf;
}
 
Xapian::doccount
InMemoryTermList::get_termfreq() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(started);
    Assert(pos != end);
 
    Xapian::doccount tf;
    db->get_freqs((*pos).term, &tf, NULL);
    return tf;
}
 
Xapian::termcount
InMemoryTermList::get_approx_size() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return terms;
}
 
void
InMemoryTermList::accumulate_stats(Xapian::Internal::ExpandStats & stats) const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(started);
    Assert(pos != end);
    stats.accumulate(shard_index,
                     InMemoryTermList::get_wdf(), document_length,
                     InMemoryTermList::get_termfreq(),
                     db->get_doccount());
}
 
TermList *
InMemoryTermList::next()
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    if (started) {
        Assert(pos != end);
        ++pos;
    } else {
        started = true;
    }
    if (pos == end)
        return this;
    current_term = pos->term;
    return NULL;
}
 
TermList*
InMemoryTermList::skip_to(string_view term)
{
    if (rare(db->is_closed()))
        InMemoryDatabase::throw_database_closed();
 
    while (pos != end && pos->term < term) {
        ++pos;
    }
 
    started = true;
    if (pos == end)
        return this;
    current_term = pos->term;
    return NULL;
}
 
Xapian::termcount
InMemoryTermList::positionlist_count() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return db->positionlist_count(did, (*pos).term);
}
 
PositionList*
InMemoryTermList::positionlist_begin() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return db->open_position_list(did, (*pos).term);
}
 
// InMemoryAllDocsPostList //
 
InMemoryAllDocsPostList::InMemoryAllDocsPostList(const InMemoryDatabase* db_)
        : LeafPostList({}), did(0), db(db_)
{
    collfreq = termfreq = db->totdocs;
}
 
Xapian::docid
InMemoryAllDocsPostList::get_docid() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(did > 0);
    Assert(did <= db->termlists.size());
    Assert(db->termlists[did - 1].is_valid);
    return did;
}
 
Xapian::termcount
InMemoryAllDocsPostList::get_wdf() const
{
    return 1;
}
 
PositionList *
InMemoryAllDocsPostList::read_position_list()
{
    throw Xapian::UnimplementedError("Can't open position list for all docs iterator");
}
 
PositionList *
InMemoryAllDocsPostList::open_position_list() const
{
    throw Xapian::UnimplementedError("Can't open position list for all docs iterator");
}
 
PostList *
InMemoryAllDocsPostList::next(double /*w_min*/)
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(!at_end());
    do {
        ++did;
    } while (did <= db->termlists.size() && !db->termlists[did - 1].is_valid);
    return NULL;
}
 
PostList *
InMemoryAllDocsPostList::skip_to(Xapian::docid did_, double /*w_min*/)
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    Assert(!at_end());
    if (did <= did_) {
        did = did_;
        while (did <= db->termlists.size() && !db->termlists[did - 1].is_valid) {
            ++did;
        }
    }
    return NULL;
}
 
bool
InMemoryAllDocsPostList::at_end() const
{
    if (db->is_closed()) InMemoryDatabase::throw_database_closed();
    return (did > db->termlists.size());
}
 
Xapian::termcount
InMemoryAllDocsPostList::get_wdf_upper_bound() const
{
    return 1;
}
 
string
InMemoryAllDocsPostList::get_description() const
{
    return "InMemoryAllDocsPostList " + str(did);
}
 
// Actual database class //
 
// Updates are applied immediately so we can't support transactions.
InMemoryDatabase::InMemoryDatabase()
    : Xapian::Database::Internal(TRANSACTION_UNIMPLEMENTED),
      totdocs(0), totlen(0), positions_present(false), closed(false)
{
    // We keep an empty entry in postlists for convenience of implementing
    // allterms iteration.
    postlists.insert(make_pair(string(), InMemoryTerm()));
}
 
InMemoryDatabase::~InMemoryDatabase()
{
    dtor_called();
}
 
bool
InMemoryDatabase::reopen()
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return false;
}
 
void
InMemoryDatabase::close()
{
    // Free all the resources, and mark the db as closed.
    postlists.clear();
    termlists.clear();
    doclists.clear();
    valuelists.clear();
    valuestats.clear();
    doclengths.clear();
    metadata.clear();
    closed = true;
}
 
PostList*
InMemoryDatabase::open_post_list(string_view term) const
{
    return InMemoryDatabase::open_leaf_post_list(term, false);
}
 
LeafPostList*
InMemoryDatabase::open_leaf_post_list(string_view term,
                                      bool need_read_pos) const
{
    (void)need_read_pos;
    if (closed) InMemoryDatabase::throw_database_closed();
    if (term.empty()) {
        Assert(!need_read_pos);
        Xapian::doccount doccount = totdocs;
        if (rare(doccount == 0)) {
            return nullptr;
        }
        if (doccount == termlists.size()) {
            // The used docid range is exactly 1 to doccount inclusive.
            return new ContiguousAllDocsPostList(doccount);
        }
        return new InMemoryAllDocsPostList(this);
    }
    auto i = postlists.find(term);
    if (i == postlists.end() || i->second.term_freq == 0) {
        return nullptr;
    }
    return new InMemoryPostList(this, i->second, term);
}
 
bool
InMemoryDatabase::doc_exists(Xapian::docid did) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return (did > 0 && did <= termlists.size() && termlists[did - 1].is_valid);
}
 
void
InMemoryDatabase::get_freqs(string_view term,
                            Xapian::doccount* termfreq_ptr,
                            Xapian::termcount* collfreq_ptr) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    auto i = postlists.find(term);
    if (i != postlists.end()) {
        if (termfreq_ptr)
            *termfreq_ptr = i->second.term_freq;
        if (collfreq_ptr)
            *collfreq_ptr = i->second.collection_freq;
    } else {
        if (termfreq_ptr)
            *termfreq_ptr = 0;
        if (collfreq_ptr)
            *collfreq_ptr = 0;
    }
}
 
Xapian::doccount
InMemoryDatabase::get_value_freq(Xapian::valueno slot) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    auto i = valuestats.find(slot);
    if (i == valuestats.end()) return 0;
    return i->second.freq;
}
 
std::string
InMemoryDatabase::get_value_lower_bound(Xapian::valueno slot) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    auto i = valuestats.find(slot);
    if (i == valuestats.end()) return string();
    return i->second.lower_bound;
}
 
std::string
InMemoryDatabase::get_value_upper_bound(Xapian::valueno slot) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    auto i = valuestats.find(slot);
    if (i == valuestats.end()) return string();
    return i->second.upper_bound;
}
 
Xapian::termcount
InMemoryDatabase::get_doclength_lower_bound() const
{
    // A zero-length document can't contain any terms, so we ignore such
    // documents for the purposes of this lower bound.
    return 1;
}
 
Xapian::termcount
InMemoryDatabase::get_doclength_upper_bound() const
{
    // Not a very tight bound in general, but InMemory isn't really built for
    // performance.
    return clamp_cast<Xapian::termcount>(get_total_length());
}
 
Xapian::termcount
InMemoryDatabase::get_wdf_upper_bound(string_view term) const
{
    // Not a very tight bound in general, but InMemory isn't really built for
    // performance.
    Xapian::termcount cf;
    get_freqs(term, NULL, &cf);
    return cf;
}
 
Xapian::doccount
InMemoryDatabase::get_doccount() const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return totdocs;
}
 
Xapian::docid
InMemoryDatabase::get_lastdocid() const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return Xapian::docid(termlists.size());
}
 
Xapian::totallength
InMemoryDatabase::get_total_length() const
{
    return totlen;
}
 
Xapian::termcount
InMemoryDatabase::get_doclength(Xapian::docid did) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (!doc_exists(did)) {
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    }
    return doclengths[did - 1];
}
 
Xapian::termcount
InMemoryDatabase::get_unique_terms(Xapian::docid did) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (did == 0 || did > termlists.size() || !termlists[did - 1].is_valid)
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    // get_unique_terms() really ought to only count terms with wdf > 0, but
    // that's expensive to calculate on demand, so for now let's just ensure
    // unique_terms <= doclen.
    Xapian::termcount terms = termlists[did - 1].terms.size();
    return std::min(terms, Xapian::termcount(doclengths[did - 1]));
}
 
Xapian::termcount
InMemoryDatabase::get_wdfdocmax(Xapian::docid did) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (did == 0 || did > termlists.size() || !termlists[did - 1].is_valid)
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    Xapian::termcount max_wdf = 0;
    for (auto&& i : termlists[did - 1].terms) {
        if (i.wdf > max_wdf) max_wdf = i.wdf;
    }
    return max_wdf;
}
 
TermList *
InMemoryDatabase::open_term_list(Xapian::docid did) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    Assert(did != 0);
    if (!doc_exists(did)) {
        // FIXME: the docid in this message will be local, not global
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    }
    return new InMemoryTermList(intrusive_ptr<const InMemoryDatabase>(this), did,
                                termlists[did - 1], doclengths[did - 1]);
}
 
TermList *
InMemoryDatabase::open_term_list_direct(Xapian::docid did) const
{
    return InMemoryDatabase::open_term_list(did);
}
 
Xapian::Document::Internal *
InMemoryDatabase::open_document(Xapian::docid did, bool lazy) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    Assert(did != 0);
    if (!lazy && !doc_exists(did)) {
        // FIXME: the docid in this message will be local, not global
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    }
    return new InMemoryDocument(this, did);
}
 
std::string
InMemoryDatabase::get_metadata(std::string_view key) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    auto i = metadata.find(key);
    if (i == metadata.end())
        return string();
    return i->second;
}
 
TermList *
InMemoryDatabase::open_metadata_keylist(string_view) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (metadata.empty()) return NULL;
    // FIXME: nobody implemented this yet...
    throw Xapian::UnimplementedError("InMemory backend doesn't currently implement Database::metadata_keys_begin()");
}
 
void
InMemoryDatabase::set_metadata(std::string_view key,
                               std::string_view value)
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (!value.empty()) {
#ifdef __cpp_lib_associative_heterogeneous_insertion // C++26
        metadata.insert_or_assign(key, value);
#else
        metadata.insert_or_assign(string(key), value);
#endif
    } else {
#ifdef __cpp_lib_associative_heterogeneous_erasure // C++23
        metadata.erase(key);
#else
        metadata.erase(string(key));
#endif
    }
}
 
Xapian::termcount
InMemoryDatabase::positionlist_count(Xapian::docid did,
                                     string_view term) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (!doc_exists(did)) {
        return 0;
    }
    const InMemoryDoc &doc = termlists[did - 1];
 
    InMemoryTermEntry temp;
    temp.term = term;
    auto t = lower_bound(doc.terms.begin(), doc.terms.end(),
                         temp, InMemoryTermEntryLessThan());
    if (t != doc.terms.end() && t->term == term) {
        return clamp_cast<Xapian::termcount>(t->positions.size());
    }
    return 0;
}
 
PositionList*
InMemoryDatabase::open_position_list(Xapian::docid did,
                                     string_view term) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (usual(doc_exists(did))) {
        const InMemoryDoc &doc = termlists[did - 1];
 
        InMemoryTermEntry temp;
        temp.term = term;
        auto t = lower_bound(doc.terms.begin(), doc.terms.end(),
                             temp, InMemoryTermEntryLessThan());
        if (t != doc.terms.end() && t->term == term) {
            return new InMemoryPositionList(t->positions);
        }
    }
    return nullptr;
}
 
void
InMemoryDatabase::add_values(Xapian::docid did,
                             const map<Xapian::valueno, string> &values_)
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (did > valuelists.size()) {
        valuelists.resize(did);
    }
    valuelists[did - 1] = values_;
 
    // Update the statistics.
    for (auto&& j : values_) {
        auto i = valuestats.insert(make_pair(j.first, ValueStats()));
 
        // Now, modify the stored statistics.
        if ((i.first->second.freq)++ == 0) {
            // If the value count was previously zero, set the upper and lower
            // bounds to the newly added value.
            i.first->second.lower_bound = j.second;
            i.first->second.upper_bound = j.second;
        } else {
            // Otherwise, simply make sure they reflect the new value.
            if (j.second < i.first->second.lower_bound) {
                i.first->second.lower_bound = j.second;
            }
            if (j.second > i.first->second.upper_bound) {
                i.first->second.upper_bound = j.second;
            }
        }
    }
}
 
// We implicitly commit each modification right away, so nothing to do here.
void
InMemoryDatabase::commit()
{
}
 
// We implicitly commit each modification right away, so nothing to do here.
void
InMemoryDatabase::cancel()
{
}
 
void
InMemoryDatabase::delete_document(Xapian::docid did)
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (!doc_exists(did)) {
        throw Xapian::DocNotFoundError(string("Docid ") + str(did) +
                                 string(" not found"));
    }
    termlists[did - 1].is_valid = false;
    doclists[did - 1] = string();
    for (auto&& j : valuelists[did - 1]) {
        auto i = valuestats.find(j.first);
        if (--(i->second.freq) == 0) {
            i->second.lower_bound.resize(0);
            i->second.upper_bound.resize(0);
        }
    }
    valuelists[did - 1].clear();
 
    totlen -= doclengths[did - 1];
    doclengths[did - 1] = 0;
    totdocs--;
    // A crude check, but it's hard to be more precise with the current
    // InMemory structure without being very inefficient.
    if (totdocs == 0) positions_present = false;
 
    for (auto&& i : termlists[did - 1].terms) {
        auto t = postlists.find(i.term);
        Assert(t != postlists.end());
        t->second.collection_freq -= i.wdf;
        --t->second.term_freq;
 
        // Just invalidate erased doc ids - otherwise we need to erase
        // in a vector (inefficient) and we break any posting lists
        // iterating over this posting list.
        InMemoryPosting temp;
        temp.did = did;
        auto p = lower_bound(t->second.docs.begin(), t->second.docs.end(),
                             temp, InMemoryPostingLessThan());
        if (p != t->second.docs.end() && p->did == did) {
            p->valid = false;
        }
    }
    termlists[did - 1].terms.clear();
}
 
void
InMemoryDatabase::replace_document(Xapian::docid did,
                                   const Xapian::Document & document)
{
    LOGCALL_VOID(DB, "InMemoryDatabase::replace_document", did | document);
 
    if (closed) InMemoryDatabase::throw_database_closed();
 
    if (doc_exists(did)) {
        for (auto&& j : valuelists[did - 1]) {
            auto i = valuestats.find(j.first);
            if (--(i->second.freq) == 0) {
                i->second.lower_bound.resize(0);
                i->second.upper_bound.resize(0);
            }
        }
 
        totlen -= doclengths[did - 1];
        totdocs--;
    } else if (did > termlists.size()) {
        termlists.resize(did);
        termlists[did - 1].is_valid = true;
        doclengths.resize(did);
        doclists.resize(did);
        valuelists.resize(did);
    } else {
        termlists[did - 1].is_valid = true;
    }
 
    for (auto&& i : termlists[did - 1].terms) {
        auto t = postlists.find(i.term);
        Assert(t != postlists.end());
        t->second.collection_freq -= i.wdf;
        --t->second.term_freq;
 
        // Just invalidate erased doc ids - otherwise we need to erase
        // in a vector (inefficient) and we break any posting lists
        // iterating over this posting list.
        InMemoryPosting temp;
        temp.did = did;
        auto p = lower_bound(t->second.docs.begin(), t->second.docs.end(),
                             temp, InMemoryPostingLessThan());
        if (p != t->second.docs.end() && p->did == did) {
            p->valid = false;
        }
    }
 
    doclengths[did - 1] = 0;
    doclists[did - 1] = document.get_data();
 
    finish_add_doc(did, document);
}
 
Xapian::docid
InMemoryDatabase::add_document(const Xapian::Document & document)
{
    LOGCALL(DB, Xapian::docid, "InMemoryDatabase::add_document", document);
    if (closed) InMemoryDatabase::throw_database_closed();
 
    Xapian::docid did = make_doc(document.get_data());
 
    finish_add_doc(did, document);
 
    RETURN(did);
}
 
void
InMemoryDatabase::finish_add_doc(Xapian::docid did, const Xapian::Document &document)
{
    {
        map<Xapian::valueno, string> values;
        Xapian::ValueIterator k = document.values_begin();
        for ( ; k != document.values_end(); ++k) {
            values.insert(make_pair(k.get_valueno(), *k));
            LOGLINE(DB, "InMemoryDatabase::finish_add_doc(): adding value " <<
                        k.get_valueno() << " -> " << *k);
        }
        add_values(did, values);
    }
 
    InMemoryDoc doc(true);
    Xapian::TermIterator i = document.termlist_begin();
    for ( ; i != document.termlist_end(); ++i) {
        make_term(*i);
 
        LOGLINE(DB, "InMemoryDatabase::finish_add_doc(): adding term " << *i);
        Xapian::PositionIterator j = i.positionlist_begin();
        if (j == i.positionlist_end()) {
            /* Make sure the posting exists, even without a position. */
            make_posting(&doc, *i, did, 0, i.get_wdf(), false);
        } else {
            positions_present = true;
            for ( ; j != i.positionlist_end(); ++j) {
                make_posting(&doc, *i, did, *j, i.get_wdf());
            }
        }
 
        Assert(did > 0 && did <= doclengths.size());
        doclengths[did - 1] += i.get_wdf();
        totlen += i.get_wdf();
        postlists[*i].collection_freq += i.get_wdf();
        ++postlists[*i].term_freq;
    }
    swap(termlists[did - 1], doc);
 
    totdocs++;
}
 
void
InMemoryDatabase::make_term(const string& term)
{
    postlists[term];  // Initialise, if not already there.
}
 
Xapian::docid
InMemoryDatabase::make_doc(const string & docdata)
{
    if (rare(termlists.size() == Xapian::docid(-1))) {
        // Really unlikely to actually happen for inmemory.
        throw Xapian::DatabaseError("Run out of docids");
    }
    termlists.push_back(InMemoryDoc(true));
    doclengths.push_back(0);
    doclists.push_back(docdata);
 
    AssertEqParanoid(termlists.size(), doclengths.size());
 
    return Xapian::docid(termlists.size());
}
 
void InMemoryDatabase::make_posting(InMemoryDoc * doc,
                                    const string& term,
                                    Xapian::docid did,
                                    Xapian::termpos position,
                                    Xapian::termcount wdf,
                                    bool use_position)
{
    Assert(doc);
    Assert(postlists.find(term) != postlists.end());
    Assert(did > 0 && did <= termlists.size());
    Assert(did > 0 && did <= doclengths.size());
    Assert(doc_exists(did));
 
    postlists[term].add_posting(did, wdf, position, use_position);
    doc->add_posting(term, wdf, position, use_position);
}
 
bool
InMemoryDatabase::term_exists(string_view term) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    if (term.empty()) {
        return totdocs != 0;
    }
    auto i = postlists.find(term);
    if (i == postlists.end()) return false;
    return (i->second.term_freq != 0);
}
 
bool
InMemoryDatabase::has_positions() const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return positions_present;
}
 
TermList*
InMemoryDatabase::open_allterms(string_view prefix) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    return new InMemoryAllTermsList(&postlists,
                                    intrusive_ptr<const InMemoryDatabase>(this),
                                    prefix);
}
 
void
InMemoryDatabase::get_used_docid_range(Xapian::docid& first,
                                       Xapian::docid& last) const
{
    if (closed) InMemoryDatabase::throw_database_closed();
    first = 1;
    last = Xapian::docid(termlists.size());
    if (last == 0 || last == totdocs) {
        // Empty database or contiguous range starting at 1.
        return;
    }
    while (!termlists[first - 1].is_valid) ++first;
    while (!termlists[last - 1].is_valid) --last;
}
 
Xapian::Database::Internal*
InMemoryDatabase::update_lock(int /*flags*/)
{
    // InMemoryDatabase doesn't really distinguish writable and read-only.
    return this;
}
 
void
InMemoryDatabase::throw_database_closed()
{
    throw Xapian::DatabaseClosedError("Database has been closed");
}
 
string
InMemoryDatabase::get_description() const
{
    return "InMemory";
}
 
#ifdef DISABLE_GPL_LIBXAPIAN
# error GPL source we cannot relicense included in libxapian
#endif