A database held entirely in memory. More...

#include <inmemory_database.h>

Inheritance diagram for InMemoryDatabase:

Collaboration diagram for InMemoryDatabase:

Public Member Functions
	InMemoryDatabase ()
	Create and open an in-memory database. More...

	~InMemoryDatabase ()

bool	reopen ()
	Reopen the database to the latest available revision. More...

void	close ()
	Close the database. More...

bool	is_closed () const

Xapian::doccount	get_doccount () const
	Return the number of docs in this (sub) database. More...

Xapian::docid	get_lastdocid () const
	Return the last used document id of this (sub) database. More...

Xapian::totallength	get_total_length () const
	Return the total length of all documents in this database. More...

Xapian::termcount	get_doclength (Xapian::docid did) const
	Get the length of a given document. More...

Xapian::termcount	get_unique_terms (Xapian::docid did) const
	Get the number of unique term in document. More...

void	get_freqs (const string &term, Xapian::doccount termfreq_ptr, Xapian::termcount collfreq_ptr) const
	Returns frequencies for a term. More...

Xapian::doccount	get_value_freq (Xapian::valueno slot) const
	Return the frequency of a given value slot. More...

std::string	get_value_lower_bound (Xapian::valueno slot) const
	Get a lower bound on the values stored in the given value slot. More...

std::string	get_value_upper_bound (Xapian::valueno slot) const
	Get an upper bound on the values stored in the given value slot. More...

bool	term_exists (const string &tname) const
	Check whether a given term is in the database. More...

bool	has_positions () const
	Check whether this database contains any positional information. More...

LeafPostList *	open_post_list (const string &tname) const
	Open a posting list. More...

TermList *	open_term_list (Xapian::docid did) const
	Open a term list. More...

Xapian::Document::Internal *	open_document (Xapian::docid did, bool lazy) const
	Open a document. More...

std::string	get_metadata (const std::string &key) const
	Get the metadata associated with a given key. More...

TermList *	open_metadata_keylist (const std::string &prefix) const
	Open a termlist returning each metadata key. More...

void	set_metadata (const std::string &key, const std::string &value)
	Set the metadata associated with a given key. More...

Xapian::termcount	positionlist_count (Xapian::docid did, const string &tname) const

PositionList *	open_position_list (Xapian::docid did, const string &tname) const
	Open a position list for the given term in the given document. More...

TermList *	open_allterms (const string &prefix) const
	Open an allterms list. More...

int	get_backend_info (string *path) const
	Get backend information about this database. More...

bool	locked () const
	Return true if the database is open for writing. More...

Public Member Functions inherited from Xapian::Database::Internal
virtual	~Internal ()
	Destroy the database. More...

virtual void	keep_alive ()
	Send a keep-alive signal to a remote database, to stop it from timing out. More...

virtual void	readahead_for_query (const Xapian::Query &query)

virtual Xapian::termcount	get_doclength_lower_bound () const
	Get a lower bound on the length of a document in this DB. More...

virtual Xapian::termcount	get_doclength_upper_bound () const
	Get an upper bound on the length of a document in this DB. More...

virtual Xapian::termcount	get_wdf_upper_bound (const std::string &term) const
	Get an upper bound on the wdf of term term. More...

virtual ValueList *	open_value_list (Xapian::valueno slot) const
	Open a value stream. More...

virtual TermList *	open_spelling_termlist (const string &word) const
	Create a termlist tree from trigrams of word. More...

virtual TermList *	open_spelling_wordlist () const
	Return a termlist which returns the words which are spelling correction targets. More...

virtual Xapian::doccount	get_spelling_frequency (const string &word) const
	Return the number of times word was added as a spelling. More...

virtual void	add_spelling (const string &word, Xapian::termcount freqinc) const
	Add a word to the spelling dictionary. More...

virtual void	remove_spelling (const string &word, Xapian::termcount freqdec) const
	Remove a word from the spelling dictionary. More...

virtual TermList *	open_synonym_termlist (const string &term) const
	Open a termlist returning synonyms for a term. More...

virtual TermList *	open_synonym_keylist (const string &prefix) const
	Open a termlist returning each term which has synonyms. More...

