Empty database internals. More...

#include <empty_database.h>

Inheritance diagram for EmptyDatabase:

Collaboration diagram for EmptyDatabase:

Public Member Functions
	EmptyDatabase ()

size_type	size () const

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

PostList *	open_post_list (std::string_view term) 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...

TermList *	open_allterms (std::string_view prefix) const

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

PositionList *	open_position_list (Xapian::docid did, std::string_view term) 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...

void	get_freqs (std::string_view term, Xapian::doccount tf_ptr, Xapian::termcount cf_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...

ValueList *	open_value_list (Xapian::valueno slot) const
	Open a value stream. 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...

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

bool	term_exists (std::string_view term) const

TermList *	open_spelling_termlist (std::string_view word) const
	Create a termlist tree from trigrams of word. More...

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

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

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

TermList *	open_synonym_keylist (std::string_view prefix) const
	Open a termlist returning each term which has synonyms. 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	write_changesets_to_fd (int fd, std::string_view start_revision, bool need_whole_db, Xapian::ReplicationInfo *info)
	Write a set of changesets to a file descriptor. More...

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

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

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

void	commit ()
	Commit pending modifications to the database. More...

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

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

Xapian::docid	add_document (const Xapian::Document &doc)

void	delete_document (Xapian::docid did)

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

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

Xapian::docid	replace_document (std::string_view term, const Xapian::Document &doc)
	Replace any documents matching a term. More...

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

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

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

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

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

void	set_metadata (std::string_view key, std::string_view value)
	Set the metadata associated with a given key. 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 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 bool	reopen ()
	Reopen the database to the latest available revision. More...

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

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

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

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

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

virtual Internal *	update_lock (int flags)
	Lock a read-only database for writing or unlock a writable database. 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...

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

Empty database internals.

Definition at line 29 of file empty_database.h.

Constructor & Destructor Documentation

◆ EmptyDatabase()

EmptyDatabase::EmptyDatabase ( )

inline

Definition at line 31 of file empty_database.h.

Member Function Documentation

◆ add_document()

Xapian::docid EmptyDatabase::add_document ( const Xapian::Document & doc )

virtual

Reimplemented from Xapian::Database::Internal.

Definition at line 295 of file empty_database.cc.

References no_subdatabases().

◆ add_spelling()

void EmptyDatabase::add_spelling	(	std::string_view	word,
		Xapian::termcount	freqinc
	)		const

virtual

Add a word to the spelling dictionary.

If the word is already present, its frequency is increased.

Parameters

word	The word to add.
freqinc	How much to increase its frequency by.

Reimplemented from Xapian::Database::Internal.

Definition at line 325 of file empty_database.cc.

References no_subdatabases().

◆ add_synonym()

void EmptyDatabase::add_synonym	(	std::string_view	term,
		std::string_view	synonym
	)		const

virtual

Add a synonym for a term.

If synonym is already a synonym for term, then no action is taken.

Reimplemented from Xapian::Database::Internal.

Definition at line 337 of file empty_database.cc.

References no_subdatabases().

◆ begin_transaction()

void EmptyDatabase::begin_transaction ( bool flushed )

virtual

Begin transaction.

Reimplemented from Xapian::Database::Internal.

Definition at line 289 of file empty_database.cc.

References no_subdatabases().

◆ cancel()

void EmptyDatabase::cancel ( )

virtual

Cancel pending modifications to the database.

Reimplemented from Xapian::Database::Internal.

Definition at line 284 of file empty_database.cc.

◆ clear_synonyms()

void EmptyDatabase::clear_synonyms ( std::string_view term ) const

virtual

Clear all synonyms for a term.

If term has no synonyms, no action is taken.

Reimplemented from Xapian::Database::Internal.

Definition at line 349 of file empty_database.cc.

References no_subdatabases().

◆ close()

void EmptyDatabase::close ( )

virtual

Close the database.

Implements Xapian::Database::Internal.

Definition at line 44 of file empty_database.cc.

◆ commit()

void EmptyDatabase::commit ( )

virtual

Commit pending modifications to the database.

Reimplemented from Xapian::Database::Internal.

Definition at line 278 of file empty_database.cc.

References no_subdatabases().

◆ delete_document() [1/2]

void EmptyDatabase::delete_document ( std::string_view unique_term )

virtual

Delete any documents indexed by a term from the database.

Reimplemented from Xapian::Database::Internal.

Definition at line 307 of file empty_database.cc.

References no_subdatabases().

◆ delete_document() [2/2]

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

virtual

Reimplemented from Xapian::Database::Internal.

Definition at line 301 of file empty_database.cc.

References no_subdatabases().

◆ get_backend_info()

int EmptyDatabase::get_backend_info ( std::string * path ) const

virtual

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 270 of file empty_database.cc.

References Assert, and BACKEND_UNKNOWN.

◆ get_description()

string EmptyDatabase::get_description ( ) const

virtual

Return a string describing this object.

Implements Xapian::Database::Internal.

Definition at line 361 of file empty_database.cc.

◆ get_doccount()

Xapian::doccount EmptyDatabase::get_doccount ( ) const

virtual

Implements Xapian::Database::Internal.

Definition at line 91 of file empty_database.cc.

◆ get_doclength()

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

virtual

Implements Xapian::Database::Internal.

Definition at line 167 of file empty_database.cc.

References Assert, and no_subdatabases().

◆ get_doclength_lower_bound()

Xapian::termcount EmptyDatabase::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 141 of file empty_database.cc.

◆ get_doclength_upper_bound()

Xapian::termcount EmptyDatabase::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 147 of file empty_database.cc.

◆ get_freqs()

void EmptyDatabase::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 109 of file empty_database.cc.

References Assert, and term.

◆ get_lastdocid()

Xapian::docid EmptyDatabase::get_lastdocid ( ) const

virtual

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

Implements Xapian::Database::Internal.

Definition at line 97 of file empty_database.cc.

◆ get_metadata()

string EmptyDatabase::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 235 of file empty_database.cc.

◆ get_revision()

Xapian::rev EmptyDatabase::get_revision ( ) const

virtual

Get revision number of database (if meaningful).

Reimplemented from Xapian::Database::Internal.

Definition at line 257 of file empty_database.cc.

◆ get_spelling_frequency()

Xapian::doccount EmptyDatabase::get_spelling_frequency ( std::string_view word ) const

virtual

Return the number of times word was added as a spelling.

Reimplemented from Xapian::Database::Internal.

Definition at line 217 of file empty_database.cc.

◆ get_total_length()

Xapian::totallength EmptyDatabase::get_total_length ( ) const

virtual

Return the total length of all documents in this database.

Implements Xapian::Database::Internal.

Definition at line 103 of file empty_database.cc.

◆ get_unique_terms()

Xapian::termcount EmptyDatabase::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 175 of file empty_database.cc.

References Assert, and no_subdatabases().

◆ get_value_freq()

Xapian::doccount EmptyDatabase::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 123 of file empty_database.cc.

◆ get_value_lower_bound()

string EmptyDatabase::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 129 of file empty_database.cc.

◆ get_value_upper_bound()

string EmptyDatabase::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 135 of file empty_database.cc.

◆ get_wdf_upper_bound()

Xapian::termcount EmptyDatabase::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 153 of file empty_database.cc.

References Assert, and term.

◆ get_wdfdocmax()

Xapian::termcount EmptyDatabase::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 183 of file empty_database.cc.

References Assert, and no_subdatabases().

◆ has_positions()

bool EmptyDatabase::has_positions ( ) const

virtual

Check whether this database contains any positional information.

Implements Xapian::Database::Internal.

Definition at line 79 of file empty_database.cc.

◆ invalidate_doc_object()

void EmptyDatabase::invalidate_doc_object ( Xapian::Document::Internal * obj ) const

virtual

Notify the database that document is no longer valid.

This is used to invalidate references to a document kept by a database for doing lazy updates. If we moved to using a weak_ptr instead we wouldn't need a special method for this, but it would involve a fair bit of reorganising of other parts of the code.

Reimplemented from Xapian::Database::Internal.

Definition at line 263 of file empty_database.cc.

References Assert.

◆ open_allterms()

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

virtual

Implements Xapian::Database::Internal.

Definition at line 73 of file empty_database.cc.

◆ open_document()

Xapian::Document::Internal * EmptyDatabase::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 191 of file empty_database.cc.

References Assert, and no_subdatabases().

◆ open_leaf_post_list()

LeafPostList * EmptyDatabase::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 55 of file empty_database.cc.

◆ open_metadata_keylist()

TermList * EmptyDatabase::open_metadata_keylist ( std::string_view 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 241 of file empty_database.cc.

◆ open_position_list()

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

virtual

Implements Xapian::Database::Internal.

Definition at line 85 of file empty_database.cc.

References no_subdatabases().

◆ open_post_list()

PostList * EmptyDatabase::open_post_list ( std::string_view term ) const

virtual

Return a PostList suitable for use in a PostingIterator.

Implements Xapian::Database::Internal.

Definition at line 49 of file empty_database.cc.

◆ open_spelling_termlist()

TermList * EmptyDatabase::open_spelling_termlist ( std::string_view word ) const

virtual

Create a termlist tree from trigrams of word.

You can assume word.size() > 1.

If there are no trigrams, returns NULL.

Reimplemented from Xapian::Database::Internal.

Definition at line 205 of file empty_database.cc.

◆ open_spelling_wordlist()

TermList * EmptyDatabase::open_spelling_wordlist ( ) const

virtual

Return a termlist which returns the words which are spelling correction targets.

If there are no spelling correction targets, returns NULL.

Reimplemented from Xapian::Database::Internal.

Definition at line 211 of file empty_database.cc.

◆ open_synonym_keylist()

TermList * EmptyDatabase::open_synonym_keylist ( std::string_view prefix ) const

virtual

Open a termlist returning each term which has synonyms.

Parameters

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

Reimplemented from Xapian::Database::Internal.

Definition at line 229 of file empty_database.cc.

◆ open_synonym_termlist()

TermList * EmptyDatabase::open_synonym_termlist ( std::string_view term ) const

virtual

Open a termlist returning synonyms for a term.

If term has no synonyms, returns NULL.

Reimplemented from Xapian::Database::Internal.

Definition at line 223 of file empty_database.cc.

◆ open_term_list()

TermList * EmptyDatabase::open_term_list ( Xapian::docid did ) const

virtual

Implements Xapian::Database::Internal.

Definition at line 61 of file empty_database.cc.

References no_subdatabases().

◆ open_term_list_direct()

TermList * EmptyDatabase::open_term_list_direct ( Xapian::docid did ) const

virtual

Like open_term_list() but without MultiTermList wrapper.

MultiDatabase::open_term_list() wraps the returns TermList in a MultiTermList, but we don't want that for query expansion.

Implements Xapian::Database::Internal.

Definition at line 67 of file empty_database.cc.

References no_subdatabases().

◆ open_value_list()

ValueList * EmptyDatabase::open_value_list ( Xapian::valueno slot ) const

virtual

Open a value stream.

This returns the value in a particular slot for each document.

Parameters

slot	The value slot.

Returns: Pointer to a new ValueList object which should be deleted by the caller once it is no longer needed.

Reimplemented from Xapian::Database::Internal.

Definition at line 161 of file empty_database.cc.

◆ remove_spelling()

Xapian::termcount EmptyDatabase::remove_spelling	(	std::string_view	word,
		Xapian::termcount	freqdec
	)		const

virtual

Remove a word from the spelling dictionary.

The word's frequency is decreased, and if would become zero or less then the word is removed completely.

Parameters

word	The word to remove.
freqdec	How much to decrease its frequency by.

Returns: Any freqdec not "used up".

Reimplemented from Xapian::Database::Internal.

Definition at line 331 of file empty_database.cc.

References no_subdatabases().

◆ remove_synonym()

void EmptyDatabase::remove_synonym	(	std::string_view	term,
		std::string_view	synonym
	)		const

virtual

Remove a synonym for a term.

If synonym isn't a synonym for term, then no action is taken.

Reimplemented from Xapian::Database::Internal.

Definition at line 343 of file empty_database.cc.

References no_subdatabases().

◆ replace_document() [1/2]

Xapian::docid EmptyDatabase::replace_document	(	std::string_view	unique_term,
		const Xapian::Document &	document
	)

virtual

Replace any documents matching a term.

Reimplemented from Xapian::Database::Internal.

Definition at line 319 of file empty_database.cc.

References no_subdatabases().

◆ replace_document() [2/2]

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

virtual

Reimplemented from Xapian::Database::Internal.

Definition at line 313 of file empty_database.cc.

References no_subdatabases().

◆ set_metadata()

void EmptyDatabase::set_metadata	(	std::string_view	key,
		std::string_view	value
	)

virtual

Set the metadata associated with a given key.

See WritableDatabase::set_metadata() for more information.

Reimplemented from Xapian::Database::Internal.

Definition at line 355 of file empty_database.cc.

References no_subdatabases().

◆ size()

EmptyDatabase::size_type EmptyDatabase::size ( ) const

virtual

Reimplemented from Xapian::Database::Internal.

Definition at line 38 of file empty_database.cc.

◆ term_exists()

bool EmptyDatabase::term_exists ( std::string_view term ) const

virtual

Implements Xapian::Database::Internal.

Definition at line 199 of file empty_database.cc.

◆ write_changesets_to_fd()

void EmptyDatabase::write_changesets_to_fd	(	int	fd,
		std::string_view	start_revision,
		bool	need_whole_db,
		Xapian::ReplicationInfo *	info
	)

virtual

Write a set of changesets to a file descriptor.

This call may reopen the database, leaving it pointing to a more recent version of the database.

Reimplemented from Xapian::Database::Internal.

Definition at line 247 of file empty_database.cc.

The documentation for this class was generated from the following files:

backends/empty_database.h
backends/empty_database.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EmptyDatabase()

Member Function Documentation

◆ add_document()

◆ add_spelling()

◆ add_synonym()

◆ begin_transaction()

◆ cancel()

◆ clear_synonyms()

◆ close()

◆ commit()

◆ delete_document() [1/2]

◆ delete_document() [2/2]

◆ get_backend_info()

◆ get_description()

◆ get_doccount()

◆ get_doclength()

◆ get_doclength_lower_bound()

◆ get_doclength_upper_bound()

◆ get_freqs()

◆ get_lastdocid()

◆ get_metadata()

◆ get_revision()

◆ get_spelling_frequency()

◆ get_total_length()

◆ get_unique_terms()

◆ get_value_freq()

◆ get_value_lower_bound()

◆ get_value_upper_bound()

◆ get_wdf_upper_bound()

◆ get_wdfdocmax()

◆ has_positions()

◆ invalidate_doc_object()

◆ open_allterms()

◆ open_document()

◆ open_leaf_post_list()

◆ open_metadata_keylist()

◆ open_position_list()

◆ open_post_list()

◆ open_spelling_termlist()

◆ open_spelling_wordlist()

◆ open_synonym_keylist()

◆ open_synonym_termlist()

◆ open_term_list()

◆ open_term_list_direct()

◆ open_value_list()

◆ remove_spelling()

◆ remove_synonym()

◆ replace_document() [1/2]

◆ replace_document() [2/2]

◆ set_metadata()

◆ size()

◆ term_exists()

◆ write_changesets_to_fd()