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

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

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

Xapian::termcount	get_wdfdocmax (Xapian::docid did) const
	Get the max wdf in document. More...

void	get_freqs (std::string_view 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...

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

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

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

bool	term_exists (std::string_view term) const

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

PostList *	open_post_list (std::string_view tname) const
	Return a PostList suitable for use in a PostingIterator. More...

LeafPostList *	open_leaf_post_list (std::string_view term, bool need_read_pos) const
	Create a LeafPostList for use during a match. More...

TermList *	open_term_list (Xapian::docid did) const

TermList *	open_term_list_direct (Xapian::docid did) const
	Like open_term_list() but without MultiTermList wrapper. More...

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

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

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

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

Xapian::termcount	positionlist_count (Xapian::docid did, std::string_view tname) const

PositionList *	open_position_list (Xapian::docid did, std::string_view tname) const

TermList *	open_allterms (std::string_view prefix) const

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

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

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

Xapian::Database::Internal *	update_lock (int flags)
	Lock a read-only database for writing or unlock a writable database. More...

std::string	get_description () const
	Return a string describing this object. More...

Public Member Functions inherited from Xapian::Database::Internal
virtual	~Internal ()
	We have virtual methods and want to be able to delete derived classes using a pointer to the base class, so we need a virtual destructor. More...

virtual size_type	size () const

virtual void	keep_alive ()

virtual void	readahead_for_query (const Query &query) const

virtual termcount	get_unique_terms_lower_bound () const
	Get a lower bound on the unique terms size of a document in this DB. More...

virtual termcount	get_unique_terms_upper_bound () const
	Get an upper bound on the unique terms size of a document in this DB. More...

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

virtual TermList *	open_spelling_termlist (std::string_view 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 doccount	get_spelling_frequency (std::string_view word) const
	Return the number of times word was added as a spelling. More...

virtual void	add_spelling (std::string_view word, termcount freqinc) const
	Add a word to the spelling dictionary. More...

virtual termcount	remove_spelling (std::string_view word, termcount freqdec) const
	Remove a word from the spelling dictionary. More...

virtual TermList *	open_synonym_termlist (std::string_view term) const
	Open a termlist returning synonyms for a term. More...

virtual TermList *	open_synonym_keylist (std::string_view prefix) const
	Open a termlist returning each term which has synonyms. More...

virtual void	add_synonym (std::string_view term, std::string_view synonym) const
	Add a synonym for a term. More...

virtual void	remove_synonym (std::string_view term, std::string_view synonym) const
	Remove a synonym for a term. More...

virtual void	clear_synonyms (std::string_view term) const
	Clear all synonyms for a term. More...

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

virtual void	end_transaction (bool do_commit)
	End transaction. More...

virtual void	delete_document (std::string_view unique_term)
	Delete any documents indexed by a term from the database. More...

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

virtual void	request_document (docid did) const
	Request a document. More...

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

virtual Xapian::rev	get_revision () const
	Get revision number of database (if meaningful). More...

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

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

virtual std::string	reconstruct_text (Xapian::docid did, size_t length, std::string_view prefix, Xapian::termpos start_pos, Xapian::termpos end_pos) const

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 std::string &tname)

bool	doc_exists (Xapian::docid did) const

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

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

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

void	make_posting (InMemoryDoc *doc, const std::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)

void	delete_document (Xapian::docid did)

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

Private Attributes
std::map< std::string, InMemoryTerm, std::less<> >	postlists

std::vector< InMemoryDoc >	termlists

std::vector< std::string >	doclists

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

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

std::vector< Xapian::termcount >	doclengths

std::map< std::string, std::string, std::less<> >	metadata

Xapian::doccount	totdocs

Xapian::totallength	totlen

bool	positions_present

bool	closed

Friends
class	InMemoryAllDocsPostList

class	InMemoryDocument

Additional Inherited Members
Public Types inherited from Xapian::Database::Internal
typedef Xapian::doccount	size_type

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

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

Protected Member Functions inherited from Xapian::Database::Internal
	Internal (transaction_state transaction_support)
	Only constructable as a base class for derived classes. More...

bool	is_read_only () const
	Test if this shard is read-only. More...

bool	transaction_active () const
	Test if a transaction is currently active. More...

void	dtor_called ()
	Helper to process uncommitted changes when a writable db is destroyed. More...

Protected Attributes inherited from Xapian::Database::Internal
transaction_state	state
	Current 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 250 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 427 of file inmemory_database.cc.

References postlists.

◆ ~InMemoryDatabase()

InMemoryDatabase::~InMemoryDatabase ( )

Definition at line 436 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

Reimplemented from Xapian::Database::Internal.

Definition at line 887 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 std::map< Xapian::valueno, std::string > &	values_
	)

private

Definition at line 744 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 783 of file inmemory_database.cc.

◆ close()

void InMemoryDatabase::close ( )

virtual

Close the database.

Implements Xapian::Database::Internal.

Definition at line 449 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 777 of file inmemory_database.cc.

◆ delete_document()

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

privatevirtual

Reimplemented from Xapian::Database::Internal.

Definition at line 788 of file inmemory_database.cc.