virtual void	add_synonym (const string &term, const string &synonym) const
	Add a synonym for a term. More...

virtual void	remove_synonym (const string &term, const string &synonym) const
	Remove a synonym for a term. More...

virtual void	clear_synonyms (const string &term) const
	Clear all synonyms for a term. More...

void	begin_transaction (bool flushed)
	Begin a transaction. More...

void	commit_transaction ()
	Commit a transaction. More...

void	cancel_transaction ()
	Cancel a transaction. More...

virtual void	delete_document (const string &unique_term)
	Delete any documents indexed by a term from the database. More...

virtual Xapian::docid	replace_document (const string &unique_term, const Xapian::Document &document)
	Replace any documents matching a term. More...

virtual void	request_document (Xapian::docid) const
	Request and later collect a document from the database. More...

virtual Xapian::Document::Internal *	collect_document (Xapian::docid did) const

virtual void	write_changesets_to_fd (int fd, const std::string &start_revision, bool need_whole_db, Xapian::ReplicationInfo *info)
	Write a set of changesets to a file descriptor. More...

virtual string	get_revision_info () const
	Get a string describing the current revision of the database. More...

virtual string	get_uuid () const
	Get a UUID for the database. More...

virtual void	invalidate_doc_object (Xapian::Document::Internal *obj) const
	Notify the database that document is no longer valid. More...

virtual void	get_used_docid_range (Xapian::docid &first, Xapian::docid &last) const
	Find lowest and highest docids actually in use. More...

Public Member Functions inherited from Xapian::Internal::intrusive_base
	intrusive_base ()
	Construct with no references. More...

Static Public Member Functions
static void	throw_database_closed ()

Private Member Functions
InMemoryDatabase &	operator= (const InMemoryDatabase &)

	InMemoryDatabase (const InMemoryDatabase &)

void	make_term (const string &tname)

bool	doc_exists (Xapian::docid did) const

Xapian::docid	make_doc (const string &docdata)

void	finish_add_doc (Xapian::docid did, const Xapian::Document &document)

void	add_values (Xapian::docid did, const map< Xapian::valueno, string > &values_)

void	make_posting (InMemoryDoc *doc, const string &tname, Xapian::docid did, Xapian::termpos position, Xapian::termcount wdf, bool use_position=true)

void	commit ()
	Implementation of virtual methods: see Database for details. More...

void	cancel ()
	Cancel pending modifications to the database. More...

Xapian::docid	add_document (const Xapian::Document &document)
	Add a new document to the database. More...

void	delete_document (Xapian::docid did)
	Delete a document in the database. More...

void	replace_document (Xapian::docid did, const Xapian::Document &document)
	Replace a given document in the database. More...

Private Attributes
map< string, InMemoryTerm >	postlists

vector< InMemoryDoc >	termlists

vector< std::string >	doclists

vector< std::map< Xapian::valueno, string > >	valuelists

std::map< Xapian::valueno, ValueStats >	valuestats

vector< Xapian::termcount >	doclengths

std::map< string, string >	metadata

Xapian::doccount	totdocs

Xapian::totallength	totlen

bool	positions_present

bool	closed

Friends
class	InMemoryAllDocsPostList

class	InMemoryDocument

Additional Inherited Members
Public Attributes inherited from Xapian::Internal::intrusive_base
unsigned	_refs
	Reference count. More...

Protected Types inherited from Xapian::Database::Internal
enum	{ TRANSACTION_UNIMPLEMENTED = -1 , TRANSACTION_NONE = 0 , TRANSACTION_UNFLUSHED = 1 , TRANSACTION_FLUSHED = 2 }
	Transaction state. More...

Protected Member Functions inherited from Xapian::Database::Internal
bool	transaction_active () const

	Internal ()
	Create a database - called only by derived classes. More...

void	dtor_called ()
	Internal method to perform cleanup when a writable database is destroyed with uncommitted changes. More...

Protected Attributes inherited from Xapian::Database::Internal
enum Xapian::Database::Internal:: { ... }	transaction_state
	Transaction state. More...

Detailed Description

A database held entirely in memory.

This is a prototype database, mainly used for debugging and testing.

Definition at line 257 of file inmemory_database.h.

Constructor & Destructor Documentation

◆ InMemoryDatabase() [1/2]

InMemoryDatabase::InMemoryDatabase ( const InMemoryDatabase & )

private

◆ InMemoryDatabase() [2/2]

InMemoryDatabase::InMemoryDatabase ( )

Create and open an in-memory database.

Exceptions

Xapian::DatabaseOpeningError thrown if database can't be opened.

Definition at line 453 of file inmemory_database.cc.

References postlists, Xapian::Database::Internal::transaction_state, and Xapian::Database::Internal::TRANSACTION_UNIMPLEMENTED.

◆ ~InMemoryDatabase()

InMemoryDatabase::~InMemoryDatabase ( )

Definition at line 464 of file inmemory_database.cc.

References Xapian::Database::Internal::dtor_called().

Member Function Documentation

◆ add_document()

Xapian::docid InMemoryDatabase::add_document ( const Xapian::Document & document )

privatevirtual

Add a new document to the database.

See WritableDatabase::add_document() for more information.

Reimplemented from Xapian::Database::Internal.

Definition at line 858 of file inmemory_database.cc.

References closed, finish_add_doc(), Xapian::Document::get_data(), LOGCALL, make_doc(), RETURN, and throw_database_closed().

◆ add_values()

void InMemoryDatabase::add_values	(	Xapian::docid	did,
		const map< Xapian::valueno, string > &	values_
	)

private

Definition at line 703 of file inmemory_database.cc.

References closed, throw_database_closed(), valuelists, and valuestats.

Referenced by finish_add_doc().

◆ cancel()

void InMemoryDatabase::cancel ( )

privatevirtual

Cancel pending modifications to the database.

Reimplemented from Xapian::Database::Internal.

Definition at line 744 of file inmemory_database.cc.

◆ close()

void InMemoryDatabase::close ( )

virtual

Close the database.

Implements Xapian::Database::Internal.

Definition at line 477 of file inmemory_database.cc.

References closed, doclengths, doclists, metadata, postlists, termlists, valuelists, and valuestats.

◆ commit()

void InMemoryDatabase::commit ( )

privatevirtual

Implementation of virtual methods: see Database for details.

Reimplemented from Xapian::Database::Internal.

Definition at line 738 of file inmemory_database.cc.

◆ delete_document()

void InMemoryDatabase::delete_document ( Xapian::docid did )

privatevirtual

Delete a document in the database.

See WritableDatabase::delete_document() for more information.

Reimplemented from Xapian::Database::Internal.

Definition at line 749 of file inmemory_database.cc.

References Assert, closed, InMemoryPosting::did, doc_exists(), doclengths, doclists, positions_present, postlists, Xapian::Internal::str(), termlists, throw_database_closed(), totdocs, totlen, valuelists, and valuestats.

◆ doc_exists()

bool InMemoryDatabase::doc_exists ( Xapian::docid did ) const

private

Definition at line 507 of file inmemory_database.cc.

References closed, termlists, and throw_database_closed().

Referenced by delete_document(), get_doclength(), make_posting(), open_document(), open_position_list(), open_term_list(), positionlist_count(), and replace_document().

◆ finish_add_doc()

void InMemoryDatabase::finish_add_doc	(	Xapian::docid	did,
		const Xapian::Document &	document
	)

private

◆ get_backend_info()

int InMemoryDatabase::get_backend_info ( string * path ) const

inlinevirtual

Get backend information about this database.

Parameters