References Assert, closed, InMemoryPosting::did, doc_exists(), doclengths, doclists, p, 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 494 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 ( std::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 to some string describing the database in a backend-specified format if "path" isn't a concept which makes sense).

Returns: A constant indicating the backend type.

Implements Xapian::Database::Internal.

Definition at line 367 of file inmemory_database.h.

References BACKEND_INMEMORY.

◆ get_description()

string InMemoryDatabase::get_description ( ) const

virtual

Return a string describing this object.

Implements Xapian::Database::Internal.

Definition at line 1037 of file inmemory_database.cc.

◆ get_doccount()

Xapian::doccount InMemoryDatabase::get_doccount ( ) const

virtual

Implements Xapian::Database::Internal.

Definition at line 574 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

Implements Xapian::Database::Internal.

Definition at line 594 of file inmemory_database.cc.

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

◆ get_doclength_lower_bound()

Xapian::termcount InMemoryDatabase::get_doclength_lower_bound ( ) const

virtual

Get a lower bound on the length of a document in this DB.

This bound does not include any zero-length documents.

Implements Xapian::Database::Internal.

Definition at line 548 of file inmemory_database.cc.

◆ get_doclength_upper_bound()

Xapian::termcount InMemoryDatabase::get_doclength_upper_bound ( ) const

virtual

Get an upper bound on the length of a document in this DB.

Implements Xapian::Database::Internal.

Definition at line 556 of file inmemory_database.cc.

References get_total_length().

◆ get_freqs()

void InMemoryDatabase::get_freqs	(	std::string_view	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 501 of file inmemory_database.cc.

References closed, postlists, term, and throw_database_closed().

Referenced by InMemoryTermList::get_termfreq(), and get_wdf_upper_bound().

◆ 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 581 of file inmemory_database.cc.

References closed, termlists, and throw_database_closed().

◆ get_metadata()

std::string InMemoryDatabase::get_metadata ( std::string_view 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 666 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 588 of file inmemory_database.cc.

References totlen.

Referenced by get_doclength_upper_bound().

◆ get_unique_terms()

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

virtual

Get the number of unique terms in document.

Parameters

did	The document id of the document to return this value for.

Implements Xapian::Database::Internal.

Definition at line 605 of file inmemory_database.cc.

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

◆ get_used_docid_range()

void InMemoryDatabase::get_used_docid_range	(	Xapian::docid &	first,
		Xapian::docid &	last
	)		const

virtual

Find lowest and highest docids actually in use.

Used during local matching and compaction, so only needs to be implemented by backends which support one or both of these.

For example, EmptyDatabase, MultiDatabase and RemoteDatabase don't need to implement this (empty shards are skipped early by the matcher; sharded databases are handled explicitly by the matcher rather than via the "multi" backend; matching for remote shards runs as a local match on the remote).

Reimplemented from Xapian::Database::Internal.

Definition at line 1009 of file inmemory_database.cc.

References closed, termlists, throw_database_closed(), and totdocs.

◆ 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 521 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 530 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 539 of file inmemory_database.cc.

References closed, throw_database_closed(), and valuestats.

◆ get_wdf_upper_bound()

Xapian::termcount InMemoryDatabase::get_wdf_upper_bound ( std::string_view term ) const

virtual

Get an upper bound on the wdf of term term.

Implements Xapian::Database::Internal.

Definition at line 564 of file inmemory_database.cc.

References get_freqs(), and term.

◆ get_wdfdocmax()

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

virtual

Get the max wdf in document.

Parameters

did	The document id of the document to return this value for.

Implements Xapian::Database::Internal.

Definition at line 619 of file inmemory_database.cc.

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

Referenced by InMemoryPostList::get_wdfdocmax().

◆ has_positions()

bool InMemoryDatabase::has_positions ( ) const

virtual

Check whether this database contains any positional information.

Implements Xapian::Database::Internal.

Definition at line 993 of file inmemory_database.cc.

References closed, positions_present, and throw_database_closed().

◆ is_closed()

bool InMemoryDatabase::is_closed ( ) const

inline

◆ 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 374 of file inmemory_database.h.

References closed.

◆ make_doc()

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

private

Definition at line 948 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 std::string &	tname,
		Xapian::docid	did,
		Xapian::termpos	position,
		Xapian::termcount	wdf,
		bool	use_position = `true`
	)

private

Definition at line 963 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 std::string & tname )

private

Definition at line 942 of file inmemory_database.cc.

References postlists.

Referenced by finish_add_doc().

◆ open_allterms()

TermList * InMemoryDatabase::open_allterms ( std::string_view prefix ) const

virtual

Implements Xapian::Database::Internal.

Definition at line 1000 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 handle on a document.

The returned handle provides access to document data and document values.

Parameters

did	The document id to open.
lazy	If true, there's no need to check that this document actually exists (only a hint - the backend may still check). Used to avoid unnecessary work when we already know that the requested document exists.

Returns: A new document object, owned by the caller.

Implements Xapian::Database::Internal.

Definition at line 653 of file inmemory_database.cc.

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

◆ open_leaf_post_list()

LeafPostList * InMemoryDatabase::open_leaf_post_list	(	std::string_view	term,
		bool	need_read_pos
	)		const

virtual

Create a LeafPostList for use during a match.

Parameters

term	The term to open a postlist for, or the empty string to create an all-docs postlist.
need_read_pos	Does the postlist need to support read_position_list()? Note that open_position_list() may still be called even if need_read_pos is false.

Implements Xapian::Database::Internal.

Definition at line 469 of file inmemory_database.cc.

References Assert, closed, InMemoryAllDocsPostList, postlists, rare, term, termlists, throw_database_closed(), and totdocs.

Referenced by open_post_list().