path	If non-NULL, and set the pointed to string to the file path of this database (or if to some string describing the database in a backend-specified format if "path" isn't a concept which make sense).

Returns: A constant indicating the backend type.

Implements Xapian::Database::Internal.

Definition at line 366 of file inmemory_database.h.

References BACKEND_INMEMORY.

◆ get_doccount()

Xapian::doccount InMemoryDatabase::get_doccount ( ) const

virtual

Return the number of docs in this (sub) database.

Implements Xapian::Database::Internal.

Definition at line 561 of file inmemory_database.cc.

References closed, throw_database_closed(), and totdocs.

Referenced by InMemoryTermList::accumulate_stats().

◆ get_doclength()

Xapian::termcount InMemoryDatabase::get_doclength ( Xapian::docid did ) const

virtual

Get the length of a given document.

Document length, for the purposes of Xapian, is defined to be the number of instances of terms within a document. Expressed differently, the sum of the within document frequencies over all the terms in the document.

Parameters

did	The document id of the document whose length is being requested.

Implements Xapian::Database::Internal.

Definition at line 581 of file inmemory_database.cc.

References closed, doc_exists(), doclengths, Xapian::Internal::str(), and throw_database_closed().

Referenced by InMemoryPostList::get_doclength(), and InMemoryAllDocsPostList::get_doclength().

◆ get_freqs()

void InMemoryDatabase::get_freqs	(	const string &	term,
		Xapian::doccount *	termfreq_ptr,
		Xapian::termcount *	collfreq_ptr
	)		const

virtual

Returns frequencies for a term.

Parameters

term	The term to get frequencies for
termfreq_ptr	Point to return number of docs indexed by term (or NULL not to return)
collfreq_ptr	Point to return number of occurrences of term in the database (or NULL not to return)

Implements Xapian::Database::Internal.

Definition at line 514 of file inmemory_database.cc.

References closed, postlists, and throw_database_closed().

Referenced by InMemoryTermList::get_termfreq().

◆ get_lastdocid()

Xapian::docid InMemoryDatabase::get_lastdocid ( ) const

virtual

Return the last used document id of this (sub) database.

Implements Xapian::Database::Internal.

Definition at line 568 of file inmemory_database.cc.

References closed, termlists, and throw_database_closed().

◆ get_metadata()

std::string InMemoryDatabase::get_metadata ( const std::string & key ) const

virtual

Get the metadata associated with a given key.

See Database::get_metadata() for more information.

Reimplemented from Xapian::Database::Internal.

Definition at line 633 of file inmemory_database.cc.

References closed, metadata, and throw_database_closed().

◆ get_total_length()

Xapian::totallength InMemoryDatabase::get_total_length ( ) const

virtual

Return the total length of all documents in this database.

Implements Xapian::Database::Internal.

Definition at line 575 of file inmemory_database.cc.

References totlen.

◆ get_unique_terms()

Xapian::termcount InMemoryDatabase::get_unique_terms ( Xapian::docid did ) const

virtual

Get the number of unique term in document.

Parameters

did	The document id of the document whose number of terms is being requested.

Implements Xapian::Database::Internal.

Definition at line 592 of file inmemory_database.cc.

References closed, doclengths, Xapian::Internal::str(), termlists, and throw_database_closed().

Referenced by InMemoryPostList::get_unique_terms(), and InMemoryAllDocsPostList::get_unique_terms().

◆ get_value_freq()

Xapian::doccount InMemoryDatabase::get_value_freq ( Xapian::valueno slot ) const

virtual

Return the frequency of a given value slot.

This is the number of documents which have a (non-empty) value stored in the slot.

Parameters

slot	The value slot to examine.

Implements Xapian::Database::Internal.

Definition at line 534 of file inmemory_database.cc.

References closed, throw_database_closed(), and valuestats.

◆ get_value_lower_bound()

std::string InMemoryDatabase::get_value_lower_bound ( Xapian::valueno slot ) const

virtual

Get a lower bound on the values stored in the given value slot.

If there are no values stored in the given value slot, this will return an empty string.

Parameters

slot	The value slot to examine.

Implements Xapian::Database::Internal.

Definition at line 543 of file inmemory_database.cc.

References closed, throw_database_closed(), and valuestats.

◆ get_value_upper_bound()

std::string InMemoryDatabase::get_value_upper_bound ( Xapian::valueno slot ) const

virtual

Get an upper bound on the values stored in the given value slot.

If there are no values stored in the given value slot, this will return an empty string.

Parameters

slot	The value slot to examine.

Implements Xapian::Database::Internal.

Definition at line 552 of file inmemory_database.cc.

References closed, throw_database_closed(), and valuestats.

◆ has_positions()

bool InMemoryDatabase::has_positions ( ) const

virtual

Check whether this database contains any positional information.

Implements Xapian::Database::Internal.

Definition at line 962 of file inmemory_database.cc.

References closed, positions_present, and throw_database_closed().

◆ is_closed()

bool InMemoryDatabase::is_closed ( ) const

inline

Definition at line 330 of file inmemory_database.h.

◆ locked()

bool InMemoryDatabase::locked ( ) const

inlinevirtual

Return true if the database is open for writing.

If this is a WritableDatabase, always returns true.

For a Database, test if there's a writer holding the lock (or if we can't test for a lock without taking it on the current platform, throw Xapian::UnimplementedError).

Reimplemented from Xapian::Database::Internal.

Definition at line 371 of file inmemory_database.h.

◆ make_doc()

Xapian::docid InMemoryDatabase::make_doc ( const string & docdata )

private

Definition at line 919 of file inmemory_database.cc.

References AssertEqParanoid, doclengths, doclists, rare, and termlists.

Referenced by add_document().

◆ make_posting()

void InMemoryDatabase::make_posting	(	InMemoryDoc *	doc,
		const string &	tname,
		Xapian::docid	did,
		Xapian::termpos	position,
		Xapian::termcount	wdf,
		bool	use_position = `true`
	)

private

Definition at line 934 of file inmemory_database.cc.

References InMemoryDoc::add_posting(), Assert, doc_exists(), doclengths, postlists, and termlists.

Referenced by finish_add_doc().

◆ make_term()

void InMemoryDatabase::make_term ( const string & tname )

private

Definition at line 913 of file inmemory_database.cc.

References postlists.

Referenced by finish_add_doc().

◆ open_allterms()

TermList * InMemoryDatabase::open_allterms ( const string & prefix ) const

virtual

Open an allterms list.

This is a list of all the terms in the database

Parameters

prefix The prefix to restrict the terms to.

Returns: A pointer to the newly created allterms list. This object must be deleted by the caller after use.

Implements Xapian::Database::Internal.

Definition at line 969 of file inmemory_database.cc.

References closed, postlists, and throw_database_closed().

◆ open_document()

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

virtual

Open a document.

This is used to access the values and data associated with a document. See class Xapian::Document::Internal for further details.

Parameters

did	The document id which is being requested.
lazy	No need to check that this document actually exists. Used when we already know that this document exists (only a hint - the backend may still check).

Returns: A pointer to the newly created document object. This object must be deleted by the caller after use.

Implements Xapian::Database::Internal.

Definition at line 620 of file inmemory_database.cc.

References Assert, closed, doc_exists(), InMemoryDocument, Xapian::Internal::str(), and throw_database_closed().

◆ open_metadata_keylist()

TermList * InMemoryDatabase::open_metadata_keylist ( const std::string & prefix ) const

virtual

Open a termlist returning each metadata key.

Only metadata keys which are associated with a non-empty value will be returned.

Parameters

prefix If non-empty, only keys with this prefix are returned.

Reimplemented from Xapian::Database::Internal.

Definition at line 643 of file inmemory_database.cc.

References closed, metadata, and throw_database_closed().

◆ open_position_list()

PositionList * InMemoryDatabase::open_position_list	(	Xapian::docid	did,
		const string &	tname
	)		const

virtual

Open a position list for the given term in the given document.

Parameters

did	The document id for which a position list is being requested.
tname	The term for which a position list is being requested.

Returns: A pointer to the newly created position list. This object must be deleted by the caller after use.

Implements Xapian::Database::Internal.

Definition at line 684 of file inmemory_database.cc.

References closed, doc_exists(), termlists, InMemoryDoc::terms, throw_database_closed(), InMemoryTermEntry::tname, and usual.

Referenced by InMemoryTermList::positionlist_begin().

◆ open_post_list()

LeafPostList * InMemoryDatabase::open_post_list ( const string & tname ) const

virtual

Open a posting list.

Method defined by subclass to open a posting list. This is a list of all the documents which contain a given term.

Parameters

tname The term whose posting list is being requested.

Returns: A pointer to the newly created posting list. If the term doesn't exist, a LeafPostList object returning no documents is returned, which makes it easier to implement a search over multiple databases. This object must be deleted by the caller after use.

Implements Xapian::Database::Internal.

Definition at line 491 of file inmemory_database.cc.

References Assert, closed, InMemoryAllDocsPostList, postlists, and throw_database_closed().