pydoc > xapian

man perldoc info pydoc3 ri search

📖 NAME

🐍 Help on package xapian — a Xapian search engine library binding.

📖 DESCRIPTION

🔧 Xapian is a highly adaptable toolkit which allows developers to easily add advanced 📊 indexing and search facilities to their own applications. It has built-in support for several families of ⚖️ weighting models and also supports a rich set of 🔍 boolean query operators.

📚 In addition to the doc strings provided by this python library, you may wish to look at the library's overall documentation, either installed along with the bindings or online at <https://xapian.org/docs/bindings/python/>, as well as the library's documentation, possibly installed with the library or with its development files, or again online at <https://xapian.org/docs/>.

📦 PACKAGE CONTENTS

• _xapian

📚 CLASSES

• 🔴 builtins.Exception
  • 🔴 Error
    • 🔴 LogicError
      • 🔴 AssertionError
      • 🔴 InvalidArgumentError
      • 🔴 InvalidOperationError
      • 🔴 UnimplementedError
    • 🔴 RuntimeError
      • 🔴 DatabaseError
        • 🔴 DatabaseClosedError
        • 🔴 DatabaseCorruptError
        • 🔴 DatabaseCreateError
        • 🔴 DatabaseLockError
        • 🔴 DatabaseModifiedError
        • 🔴 DatabaseOpeningError
          • 🔴 DatabaseNotFoundError
          • 🔴 DatabaseVersionError
      • 🔴 DocNotFoundError
      • 🔴 FeatureUnavailableError
      • 🔴 InternalError
      • 🔴 NetworkError
        • 🔴 NetworkTimeoutError
      • 🔴 QueryParserError
      • 🔴 RangeError
      • 🔴 SerialisationError
      • 🔴 WildcardError
• 🗂️ builtins.object
  • 🗂️ Compactor
  • 🗂️ Database
    • 🗂️ WritableDatabase
  • 🗂️ Document
  • 🗂️ ESet
  • 🗂️ ESetItem
  • 🗂️ ESetIter
  • 🗂️ Enquire
  • 🗂️ ExpandDecider
    • 🗂️ ExpandDeciderAnd
    • 🗂️ ExpandDeciderFilterPrefix
  • 🗂️ FieldProcessor
  • 🗂️ KeyMaker
    • 🗂️ LatLongDistanceKeyMaker
    • 🗂️ MultiValueKeyMaker
  • 🗂️ LatLongCoord
  • 🗂️ LatLongCoords
  • 🗂️ LatLongCoordsIter
  • 🗂️ LatLongMetric
    • 🗂️ GreatCircleMetric
  • 🗂️ MSet
  • 🗂️ MSetItem
  • 🗂️ MSetIter
  • 🗂️ MatchDecider
    • 🗂️ ValueSetMatchDecider
  • 🗂️ MatchSpy
    • 🗂️ ValueCountMatchSpy
  • 🗂️ PositionIter
  • 🗂️ PostingItem
  • 🗂️ PostingIter
  • 🗂️ PostingSource
    • 🗂️ FixedWeightPostingSource
    • 🗂️ ValuePostingSource
      • 🗂️ LatLongDistancePostingSource
      • 🗂️ ValueMapPostingSource
      • 🗂️ ValueWeightPostingSource
        • 🗂️ DecreasingValueWeightPostingSource
  • 🗂️ Query
  • 🗂️ QueryParser
  • 🗂️ RSet
  • 🗂️ RangeProcessor
    • 🗂️ DateRangeProcessor
    • 🗂️ NumberRangeProcessor
  • 🗂️ Registry
  • 🗂️ Stem
  • 🗂️ StemImplementation
  • 🗂️ Stopper
    • 🗂️ SimpleStopper
  • 🗂️ TermGenerator
  • 🗂️ TermIter
  • 🗂️ TermListItem
  • 🗂️ ValueItem
  • 🗂️ ValueIter
  • 🗂️ ValueRangeProcessor
    • 🗂️ StringValueRangeProcessor
      • 🗂️ DateValueRangeProcessor
      • 🗂️ NumberValueRangeProcessor
  • 🗂️ ValueStreamItem
  • 🗂️ ValueStreamIter
  • 🗂️ Weight
    • 🗂️ BB2Weight
    • 🗂️ BM25PlusWeight
    • 🗂️ BM25Weight
    • 🗂️ BoolWeight
    • 🗂️ CoordWeight
    • 🗂️ DLHWeight
    • 🗂️ DPHWeight
    • 🗂️ IfB2Weight
    • 🗂️ InL2Weight
    • 🗂️ IneB2Weight
    • 🗂️ LMWeight
    • 🗂️ PL2PlusWeight
    • 🗂️ PL2Weight
    • 🗂️ TfIdfWeight
    • 🗂️ TradWeight

🔴 Error (base exception class)

All Xapian exceptions inherit from Error. Provides context and error message retrieval.

• __str__() — Return string representation.
• get_context() — Optional context information (e.g., remote server details).
• get_error_string() — System error string (from errno, h_errno, or GetLastError()).
• get_msg() — Human-readable error message.
• get_type() — Error type name (e.g., "DocNotFoundError").

Inherited from builtins.Exception: __new__, args.

Inherited from builtins.BaseException: __delattr__, __getattribute__, __reduce__, __setstate__, with_traceback, __cause__, __context__, __dict__, __suppress_context__, __traceback__.

🔴 AssertionError

Thrown when a logical assertion inside Xapian fails (debug builds). Indicates a bug in Xapian.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from LogicError → Error.

🔴 InvalidArgumentError

Thrown when an invalid argument is supplied.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from LogicError → Error.

🔴 InvalidOperationError

Thrown when an operation is attempted in an invalid context.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from LogicError → Error.

🔴 UnimplementedError

Thrown when a method is not implemented (e.g., on a remote backend).

• __init__(self, *args) — Construct from message and optional errno.

Inherits from LogicError → Error.

🔴 RuntimeError

Base class for runtime errors. All subclasses below inherit from RuntimeError → Error.

• __init__(self, *args) — Construct from message and optional errno.

🔴 DatabaseError

Base for database-related errors.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError → Error.

🔴 DatabaseClosedError

Attempt to access a closed database.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseCorruptError

Database corruption detected.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseCreateError

Failure to create a database.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseLockError

Failure to lock a database.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseModifiedError

Database was modified during a read operation. Call reopen() to recover.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseOpeningError

Failure to open a database.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseError.

🔴 DatabaseNotFoundError

Database not present at the specified path.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseOpeningError.

🔴 DatabaseVersionError

Database in an unsupported format (too old or too new).

• __init__(self, *args) — Construct from message and optional errno.

Inherits from DatabaseOpeningError.

🔴 DocNotFoundError

Requested document does not exist in the database.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 FeatureUnavailableError

Feature not available (e.g., during compaction).

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 InternalError

Internal Xapian error (should not happen).

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 NetworkError

Base for network-related errors.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 NetworkTimeoutError

Network timeout occurred.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from NetworkError.

🔴 QueryParserError

Query parsing failed.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 RangeError

Value out of range.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 SerialisationError

Error during serialisation/deserialisation.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🔴 WildcardError

Wildcard expansion error.

• __init__(self, *args) — Construct from message and optional errno.

Inherits from RuntimeError.

🗂️ Database

Provides access to a database or group of databases. Used with Enquire for searching.

Constructor: Database(*args) — Copying (reference counted) or open from path. Throws InvalidArgumentError, DatabaseOpeningError, DatabaseVersionError.

• __str__() — Description string.
• add_database(database) — Add another database to the group.
• close() — Close database and release file handles. Commits if WritableDatabase.
• compact(fd, flags, block_size, compactor) — Compact database to file descriptor or path.
• get_average_length() — Average document length (alias for get_avlength()).
• get_avlength() — Average document length.
• get_collection_freq(tname) — Total occurrences of term across all documents.
• get_doccount() — Number of documents.
• get_doclength(did) — Length of a specific document.
• get_doclength_lower_bound() — Lower bound on document length (excludes zero-length).
• get_doclength_upper_bound() — Upper bound on document length.
• get_document(did, flags=0) — Retrieve document by ID.
• get_lastdocid() — Highest document ID used.
• get_metadata(key) — User-specified metadata value.
• get_revision() — Database revision number (chert/glass only).
• get_spelling_suggestion(word, max_edit_distance=2) — Suggest a spelling correction.
• get_termfreq(tname) — Number of documents indexed by term.
• get_total_length() — Sum of all document lengths.
• get_unique_terms(did) — Number of unique terms in document.
• get_uuid() — Database UUID.
• get_value_freq(slot) — Number of documents with a non-empty value in slot.
• get_value_lower_bound(slot) — Lower bound of values in slot.
• get_value_upper_bound(slot) — Upper bound of values in slot.
• get_wdf_upper_bound(term) — Upper bound on wdf for term.
• has_positions() — Whether the database has positional information.
• keep_alive() — Send keep-alive to remote databases.
• locked() — Test if database is locked for writing.
• metadata_keys(prefix='') — Iterator over metadata keys.
• positionlist(docid, tname) — Iterator over term positions in document.
• postlist(tname) — Iterator over postings for a term.
• reopen() — Reopen to latest version.
• size() — Number of shards.
• spellings() — Iterator over spelling correction targets.
• synonym_keys(prefix='') — Iterator over terms with synonyms.
• synonyms(term) — Iterator over synonyms for a term.
• term_exists(tname) — Check if term exists.
• termlist(docid) — Iterator over terms indexing a document.
• valuestream(slot) — Iterator over values in a slot.
• static check() — Check database.

🗂️ WritableDatabase (extends Database)

Adds write operations: indexing, updating, deleting documents.

• add_document(document) — Add a document, return new docid.
• delete_document(did) — Delete by docid.
• delete_document(term) — Delete documents matching a unique term.
• replace_document(did, document) — Replace or add document.
• commit() — Commit changes.
• set_metadata(key, value) — Set user metadata.
• add_spelling(word, freqinc=1) — Add spelling correction.
• remove_spelling(word, freqdec=1) — Remove spelling correction.
• add_synonym(term, synonym) — Add synonym.
• remove_synonym(term, synonym) — Remove synonym.
• clear_synonyms(term) — Clear all synonyms for term.
• Inherits all methods from Database.

🗂️ Compactor

Utility to compact or merge databases. Deprecated in favor of Database::compact().

• add_source(srcdir) — Add source database path.
• compact() — Perform compaction.
• resolve_duplicate_metadata(key, num_tags, tags) — Merge duplicate metadata keys.
• set_block_size(block_size) — Set block size (2048–65536, power of 2).
• set_compaction_level(level) — STANDARD (0), FULL (1), FULLER (2).
• set_destdir(destdir) — Output directory.
• set_multipass(multipass) — Enable multipass merging.
• set_renumber(renumber) — Preserve docids if false.
• set_status(table, status) — Progress callback.

Class constants: STANDARD=0, FULL=1, FULLER=2.

🗂️ Document

Represents a document in the database.

• get_data() — Document data.
• set_data(data) — Set document data.
• add_term(term, wdfinc=1) — Add a term.
• add_posting(term, position, wdfinc=1) — Add term at position.
• add_boolean_term(term) — Add boolean term.
• remove_term(term) — Remove term.
• remove_posting(term, position, wdfdec=1) — Remove posting.
• clear_terms() — Clear all terms.
• get_value(slot) — Get value.
• add_value(slot, value) — Set value.
• remove_value(slot) — Remove value.
• clear_values() — Clear all values.
• get_docid() — Return docid (only valid after being added to DB).
• termlist() — Iterator over terms.
• values() — Iterator over values.

🗂️ Enquire

Performs searches on a database.

• set_query(query, qlen=0) — Set query.
• get_query() — Get current query.
• set_weighting_scheme(weight) — Set weighting scheme.
• set_collapse_key(slot, collapse_max=1) — Collapse results by value.
• set_docid_order(order) — Set docid ordering.
• set_cutoff(percent, weight) — Set cutoff.
• set_sort_by_relevance() — Sort by relevance only.
• set_sort_by_value(slot, reverse) — Sort by value.
• set_sort_by_relevance_then_value(slot, reverse) — Primary relevance, then value.
• set_sort_by_value_then_relevance(slot, reverse) — Primary value, then relevance.
• get_mset(first, maxitems, checkatleast, rset, mdecider) — Execute search and return MSet.
• get_eset(maxitems, rset, eflags, k, edecider) — Expand query from relevance set.
• get_matching_terms_begin(did) — Iterator for matching terms.
• get_matching_terms_end(did) — End iterator.

🗂️ MSet

Result set from a search.

• get_matches_lower_bound(), get_matches_estimated(), get_matches_upper_bound() — Result statistics.
• get_max_possible() — Maximum possible weight.
• get_firstitem() — First item index.
• get_docid(i) — Docid of item i.
• get_document(i) — Document object.
• get_weight(i) — Weight of item i.
• get_collapse_key(i) — Collapse key.
• get_collapse_count(i) — Number of collapsed entries.
• get_percent(i) — Relevance percentage.
• size() — Number of items.
• empty() — True if empty.
• back(), front() — First/last items.
• begin(), end() — Iterators over MSetItem.
• convert_to_percent(weight) — Convert weight to percentage.
• get_termfreq(tname) — Term frequency.
• get_termweight(tname) — Term weight.
• reorder(decider) — Reorder results.
• snippet(text, len, qp, flags) — Generate snippet.

🗂️ MSetItem

Represents a single result in an MSet.

• docid — Document ID.
• weight — Weight.
• rank — Rank.
• collapse_key — Collapse key.
• collapse_count — Count of collapsed.
• get_document() — Retrieve Document.

🗂️ ESet

Result set from query expansion.

• get_ebound(), get_esize() — Size info.
• begin(), end() — Iterators over ESetItem.
• size(), empty().

🗂️ ESetItem

• term — Term string.
• weight — Weight.

🗂️ RSet

Relevance set for query expansion.

• add_document(did), remove_document(did), contains(did), size(), empty().
• begin(), end() — Iterators over docids.

🗂️ Query

Represents a query. Can be built from operators and subqueries.

• get_length() — Number of subqueries.
• get_type() — Query type (e.g., OP_AND, OP_OR).
• get_terms() — Iterator over terms (if leaf).
• serialise() — Serialize to string.
• static unserialise(string, registry) — Deserialize.
• Constructors: Query(term), Query(op, subqueries), Query(op, field, value), etc.

🗂️ QueryParser

Parses a human-readable query string into a Query object.

• set_default_op(op) — Set default operator.
• set_database(db) — Set database for spelling/prefixes.
• set_stemmer(stemmer) — Set stemmer.
• set_stemming_strategy(strategy) — Set stemming strategy.
• set_stopper(stopper) — Set stopper.
• set_max_expansion(max_expansion, max_type, flags) — Set wildcard expansion.
• add_prefix(prefix, field) — Map field prefix.
• add_boolean_prefix(prefix, field) — Boolean prefix.
• add_rangeprocessor(rp) — Add range processor.
• add_valuerangeprocessor(vrp) — Add value range processor.
• parse_query(qs, flags) — Parse query string.
• parse_query_with_prefix(qs, flags, prefix) — Parse with prefix.
• get_corrected_query_string() — Spelling-corrected query.
• get_terms() — Terms from parsed query.
• get_description() — Description.

🗂️ Stem

Stemming algorithm.

• Stem(language) — Constructor (e.g., "english").
• stem_word(word) — Stem a word.
• get_description().
• static get_available_languages() — List of supported languages.
• static get_description().

🗂️ Stopper (abstract)

Base class for stop word lists.

• operator()(word) — Return true if word should be stopped.

🗂️ SimpleStopper

Simple stop word list.

• add(word) — Add a stop word.
• remove(word) — Remove a stop word.
• begin(), end() — Iterate over stop words.

🗂️ TermGenerator

Converts text into terms.

• set_document(doc) — Set document to index.
• set_stemmer(stemmer).
• set_stopper(stopper).
• set_stemming_strategy(strategy).
• index_text(text, wdfinc, prefix) — Index text with positional information.
• index_text_without_positions(text, wdfinc, prefix) — Index without positions.
• increase_termpos(delta) — Adjust term position.
• get_termpos() — Current term position.
• set_termpos(pos).
• get_description().

🗂️ ValueRangeProcessor (abstract)

Base for range processors.

• __call__(begin, end) — Process range, return Query.
• release() — Hand ownership to Xapian.

🗂️ StringValueRangeProcessor

Range processor for string values.

• StringValueRangeProcessor(slot, str, prefix=True) — Constructor.
• __call__(begin, end) — Process range.

🗂️ DateValueRangeProcessor (deprecated, use DateRangeProcessor)

• DateValueRangeProcessor(slot, str, prefix=True, prefer_mdy=False, epoch_year=1970).

🗂️ NumberValueRangeProcessor (deprecated, use NumberRangeProcessor)

• NumberValueRangeProcessor(slot, str, prefix=True).

🗂️ RangeProcessor (abstract)

Base for range processors (new API).

• __call__(begin, end) — Process range.
• check_range(begin, end) — Check prefix/suffix.
• release().

🗂️ DateRangeProcessor

• DateRangeProcessor(slot, str, flags=0, epoch_year=1970).
• __call__(begin, end).

🗂️ NumberRangeProcessor

• NumberRangeProcessor(slot, str, flags=0).
• __call__(begin, end).

🗂️ ExpandDecider (abstract)

Base for expansion deciders.

• operator()(term) — Return true if term should be used for expansion.

🗂️ ExpandDeciderAnd

Logical AND of two deciders.

• ExpandDeciderAnd(first, second).

🗂️ ExpandDeciderFilterPrefix

Filter by prefix.

• ExpandDeciderFilterPrefix(prefix).

🗂️ KeyMaker (abstract)

Base for key makers (sort keys).

• __call__(doc) — Return sort key string.

🗂️ MultiValueKeyMaker

Key from multiple value slots.

• MultiValueKeyMaker().
• add_value(slot, reverse, deflt) — Add slot.

🗂️ LatLongDistanceKeyMaker

Key from distance to a center point.

• LatLongDistanceKeyMaker(slot, centre, metric).

🗂️ LatLongCoord

Latitude/longitude coordinate.

• LatLongCoord(lat, lon).
• latitude, longitude.

🗂️ LatLongCoords

Sequence of coordinates.

• append(coord).
• begin(), end().

🗂️ LatLongMetric (abstract)

Base for distance metrics.

• pointwise_distance(a, b) — Distance between two points.

🗂️ GreatCircleMetric

Great-circle distance.

• GreatCircleMetric().

🗂️ PostingSource (abstract)

Custom source of postings.

• init(db) — Initialize for a database.
• next(min_wt) — Advance to next doc.
• skip_to(docid, min_wt) — Skip to docid.
• check(docid, min_wt) — Check if docid occurs.
• at_end() — True if past last.
• get_docid() — Current docid.
• get_weight() — Weight contribution.
• get_maxweight() — Upper bound on weight.
• clone() — Clone for multi-database.
• name(), serialise(), unserialise() — For remote.
• get_description().

🗂️ FixedWeightPostingSource

Posting source with constant weight for all documents.

• FixedWeightPostingSource(weight).

🗂️ ValuePostingSource (abstract)

Base for value-based posting sources.

• Inherits from PostingSource.
• Manages iteration over value stream.

🗂️ ValueWeightPostingSource

Weight from values in a slot (serialised with sortable_serialise()).

• ValueWeightPostingSource(slot).
• get_weight() — Returns value as double.
• name() — Returns "Xapian::ValueWeightPostingSource".
• Inherits from ValuePostingSource.

🗂️ DecreasingValueWeightPostingSource

Like ValueWeightPostingSource but for values known to decrease with docid.

• DecreasingValueWeightPostingSource(slot, range_start=0, range_end=0).
• Inherits from ValueWeightPostingSource.

🗂️ ValueMapPostingSource

Map values to weights via a mapping function.

• ValueMapPostingSource(slot).
• add_mapping(value, weight) — Add mapping.
• set_default_weight(weight).
• Inherits from ValuePostingSource.

🗂️ LatLongDistancePostingSource

Weight from distance to a center point.

• LatLongDistancePostingSource(slot, centre, metric).
• Inherits from ValuePostingSource.

🗂️ MatchDecider (abstract)

Base for match deciders (filter results).

• operator()(doc) — Return true to include document.

🗂️ ValueSetMatchDecider

Filter documents where value is in a set.

• ValueSetMatchDecider(slot, include).
• add_value(value) — Add value to set.
• remove_value(value).

🗂️ MatchSpy (abstract)

Base for match spies (collect statistics during search).

• operator()(doc, weight).
• clone().
• name().
• merge(results).

🗂️ ValueCountMatchSpy

Count occurrences of values in slots.

• ValueCountMatchSpy(slot).
• get_values() — Map of value to frequency.
• top_values(maxitems) — Top values.
• values_begin(), values_end().

🗂️ Registry

Registry for weighting schemes, posting sources, etc.

• add_weighting_scheme(weight).
• add_posting_source(source).
• add_match_spy(spy).
• add_lat_long_metric(metric).

🗂️ FieldProcessor (abstract)

Base for field processors (e.g., for query parser).

• operator()(field, value) — Return Query.

🗂️ Weight (abstract)

Base class for weighting schemes.

• name() — Return class name.
• get_sumpart(wdf, doclen, uniqterms) — Term-dependent weight.
• get_maxpart() — Upper bound on get_sumpart().
• get_sumextra(doclen, uniqterms) — Term-independent weight.
• get_maxextra() — Upper bound on get_sumextra().
• Constants: ABSOLUTE_DISCOUNT_SMOOTHING=3, DIRICHLET_PLUS_SMOOTHING=5, DIRICHLET_SMOOTHING=2, JELINEK_MERCER_SMOOTHING=4, TWO_STAGE_SMOOTHING=1.
• Subclasses: BB2Weight, BM25PlusWeight, BM25Weight, BoolWeight, CoordWeight, DLHWeight, DPHWeight, IfB2Weight, InL2Weight, IneB2Weight, LMWeight, PL2PlusWeight, PL2Weight, TfIdfWeight, TradWeight.
• Each subclass inherits all methods from Weight and may override init(), get_sumpart(), etc.

🗂️ BB2Weight

Implements the BB2 weighting scheme (Divergence from Randomness framework).

• BB2Weight() — Constructor.
• Inherits from Weight.

🗂️ BM25PlusWeight

BM25+ (BM25 with a lower bound).

• BM25PlusWeight() — Constructor.
• Inherits from Weight.

🗂️ BM25Weight

Standard BM25 weighting.

• BM25Weight(k1, k2, k3, b, min_normlen) — Constructor with parameters.
• Inherits from Weight.

🗂️ BoolWeight

Boolean weighting (all documents weight zero).

• BoolWeight() — Constructor.
• Overrides init().
• Inherits from Weight.

🗂️ CoordWeight

Coordinate Matching: each matching term scores one point.

• CoordWeight() — Constructor.
• Overrides init().
• Inherits from Weight.

🗂️ DLHWeight

DLH weighting scheme (parameter-free DFR).

• DLHWeight() — Constructor.
• Inherits from Weight.

🗂️ DPHWeight

DPH weighting scheme (parameter-free DFR).

• DPHWeight() — Constructor.
• Inherits from Weight.

🗂️ IfB2Weight

IfB2 weighting scheme.

• IfB2Weight() — Constructor.
• Inherits from Weight.

🗂️ InL2Weight

InL2 weighting scheme.

• InL2Weight() — Constructor.
• Inherits from Weight.

🗂️ IneB2Weight

IneB2 weighting scheme.

• IneB2Weight() — Constructor.
• Inherits from Weight.

🗂️ LMWeight

Language Model weighting.

• LMWeight() — Constructor.
• Inherits from Weight.

🗂️ PL2PlusWeight

PL2+ weighting scheme.

• PL2PlusWeight() — Constructor.
• Inherits from Weight.

🗂️ PL2Weight

PL2 weighting scheme.

• PL2Weight() — Constructor.
• Inherits from Weight.

🗂️ TfIdfWeight

TF-IDF weighting.

• TfIdfWeight() — Constructor.
• Inherits from Weight.

🗂️ TradWeight

Traditional probabilistic weighting.

• TradWeight() — Constructor.
• Inherits from Weight.

🗂️ PostingIter

Iterator over postings.

• get_docid(), get_wdf().
• next(), skip_to(docid), check(docid).
• at_end().
• get_description().

🗂️ PostingItem

Element from a posting list.

• docid, wdf.
• positionlist() — Iterator over positions.

🗂️ PositionIter

Iterator over positions.

• get_position(), next(), at_end().

🗂️ TermIter

Iterator over terms.

• get_term(), get_wdf(), get_termfreq().
• next(), skip_to(term), at_end().
• positionlist().

🗂️ TermListItem

Element from a term list.

• term, wdf, termfreq.

🗂️ ValueIter

Iterator over values.

• get_value(), get_docid().
• next(), skip_to(docid), check(docid).
• at_end().

🗂️ ValueItem

Element from a value stream.

• docid, value.

🗂️ ValueStreamItem

Element from a value stream (similar to ValueItem).

• docid, value.

🗂️ ValueStreamIter

Iterator over value stream (ordered by docid).

• next(), skip_to(docid), check(docid), at_end().
• get_docid(), get_value().

🗂️ ESetIter

Iterator over ESet.

• get_term(), get_weight().
• next(), at_end().

🗂️ LatLongCoordsIter

Iterator over LatLongCoords.

• get_coord() — Returns LatLongCoord.
• next(), at_end().

🗂️ MSetIter

Iterator over MSet.

• get_docid(), get_weight(), get_percent(), get_document().
• next(), at_end().

🗂️ TermGenerator (already covered)

See above.

🗂️ Stem (already covered)

See above.

🗂️ StemImplementation (abstract)

Interface for custom stemmers.

• operator()(word) — Return stemmed form.
• get_description().

🗂️ FieldProcessor (abstract, already covered)

See above.

🗂️ KeyMaker (abstract, already covered)

See above.

🏛️ CLASSES

🗂️ ValuePostingSource

ValuePostingSource is a base class for posting sources which read values from a document.

This class provides a default implementation which can be used to make it easy to write a PostingSource which looks at values in a document. It provides an implementation of many of the PostingSource methods based on a value stream.

You only need to subclass this if you want to implement a PostingSource which returns a subset of the documents in the database - for example, to return documents within a certain geographical region.

Subclasses should implement the next(), skip_to() and check() methods, and should also call the set_termfreq_*() methods to set the term frequency bounds.

This class was added in Xapian 1.2.23 and 1.3.5.

🔧 Methods defined here:

• __init__(self, slot_) — Construct a ValuePostingSource.

void Xapian::ValuePostingSource::ValuePostingSource(Xapian::valueno slot_)

Parameters:

• slot_: 📍 The value slot to read the values from.

• __repr__ = _swig_repr(self)
• at_end = ValuePostingSource_at_end(...) — Return true if the current position is past the last entry in this list.

virtual bool Xapian::ValuePostingSource::at_end() const =0

At least one of next(), skip_to() or check() will be called before this method is first called.

• check = ValuePostingSource_check(...) — Check if the specified docid occurs.

virtual bool Xapian::ValuePostingSource::check(Xapian::docid did, double min_wt)

If it does, it must move to that document id, and return true. If it does not, it may either:

• 🗨️ return true, having moved to a definite position (including "at_end"), which must be the same position as skip_to() would have moved to.
• 🗨️ or return false, having moved to an "indeterminate" position, such that a subsequent call to next() or skip_to() will move to the next matching position after did.

Generally, this method should act like skip_to() and return true if that can be done at little extra cost. Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't.

The default implementation calls skip_to() and always returns true.

Xapian will always call init() on a PostingSource before calling this for the first time.

Note: In the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.

Parameters:

• did: 📄 The document id to check.
• min_wt: ⚖️ The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

• done = ValuePostingSource_done(...) — End the iteration.

void Xapian::ValuePostingSource::done()

Calls to at_end() will return true after calling this method.

Added in 1.2.23 and 1.3.5.

• get_database = ValuePostingSource_get_database(...) — The database we're reading values from.

Xapian::Database Xapian::ValuePostingSource::get_database() const

Added in 1.2.23 and 1.3.5.

• get_docid = ValuePostingSource_get_docid(...) — Return the current docid.

Xapian::docid Xapian::ValuePostingSource::get_docid() const

This method may assume that it will only be called when there is a "current document". See get_weight() for details.

Note: In the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the init() method for details.

• get_slot = ValuePostingSource_get_slot(...) — The slot we're reading values from.

Xapian::valueno Xapian::ValuePostingSource::get_slot() const

Added in 1.2.23 and 1.3.5.

• get_started = ValuePostingSource_get_started(...) — Flag indicating if we've started (true if we have).

bool Xapian::ValuePostingSource::get_started() const

Added in 1.2.23 and 1.3.5.

• get_termfreq_est = ValuePostingSource_get_termfreq_est(...) — An estimate of the number of documents this object can return.

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_est() const

It must always be true that: get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()

Xapian will always call init() on a PostingSource before calling this for the first time.

• get_termfreq_max = ValuePostingSource_get_termfreq_max(...) — An upper bound on the number of documents this object can return.

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_max() const

Xapian will always call init() on a PostingSource before calling this for the first time.

• get_termfreq_min = ValuePostingSource_get_termfreq_min(...) — A lower bound on the number of documents this object can return.

Xapian::doccount Xapian::ValuePostingSource::get_termfreq_min() const

Xapian will always call init() on a PostingSource before calling this for the first time.

• get_value = ValuePostingSource_get_value(...) — Read current value.

std::string Xapian::ValuePostingSource::get_value() const

Added in 1.2.23 and 1.3.5.

• set_termfreq_est = ValuePostingSource_set_termfreq_est(...) — An estimate of the term frequency.

void Xapian::ValuePostingSource::set_termfreq_est(Xapian::doccount termfreq_est_)

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Added in 1.2.23 and 1.3.5.

• set_termfreq_max = ValuePostingSource_set_termfreq_max(...) — An upper bound on the term frequency.

void Xapian::ValuePostingSource::set_termfreq_max(Xapian::doccount termfreq_max_)

Subclasses should set this if they are overriding the next(), skip_to() or check() methods.

Added in 1.2.23 and 1.3.5.

• set_termfreq_min = ValuePostingSource_set_termfreq_min(...) — Set a lower bound on the term frequency.

void Xapian::ValuePostingSource::set_termfreq_min(Xapian::doccount termfreq_min_)

Subclasses should set this if they are overriding the next(), skip_to() or check() methods to return fewer documents.

Added in 1.2.23 and 1.3.5.

• skip_to = ValuePostingSource_skip_to(...) — Advance to the specified docid.

void Xapian::ValuePostingSource::skip_to(Xapian::docid min_docid, double min_wt)

If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present).

If the current position is already the specified docid, this method will leave the position unmodified.

If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid.

The default implementation calls next() repeatedly, which works but skip_to() can often be implemented much more efficiently.

Xapian will always call init() on a PostingSource before calling this for the first time.

Note: In the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.

Parameters:

• did: 📄 The document id to advance to.
• min_wt: ⚖️ The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

📋 Methods inherited from PostingSource:

• get_maxweight = PostingSource_get_maxweight(...) — Return the currently set upper bound on what get_weight() can return.

double Xapian::PostingSource::get_maxweight() const

• release = PostingSource_release(...) — Start reference counting this object.

const PostingSource* Xapian::PostingSource::release() const

You can hand ownership of a dynamically allocated PostingSource object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

• set_maxweight = PostingSource_set_maxweight(...) — Specify an upper bound on what get_weight() will return from now on.

void Xapian::PostingSource::set_maxweight(double max_weight)

This upper bound is used by the matcher to perform various optimisations, so if you can return a good bound, then matches will generally run faster.

This method should be called after calling init(), and may be called during iteration if the upper bound drops. It is probably only useful to call from subclasses (it was actually a "protected" method prior to Xapian 1.3.4, but that makes it tricky to wrap for other languages).

It is valid for the posting source to have returned a higher value from get_weight() earlier in the iteration, but the posting source must not return a higher value from get_weight() than the currently set upper bound, and the upper bound must not be increased (until init() has been called).

If you don't call this method, the upper bound will default to 0, for convenience when implementing "weight-less" PostingSource subclasses.

Parameters:

• max_weight: 🔝 The upper bound to set.

📦 Data descriptors inherited from PostingSource:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

❌ DocNotFoundError

Indicates an attempt to access a document not present in the database.

Method resolution order: DocNotFoundError → RuntimeError → Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.

Xapian::DocNotFoundError::DocNotFoundError(const std::string &msg_, int errno_)

Parameters:

• msg_: 📝 Message giving details of the error, intended for human consumption.
• errno_: 🔢 Optional errno value associated with this error.

• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_DocNotFoundError(...)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.

const std::string& Xapian::Error::get_context() const

This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.

• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.

const char* Xapian::Error::get_error_string() const

The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.

• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.

const std::string& Xapian::Error::get_msg() const

• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)

const char* Xapian::Error::get_type() const

📦 Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

📋 Methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

📋 Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

📦 Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📄 Document

A handle representing a document in a Xapian database.

The Document class fetches information from the database lazily. Usually this behaviour isn't visible to users (except for the speed benefits), but if the document in the database is modified or deleted, then preexisting Document objects may return the old or new versions of data (or throw Xapian::DocNotFoundError in the case of deletion).

Since Database objects work on a snapshot of the database's state, the situation above can only happen with a WritableDatabase object, or if you call Database::reopen() on a Database object.

We recommend you avoid designs where this behaviour is an issue, but if you need a way to make a non-lazy version of a Document object, you can do this like so: doc = Xapian::Document::unserialise(doc.serialise());

🔧 Methods defined here:

• __init__(self) — Make a new empty Document.

Xapian::Document::Document()

• __iter__ = _document_gen_termlist_iter(self) — Get an iterator over all the terms in a document.

The iterator will return TermListItem objects.

Access to term frequency and position information is only available until the iterator has moved on.

Note that term frequency information is only meaningful for a document retrieved from a database. If term frequency information is requested for a document which was freshly created, an InvalidOperationError will be raised.

• __repr__ = _swig_repr(self)
• __str__ = Document___str__(...) — Return a string describing this object.

std::string Xapian::Document::get_description() const

• add_boolean_term = Document_add_boolean_term(...) — Add a boolean filter term to the document.

void Xapian::Document::add_boolean_term(const std::string &term)

This method adds term to the document with wdf of 0 - this is generally what you want for a term used for boolean filtering as the wdf of such terms is ignored, and it doesn't make sense for them to contribute to the document's length.

If the specified term already indexes this document, this method has no effect.

It is exactly the same as add_term(term, 0).

This method was added in Xapian 1.0.18.

Parameters:

• term: 🔤 The term to add.

• add_posting = Document_add_posting(...) — Add an occurrence of a term at a particular position.

void Xapian::Document::add_posting(const std::string &tname, Xapian::termpos tpos, Xapian::termcount wdfinc=1)

Multiple occurrences of the term at the same position are represented only once in the positional information, but do increase the wdf.

If the term is not already in the document, it will be added to it.

Parameters:

• tname: 🔤 The name of the term.
• tpos: 📍 The position of the term.
• wdfinc: 📈 The increment that will be applied to the wdf for this term.

• add_term = Document_add_term(...) — Add a term to the document, without positional information.

void Xapian::Document::add_term(const std::string &tname, Xapian::termcount wdfinc=1)

Any existing positional information for the term will be left unmodified.

Parameters:

• tname: 🔤 The name of the term.
• wdfinc: 📈 The increment that will be applied to the wdf for this term (default: 1).

• add_value = Document_add_value(...) — Add a new value.

void Xapian::Document::add_value(Xapian::valueno slot, const std::string &value)

The new value will replace any existing value with the same number (or if the new value is empty, it will remove any existing value with the same number).

Parameters:

• slot: 🗂️ The value slot to add the value in.
• value: 📝 The value to set.

• clear_terms = Document_clear_terms(...) — Remove all terms (and postings) from the document.

void Xapian::Document::clear_terms()

• clear_values = Document_clear_values(...) — Remove all values associated with the document.

void Xapian::Document::clear_values()

• get_data = Document_get_data(...) — Get data stored in the document.

std::string Xapian::Document::get_data() const

This is potentially a relatively expensive operation, and shouldn't normally be used during the match (e.g. in a PostingSource or match decider functor). Put data for use by match deciders in a value instead.

• get_docid = Document_get_docid(...) — Get the document id which is associated with this document (if any).

docid Xapian::Document::get_docid() const

NB If multiple databases are being searched together, then this will be the document id in the individual database, not the merged database!

If this document came from a database, return the document id in that database. Otherwise, return 0 (in Xapian 1.0.22/1.2.4 or later; prior to this the returned value was uninitialised).

• get_value = Document_get_value(...) — Get value by number.

std::string Xapian::Document::get_value(Xapian::valueno slot) const

Returns an empty string if no value with the given number is present in the document.

Parameters:

• slot: 🗂️ The number of the value.

• remove_posting = Document_remove_posting(...) — Remove a posting of a term from the document.

void Xapian::Document::remove_posting(const std::string &tname, Xapian::termpos tpos, Xapian::termcount wdfdec=1)

Note that the term will still index the document even if all occurrences are removed. To remove a term from a document completely, use remove_term().

Parameters:

• tname: 🔤 The name of the term.
• tpos: 📍 The position of the term.
• wdfdec: 📉 The decrement that will be applied to the wdf when removing this posting. The wdf will not go below the value of 0.

Throws:

• Xapian::InvalidArgumentError: if the term is not at the position specified in the position list for this term in this document.
• Xapian::InvalidArgumentError: if the term is not in the document.

• remove_postings = Document_remove_postings(...) — Remove a range of postings for a term.

Xapian::termpos Xapian::Document::remove_postings(const std::string &term, Xapian::termpos term_pos_first, Xapian::termpos term_pos_last, Xapian::termcount wdf_dec=1)

Any instances of the term at positions >= term_pos_first and <= term_pos_last will be removed, and the wdf reduced by wdf_dec for each instance removed (the wdf will not ever go below zero though).

It's OK if the term doesn't occur in the range of positions specified (unlike remove_posting()). And if term_pos_first > term_pos_last, this method does nothing.

The number of postings removed.

Throws:

• Xapian::InvalidArgumentError: if the term is not in the document.

Added in Xapian 1.4.8.

• remove_term = Document_remove_term(...) — Remove a term and all postings associated with it.

void Xapian::Document::remove_term(const std::string &tname)

Parameters:

• tname: 🔤 The name of the term.

Throws:

• Xapian::InvalidArgumentError: if the term is not in the document.

• remove_value = Document_remove_value(...) — Remove any value with the given number.

void Xapian::Document::remove_value(Xapian::valueno slot)

• serialise = Document_serialise(...) — Serialise document into a string.

std::string Xapian::Document::serialise() const

The document representation may change between Xapian releases: even between minor versions. However, it is guaranteed not to change if the remote database protocol has not changed between releases.

• set_data = Document_set_data(...) — Set data stored in the document.

void Xapian::Document::set_data(const std::string &data)

Xapian treats the data as an opaque blob. It may try to compress it, but other than that it will just store it and return it when requested.

Parameters:

• data: 📝 The data to store.

• termlist = _document_gen_termlist_iter(self) — Get an iterator over all the terms in a document.

The iterator will return TermListItem objects.

Access to term frequency and position information is only available until the iterator has moved on.

Note that term frequency information is only meaningful for a document retrieved from a database. If term frequency information is requested for a document which was freshly created, an InvalidOperationError will be raised.

• termlist_count = Document_termlist_count(...) — The length of the termlist - i.e.

Xapian::termcount Xapian::Document::termlist_count() const

the number of different terms which index this document.

• values = _document_gen_values_iter(self) — Get an iterator over all the values stored in a document.

The iterator will return ValueItem objects, in ascending order of value number.

• values_count = Document_values_count(...) — Count the values in this document.

Xapian::termcount Xapian::Document::values_count() const

🔧 Static methods defined here:

• __swig_destroy__ = delete_Document(...) — Destructor.

Xapian::Document::~Document()

• unserialise = Document_unserialise(...)

📦 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📊 ESet

Class representing a list of search results (expand set).

🔧 Methods defined here:

• __init__(self) — Default constructor.

Xapian::ESet::ESet()

Creates an empty ESet, mostly useful as a placeholder.

• __iter__ = _eset_gen_iter(self) — Return an iterator over the ESet.

The iterator will return ESetItem objects.

• __len__ lambda self
• __repr__ = _swig_repr(self)
• __str__ = ESet___str__(...) — Return a string describing this object.

std::string Xapian::ESet::get_description() const

• back = ESet_back(...) — Return iterator pointing to the last object in this ESet.

ESetIterator Xapian::ESet::back() const

• empty = ESet_empty(...) — Return true if this ESet object is empty.

bool Xapian::ESet::empty() const

• get_ebound = ESet_get_ebound(...) — Return a bound on the full size of this ESet object.

Xapian::termcount Xapian::ESet::get_ebound() const

This is a bound on size() if get_eset() had been called with maxitems set high enough that all results were returned.

• size = ESet_size(...) — Return number of items in this ESet object.

Xapian::doccount Xapian::ESet::size() const

🔧 Static methods defined here:

• __swig_destroy__ = delete_ESet(...) — Destructor.

Xapian::ESet::~ESet()

📦 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📈 ESetItem

An item returned from iteration of the ESet.

The item supports access to the following attributes:

• term: 🔤 The term corresponding to this ESet item.
• weight: ⚖️ The weight corresponding to this ESet item.

🔧 Methods defined here:

• __init__(self, iter) — Initialize self. See help(type(self)) for accurate signature.

📦 Data descriptors defined here:

• term
• weight

---

🔁 ESetIter

An iterator over the items in an ESet.

The iterator will return ESetItem objects.

🔧 Methods defined here:

• __init__(self, eset) — Initialize self. See help(type(self)) for accurate signature.
• __iter__(self)
• __next__(self)

---

🔍 Enquire

This class provides an interface to the information retrieval system for the purpose of searching.

Databases are usually opened lazily, so exceptions may not be thrown where you would expect them to be. You should catch Xapian::Error exceptions when calling any method in Xapian::Enquire.

Throws:

• Xapian::InvalidArgumentError: if an invalid argument is supplied, for example, an unknown database type.

🔧 Methods defined here:

• __init__(self, database) — Create a Xapian::Enquire object.

Xapian::Enquire::Enquire(const Database &database, ErrorHandler *errorhandler_)

This specification cannot be changed once the Xapian::Enquire is opened: you must create a new Xapian::Enquire object to access a different database, or set of databases.

The database supplied must have been initialised (ie, must not be the result of calling the Database::Database() constructor). If you need to handle a situation where you have no databases gracefully, a database created with DB_BACKEND_INMEMORY can be passed here to provide a completely empty database.

Parameters:

• database: 🗄️ Specification of the database or databases to use.
• errorhandler_: ⚠️ This parameter is deprecated (since Xapian 1.3.1), and as of 1.3.5 it's ignored completely.

Throws:

• Xapian::InvalidArgumentError: if an empty Database object is supplied.

• __repr__ = _swig_repr(self)
• __str__ = Enquire___str__(...) — Return a string describing this object.

std::string Xapian::Enquire::get_description() const

• add_matchspy = _enquire_match_spy_add(self, decider) — Add a matchspy.

void Xapian::Enquire::add_matchspy(MatchSpy *spy)

This matchspy will be called with some of the documents which match the query, during the match process. Exactly which of the matching documents are passed to it depends on exactly when certain optimisations occur during the match process, but it can be controlled to some extent by setting the checkatleast parameter to get_mset().

In particular, if there are enough matching documents, at least the number specified by checkatleast will be passed to the matchspy. This means that you can force the matchspy to be shown all matching documents by setting checkatleast to the number of documents in the database.

Parameters:

• spy: 🕵️ The MatchSpy subclass to add. The caller must ensure that this remains valid while the Enquire object remains active, or until clear_matchspies() is called.

• clear_matchspies = _enquire_match_spies_clear(self) — Remove all the matchspies.

void Xapian::Enquire::clear_matchspies()

• get_eset = Enquire_get_eset(...) — Get the expand set for the given rset.

ESet Xapian::Enquire::get_eset(Xapian::termcount maxitems, const RSet &rset, int flags, double k, const Xapian::ExpandDecider *edecider=NULL, double min_wt=0.0) const

Parameters:

• maxitems: 🔢 the maximum number of items to return.
• rset: 📊 the relevance set to use when performing the expand operation.
• flags: 🏳️ zero or more of these values |-ed together: Xapian::Enquire::INCLUDE_QUERY_TERMS query terms may be returned from expand; Xapian::Enquire::USE_EXACT_TERMFREQ for multi dbs, calculate the exact termfreq; otherwise an approximation is used.
• k: ⚙️ the parameter k in the query expansion algorithm (default is 1.0)
• edecider: 🧪 a decision functor to use to decide whether a given term should be put in the ESet.
• min_wt: ⚖️ the minimum weight for included terms.

Returns an ESet object containing the results of the expand.

Throws:

• Xapian::InvalidArgumentError: See class documentation.

• get_mset = Enquire_get_mset(...) — Get (a portion of) the match set for the current query.

MSet Xapian::Enquire::get_mset(Xapian::doccount first, Xapian::doccount maxitems, const RSet *omrset, const MatchDecider *mdecider=0) const

Parameters:

• first: 🔢 the first item in the result set to return. A value of zero corresponds to the first item returned being that with the highest score. A value of 10 corresponds to the first 10 items being ignored.
• maxitems: 🔢 the maximum number of items to return. If you want all matches, then you can pass the result of calling get_doccount() on the Database object. You can pass 0 for maxitems which will give you an empty MSet with valid statistics calculated quickly.
• omrset: 📊 the relevance set to use when performing the query.
• mdecider: 🧪 a decision functor to use to decide whether a given document should be put in the MSet.

Returns a Xapian::MSet object containing the results of the query.

Throws:

• Xapian::InvalidArgumentError: See class documentation.

• get_query = _enquire_get_query(self) — Get the current query.

const Xapian::Query& Xapian::Enquire::get_query() const

If called before set_query(), this will return a default initialised Query object.

• matching_terms = _enquire_gen_iter(self, which) — Get an iterator over the terms which match a given match set item.

The match set item to consider is specified by the which parameter, which may be a document ID, or an MSetItem object.

The iterator will return string objects.

• set_collapse_key = Enquire_set_collapse_key(...) — Set the collapse key to use for queries.

void Xapian::Enquire::set_collapse_key(Xapian::valueno collapse_key, Xapian::doccount collapse_max=1)

Parameters:

• collapse_key: 🗂️ value number to collapse on - at most one MSet entry with each particular value will be returned (default is Xapian::BAD_VALUENO which means no collapsing).
• collapse_max: 🔢 Max number of items with the same key to leave after collapsing (default 1).

The MSet returned by get_mset() will have only the "best" (at most) collapse_max entries with each particular value of collapse_key ("best" being highest ranked - i.e. highest weight or highest sorting key).

An example use might be to create a value for each document containing an MD5 hash of the document contents. Then duplicate documents from different sources can be eliminated at search time by collapsing with collapse_max = 1.

Another use is to group matches in a particular category (e.g. you might collapse a mailing list search on the Subject: so that there's only one result per discussion thread).

• set_cutoff = Enquire_set_cutoff(...) — Set the percentage and/or weight cutoffs.

void Xapian::Enquire::set_cutoff(int percent_cutoff, double weight_cutoff=0)

Parameters:

• percent_cutoff: 📊 Minimum percentage score for returned documents. If a document has a lower percentage score than this, it will not appear in the MSet. (default 0 => no percentage cut-off).
• weight_cutoff: ⚖️ Minimum weight for a document to be returned. (default 0 => no weight cut-off).

• set_docid_order = Enquire_set_docid_order(...) — Set sort order for document IDs.

void Xapian::Enquire::set_docid_order(docid_order order)

This order only has an effect on documents which would otherwise have equal rank. When ordering by relevance without a sort key, this means documents with equal weight. For a boolean match with no sort key, this means all documents.

Parameters:

• order: 🔢 This can be: Xapian::Enquire::ASCENDING docids sort in ascending order (default); Xapian::Enquire::DESCENDING docids sort in descending order; Xapian::Enquire::DONT_CARE docids sort in whatever order is most efficient for the backend.

• set_expansion_scheme = Enquire_set_expansion_scheme(...) — Set the weighting scheme to use for expansion.

void Xapian::Enquire::set_expansion_scheme(const std::string &eweightname_, double expand_k_=1.0) const

If you don't call this method, the default is as if you'd used: get_expansion_scheme("trad");

Parameters:

• eweightname_: 🔤 A string in lowercase specifying the name of the scheme to be used. The following schemes are currently available: "bo1" : The Bo1 scheme for query expansion; "trad" : The TradWeight scheme for query expansion.
• expand_k_: ⚙️ The parameter required for TradWeight query expansion. A default value of 1.0 is used if none is specified.

• set_query = _enquire_set_query(self, query, qlen=0) — Set the query to run.

void Xapian::Enquire::set_query(const Xapian::Query &query, Xapian::termcount qlen=0)

Parameters:

• query: 🔍 the new query to run.
• qlen: 🔢 the query length to use in weight calculations - by default the sum of the wqf of all terms is used.

• set_sort_by_key = _enquire_set_sort_by_key(self, sorter, reverse) — Set the sorting to be by key generated from values only.

void Xapian::Enquire::set_sort_by_key(Xapian::KeyMaker *sorter, bool reverse)

Parameters:

• sorter: 🧪 The functor to use for generating keys.
• reverse: 🔄 If true, reverses the sort order.

• set_sort_by_key_then_relevance = _enquire_set_sort_by_key_then_relevance(self, sorter, reverse) — Set the sorting to be by keys generated from values, then by relevance for documents with identical keys.

void Xapian::Enquire::set_sort_by_key_then_relevance(Xapian::KeyMaker *sorter, bool reverse)

Parameters:

• sorter: 🧪 The functor to use for generating keys.
• reverse: 🔄 If true, reverses the sort order.

• set_sort_by_relevance = Enquire_set_sort_by_relevance(...) — Set the sorting to be by relevance only.

void Xapian::Enquire::set_sort_by_relevance()

This is the default.

• set_sort_by_relevance_then_key = _enquire_set_sort_by_relevance_then_key(self, sorter, reverse) — Set the sorting to be by relevance, then by keys generated from values.

void Xapian::Enquire::set_sort_by_relevance_then_key(Xapian::KeyMaker *sorter, bool reverse)

Parameters:

• sorter: 🧪 The functor to use for generating keys.
• reverse: 🔄 If true, reverses the sort order of the generated keys.

• set_sort_by_relevance_then_value = Enquire_set_sort_by_relevance_then_value(...) — Set the sorting to be by relevance then value.

void Xapian::Enquire::set_sort_by_relevance_then_value(Xapian::valueno sort_key, bool reverse)

Parameters:

• sort_key: 🗂️ value number to sort on.
• reverse: 🔄 If true, reverses the sort order of sort_key.

• set_sort_by_value = Enquire_set_sort_by_value(...) — Set the sorting to be by value only.

void Xapian::Enquire::set_sort_by_value(Xapian::valueno sort_key, bool reverse)

Parameters:

• sort_key: 🗂️ value number to sort on.
• reverse: 🔄 If true, reverses the sort order.

• set_sort_by_value_then_relevance = Enquire_set_sort_by_value_then_relevance(...) — Set the sorting to be by value, then by relevance for documents with the same value.

void Xapian::Enquire::set_sort_by_value_then_relevance(Xapian::valueno sort_key, bool reverse)

Parameters:

• sort_key: 🗂️ value number to sort on.
• reverse: 🔄 If true, reverses the sort order.

• set_time_limit = Enquire_set_time_limit(...) — Set a time limit for the match.

void Xapian::Enquire::set_time_limit(double time_limit)

Matches with check_at_least set high can take a long time in some cases. You can set a time limit on this, after which check_at_least will be turned off.

Parameters:

• time_limit: ⏱️ time in seconds after which to disable check_at_least (default: 0.0 which means no time limit).

Limitations: This feature is currently supported on platforms which support POSIX interval timers. Interaction with the remote backend when using multiple databases may have bugs.

• set_weighting_scheme = Enquire_set_weighting_scheme(...) — Set the weighting scheme to use for queries.

void Xapian::Enquire::set_weighting_scheme(const Weight &weight_)

Parameters:

• weight_: ⚖️ the new weighting scheme. If no weighting scheme is specified, the default is BM25 with the default parameters.

🔧 Static methods defined here:

• __swig_destroy__ = delete_Enquire(...) — Close the Xapian::Enquire object.

Xapian::Enquire::~Enquire()

📦 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

📦 Data and other attributes defined here:

• ASCENDING = 1
• DESCENDING = 0
• DONT_CARE = 2
• INCLUDE_QUERY_TERMS = 1
• USE_EXACT_TERMFREQ = 2

---

⚠️ Error

All exceptions thrown by Xapian are subclasses of Xapian::Error.

This class can not be instantiated directly - instead a subclass should be used.

Method resolution order: Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value
• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.

const std::string& Xapian::Error::get_context() const

This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched).

• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.

const char* Xapian::Error::get_error_string() const

The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.

• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.

const std::string& Xapian::Error::get_msg() const

• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)

const char* Xapian::Error::get_type() const

🔧 Static methods defined here:

• __swig_destroy__ = delete_Error(...)

📦 Data descriptors defined here:

• __weakref__ — list of weak references to the object (if defined)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object.

📋 Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

📦 Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

🧪 ExpandDecider

Virtual base class for expand decider functor.

🔧 Methods defined here:

• __call__ = ExpandDecider___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.

Xapian::ExpandDecider::ExpandDecider()

• __repr__ = _swig_repr(self)
• release = ExpandDecider_release(...) — Start reference counting this object.

const ExpandDecider* Xapian::ExpandDecider::release() const

You can hand ownership of a dynamically allocated ExpandDecider object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ExpandDecider(...) — Virtual destructor, because we have virtual methods.

virtual Xapian::ExpandDecider::~ExpandDecider()

📦 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

🧪🔗 ExpandDeciderAnd

ExpandDecider subclass which rejects terms using two ExpandDeciders.

Terms are only accepted if they are accepted by both of the specified ExpandDecider objects.

Method resolution order: ExpandDeciderAnd → ExpandDecider → builtins.object

🔧 Methods defined here:

• __init__(self, first_, second_) — Compatibility method.

Xapian::ExpandDeciderAnd::ExpandDeciderAnd(const ExpandDecider *first_, const ExpandDecider *second_)

Parameters:

• first_: 🧪 First ExpandDecider object to test with.
• second_: 🧪 Second ExpandDecider object to test with if first_ accepts.

• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_ExpandDeciderAnd(...)

📦 Data descriptors defined here:

• thisown — The membership flag

📋 Methods inherited from ExpandDecider:

• __call__ = ExpandDecider___call__(...)
• __disown__(self)
• release = ExpandDecider_release(...) — Start reference counting this object.

📦 Data descriptors inherited from ExpandDecider:

• __dict__
• __weakref__

---

🧪🔤 ExpandDeciderFilterPrefix

ExpandDecider subclass which restricts terms to a particular prefix.

ExpandDeciderFilterPrefix provides an easy way to choose terms with a particular prefix when generating an ESet.

Method resolution order: ExpandDeciderFilterPrefix → ExpandDecider → builtins.object

🔧 Methods defined here:

• __init__(self, prefix_) — The parameter specifies the prefix of terms to be retained.

Xapian::ExpandDeciderFilterPrefix::ExpandDeciderFilterPrefix(const std::string &prefix_)

Parameters:

• prefix_: 🔤 restrict terms to the particular prefix.

• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_ExpandDeciderFilterPrefix(...)

📦 Data descriptors defined here:

• thisown — The membership flag

📋 Methods inherited from ExpandDecider:

• __call__
• __disown__
• release

📦 Data descriptors inherited from ExpandDecider:

• __dict__
• __weakref__

---

🚫 FeatureUnavailableError

Indicates an attempt to use a feature which is unavailable.

Typically a feature is unavailable because it wasn't compiled in, or because it requires other software or facilities which aren't available.

Method resolution order: FeatureUnavailableError → RuntimeError → Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.

Xapian::FeatureUnavailableError::FeatureUnavailableError(const std::string &msg_, int errno_)

Parameters:

• msg_: 📝 Message giving details of the error, intended for human consumption.
• errno_: 🔢 Optional errno value associated with this error.

• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_FeatureUnavailableError(...)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📦 Data descriptors inherited from Error:

• __weakref__

📋 Methods inherited from builtins.Exception:

• __new__

📋 Methods inherited from builtins.BaseException:

• __delattr__
• __getattribute__
• __reduce__
• __setstate__
• with_traceback

📦 Data descriptors inherited from builtins.BaseException:

• __cause__
• __context__
• __dict__
• __suppress_context__
• __traceback__
• args

---

🧰 FieldProcessor

Base class for field processors.

🔧 Methods defined here:

• __call__ = FieldProcessor___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.

Xapian::FieldProcessor::FieldProcessor()

• __repr__ = _swig_repr(self)
• release = FieldProcessor_release(...) — Start reference counting this object.

const FieldProcessor* Xapian::FieldProcessor::release() const

You can hand ownership of a dynamically allocated FieldProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

🔧 Static methods defined here:

• __swig_destroy__ = delete_FieldProcessor(...) — Destructor.

virtual Xapian::FieldProcessor::~FieldProcessor()

📦 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

⚖️ FixedWeightPostingSource

A posting source which returns a fixed weight for all documents.

This returns entries for all documents in the given database, with a fixed weight (specified by a parameter to the constructor).

Method resolution order: FixedWeightPostingSource → PostingSource → builtins.object

🔧 Methods defined here:

• __init__(self, wt) — Construct a FixedWeightPostingSource.

Xapian::FixedWeightPostingSource::FixedWeightPostingSource(double wt)

Parameters:

• wt: ⚖️ The fixed weight to return.

• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_FixedWeightPostingSource(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from PostingSource:

• __disown__(self)
• __next__ = PostingSource___next__(...) — Advance the current position to the next matching document.

virtual void Xapian::PostingSource::next(double min_wt)=0

• __str__
• at_end
• check
• get_docid
• get_maxweight
• get_termfreq_est
• get_termfreq_max
• get_termfreq_min
• get_weight
• init
• name
• release
• set_maxweight
• skip_to

📦 Data descriptors inherited from PostingSource:

• __dict__
• __weakref__

---

🌍 GreatCircleMetric

Calculate the great-circle distance between two coordinates on a sphere.

Experimental - see https://xapian.org/docs/deprecation#experimental features

This uses the haversine formula to calculate the distance. Note that this formula is subject to inaccuracy due to numerical errors for coordinates on the opposite side of the sphere.

See https://en.wikipedia.org/wiki/Haversine_formula

Method resolution order: GreatCircleMetric → LatLongMetric → builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Construct a GreatCircleMetric using a specified radius.

Xapian::GreatCircleMetric::GreatCircleMetric(double radius_)

This is useful for data sets in which the points are not on Earth (eg, a database of features on Mars).

Parameters:

• radius_: 📏 The radius of the sphere to use, in metres.

• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_GreatCircleMetric(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from LatLongMetric:

• __call__
• __disown__
• name
• pointwise_distance

📦 Data descriptors inherited from LatLongMetric:

• __dict__
• __weakref__

---

⚖️📊 IfB2Weight

This class implements the IfB2 weighting scheme.

IfB2 is a representative scheme of the Divergence from Randomness Framework by Gianni Amati.

It uses the Inverse term frequency model (If), the Bernoulli method to find the aftereffect of sampling (B) and the second wdf normalization proposed by Amati to normalize the wdf in the document to the length of the document (H2).

For more information about the DFR Framework and the IfB2 scheme, please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen, Probabilistic models of information retrieval based on measuring the divergence from randomness, ACM Transactions on Information Systems (TOIS) 20, (4), 2002, pp. 357-389.

Method resolution order: IfB2Weight → Weight → builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Xapian::IfB2Weight::IfB2Weight()
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_IfB2Weight(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from Weight:

• get_maxextra — Return an upper bound on what get_sumextra() can return for any document.
• get_maxpart — Return an upper bound on what get_sumpart() can return for any document.
• get_sumextra — Calculate the term-independent weight component for a document.
• get_sumpart — Calculate the weight contribution for this object's term to a document.
• name — Return the name of this weighting scheme.

📦 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📦 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

⚖️📊 InL2Weight

This class implements the InL2 weighting scheme.

InL2 is a representative scheme of the Divergence from Randomness Framework by Gianni Amati. This weighting scheme is useful for tasks that require early precision.

It uses the Inverse document frequency model (In), the Laplace method to find the aftereffect of sampling (L) and the second wdf normalization proposed by Amati (H2).

For more information about the DFR Framework and the InL2 scheme, please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen, ibid.

Method resolution order: InL2Weight → Weight → builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Xapian::InL2Weight::InL2Weight()
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_InL2Weight(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from Weight:

• get_maxextra
• get_maxpart
• get_sumextra
• get_sumpart
• name

📦 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📦 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

⚖️📊 IneB2Weight

This class implements the IneB2 weighting scheme.

IneB2 is a representative scheme of the Divergence from Randomness Framework by Gianni Amati.

It uses the Inverse expected document frequency model (Ine), the Bernoulli method to find the aftereffect of sampling (B) and the second wdf normalization proposed by Amati (H2).

For more information about the DFR Framework and the IneB2 scheme, please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen, ibid.

Method resolution order: IneB2Weight → Weight → builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Xapian::IneB2Weight::IneB2Weight()
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_IneB2Weight(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from Weight:

• get_maxextra
• get_maxpart
• get_sumextra
• get_sumpart
• name

📦 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📦 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

🔴 InternalError

InternalError indicates a runtime problem of some sort.

Method resolution order: InternalError → RuntimeError → Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.

Xapian::InternalError::InternalError(const std::string &msg_, int errno_)

Parameters:

• msg_: 📝 Message giving details of the error, intended for human consumption.
• errno_: 🔢 Optional errno value associated with this error.

• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_InternalError(...)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📦 Data descriptors inherited from Error:

• __weakref__

📋 Methods inherited from builtins.Exception:

• __new__

📋 Methods inherited from builtins.BaseException:

• __delattr__
• __getattribute__
• __reduce__
• __setstate__
• with_traceback

📦 Data descriptors inherited from builtins.BaseException:

• __cause__
• __context__
• __dict__
• __suppress_context__
• __traceback__
• args

---

🚫 InvalidArgumentError

InvalidArgumentError indicates an invalid parameter value was passed to the API.

Method resolution order: InvalidArgumentError → LogicError → Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.

Xapian::InvalidArgumentError::InvalidArgumentError(const std::string &msg_, int errno_)

Parameters:

• msg_: 📝 Message giving details of the error, intended for human consumption.
• errno_: 🔢 Optional errno value associated with this error.

• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_InvalidArgumentError(...)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📦 Data descriptors inherited from Error:

• __weakref__

📋 Methods inherited from builtins.Exception:

• __new__

📋 Methods inherited from builtins.BaseException:

• __delattr__
• __getattribute__
• __reduce__
• __setstate__
• with_traceback

📦 Data descriptors inherited from builtins.BaseException:

• __cause__
• __context__
• __dict__
• __suppress_context__
• __traceback__
• args

---

🚫 InvalidOperationError

InvalidOperationError indicates the API was used in an invalid way.

Method resolution order: InvalidOperationError → LogicError → Error → builtins.Exception → builtins.BaseException → builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.

Xapian::InvalidOperationError::InvalidOperationError(const std::string &msg_, int errno_)

Parameters:

• msg_: 📝 Message giving details of the error, intended for human consumption.
• errno_: 🔢 Optional errno value associated with this error.

• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_InvalidOperationError(...)

📦 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📋 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📦 Data descriptors inherited from Error:

• __weakref__

📋 Methods inherited from builtins.Exception:

• __new__

📋 Methods inherited from builtins.BaseException:

• __delattr__
• __getattribute__
• __reduce__
• __setstate__
• with_traceback

📦 Data descriptors inherited from builtins.BaseException:

• __cause__
• __context__
• __dict__
• __suppress_context__
• __traceback__
• args

---

🔑 KeyMaker

Virtual base class for key making functors.

🔧 Methods defined here:

• __call__ = KeyMaker___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.

Xapian::KeyMaker::KeyMaker()

• __repr__ = _swig_repr(self)
• release = KeyMaker_release(...) — Start reference counting this object.

const KeyMaker* Xapian::KeyMaker::release() const

You can hand ownership of a dynamically allocated KeyMaker object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

🔧 Static methods defined here:

• __swig_destroy__ = delete_KeyMaker(...) — Virtual destructor, because we have virtual methods.

virtual Xapian::KeyMaker::~KeyMaker()

📦 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

⚖️📚 LMWeight

Xapian::Weight subclass implementing the Language Model formula.

This class implements the "Language Model" Weighting scheme, as described by the early papers on LM by Bruce Croft. LM works by comparing the query to a Language Model of the document. The language model itself is parameter-free, though LMWeight takes parameters which specify the smoothing used.

Method resolution order: LMWeight → Weight → builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Construct a LMWeight.

Xapian::LMWeight::LMWeight(double param_log_=0.0, type_smoothing select_smoothing_=TWO_STAGE_SMOOTHING, double param_smoothing1_=-1.0, double param_smoothing2_=-1.0)

Parameters:

• param_log_: 📊 A non-negative parameter controlling how much to clamp negative values returned by the log. If 0.0, document length upper bound is used (default: document length upper bound).
• select_smoothing_: 🧪 A parameter of type enum type_smoothing. Controls which smoothing type to use. (default: TWO_STAGE_SMOOTHING).
• param_smoothing1_: ⚙️ A non-negative parameter for smoothing whose meaning depends on select_smoothing_. (default depends on smoothing type).
• param_smoothing2_: ⚙️ A non-negative parameter used with TWO_STAGE_SMOOTHING as parameter for Dirichlet's smoothing (default: 2000) and as parameter delta for DIRICHLET_PLUS_SMOOTHING (default 0.05).

• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_LMWeight(...)

📦 Data descriptors defined here:

• thisown

📋 Methods inherited from Weight:

• get_maxextra
• get_maxpart
• get_sumextra
• get_sumpart
• name

📦 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📦 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

🗺️ LatLongCoord

A latitude-longitude coordinate.

Experimental - see https://xapian.org/docs/deprecation#experimental features

Note that latitude-longitude coordinates are only precisely meaningful if the datum used to define them is specified. This class ignores this issue - it is up to the caller to ensure consistency.

🔧 Methods defined here:

• __init__(self, *args) — Construct a coordinate.

Xapian::LatLongCoord::LatLongCoord(double latitude_, double longitude_)

If the supplied longitude is out of the standard range, it will be normalised to the range 0 <= longitude < 360.

If you want to avoid the checks (for example, you know that your values are already in range), you can use the alternate constructor to construct an uninitialised coordinate, and then set the latitude and longitude directly.

Throws: InvalidArgumentError if the supplied latitude is out of range.

• __repr__ = _swig_repr(self)
• __str__ = LatLongCoord___str__(...) — Return a string describing this object.

std::string Xapian::LatLongCoord::get_description() const

• serialise = LatLongCoord_serialise(...) — Return a serialised representation of the coordinate.

std::string Xapian::LatLongCoord::serialise() const

• unserialise = LatLongCoord_unserialise(...) — Unserialise a buffer and set this object to its coordinate.

void Xapian::LatLongCoord::unserialise(const char **ptr, const char *end)

The buffer may contain further data after that for the coordinate.

Parameters:

• ptr: 📍 A pointer to the start of the string. This will be updated to point to the end of the data representing the coordinate.
• end: 📍 A pointer to the end of the string.

Throws: Xapian::SerialisationError if the string does not start with a valid serialised latitude-longitude pair.

🔧 Static methods defined here:

• __swig_destroy__ = delete_LatLongCoord(...)

📦 Data descriptors defined here:

• __dict__
• __weakref__
• latitude
• longitude
• thisown

---

🗺️📋 LatLongCoords

A sequence of latitude-longitude coordinates.

Experimental - see https://xapian.org/docs/deprecation#experimental features

🔧 Methods defined here:

• __init__(self, *args) — Construct a container holding one coordinate.

Xapian::LatLongCoords::LatLongCoords(const LatLongCoord &coord)

• __iter__ = _latlongcoords_iter(self) — Get an iterator over all the coordinates in a LatLongCoords.

The iterator will return xapian.LatLongCoord objects.

• __repr__ = _swig_repr(self)
• __str__ = LatLongCoords___str__(...) — Return a string describing this object.

std::string Xapian::LatLongCoords::get_description() const

• append = LatLongCoords_append(...) — Append a coordinate to the end of the sequence.

void Xapian::LatLongCoords::append(const LatLongCoord &coord)

• begin = LatLongCoords_begin(...) — Get a begin iterator for the coordinates.

LatLongCoordsIterator Xapian::LatLongCoords::begin() const

• empty = LatLongCoords_empty(...) — Return true if and only if there are no coordinates in the container.

bool Xapian::LatLongCoords::empty() const

• end = LatLongCoords_end(...) — Get an end iterator for the coordinates.

LatLongCoordsIterator Xapian::LatLongCoords::end() const

• serialise = LatLongCoords_serialise(...) — Return a serialised form of the coordinate list.

std::string Xapian::LatLongCoords::serialise() const

• size = LatLongCoords_size(...) — Get the number of coordinates in the container.

size_t Xapian::LatLongCoords::size() const

• unserialise = LatLongCoords_unserialise(...) — Unserialise a string and set this object to the coordinates in it.

void Xapian::LatLongCoords::unserialise(const std::string &serialised)

Parameters:

• serialised: 📝 the string to unserialise the coordinates from.

Throws: Xapian::SerialisationError if the string does not contain a valid serialised latitude-longitude pair, or contains junk at the end.

🔧 Static methods defined here:

• __swig_destroy__ = delete_LatLongCoords(...)

📦 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

🗺️🔁 LatLongCoordsIter

An iterator over all the coordinates in a LatLongCoords object.

The iterator returns LatLongCoord objects.

🔧 Methods defined here:

• __eq__(self, other) — Return self==value.
• __init__(self, start, end) — Initialize self. See help(type(self)) for accurate signature.

This enhanced CLASSES section provides a visual overview of Xapian's core classes with emoji indicators for quick scanning.

📦 CLASSES

🔑 KeyMaker

See help(type(self)) for accurate signature.

• __iter__(self)
• __ne__(self, other) — Return self!=value.
• __next__(self)

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🏷️ Data and other attributes defined here:

• __hash__ = None

---

📘 LatLongDistanceKeyMaker(KeyMaker)

LatLongDistanceKeyMaker(*args)

KeyMaker subclass which sorts by distance from a latitude/longitude.

Experimental - seehttps://xapian.org/docs/deprecation#experimental- features

Results are ordered by the distance from a fixed point, or list of points, calculated according to the metric supplied. If multiple points are supplied (either in the constructor, or in the coordinates stored in a document), the closest pointwise distance is used.

If a document contains no coordinate stored in the specified slot, a special value for the distance will be used. This defaults to a large number, so that such results get a low rank, but may be specified by a constructor parameter.

📋 Method resolution order:

• LatLongDistanceKeyMaker
• KeyMaker
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Construct a LatLongDistanceKeyMaker.
  Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker(Xapian::valueno slot_, const LatLongCoord &centre_)
  📌 Parameters:
  • slot_: Value slot to use.
  • centre_: Point to calculate distance from.
  Xapian::GreatCircleMetric is used as the metric. Documents where no value is set are assumed to be a large distance away.
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_LatLongDistanceKeyMaker(...) — Xapian::LatLongDistanceKeyMaker::~LatLongDistanceKeyMaker()

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from KeyMaker:

• __call__ = KeyMaker___call__(...)
• __disown__(self)
• release = KeyMaker_release(...) — Start reference counting this object.
  const KeyMaker* Xapian::KeyMaker::release() const
  You can hand ownership of a dynamically allocated KeyMaker object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⬆️ Data descriptors inherited from KeyMaker:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 LatLongDistancePostingSource(ValuePostingSource)

LatLongDistancePostingSource(*args)

Posting source which returns a weight based on geospatial distance.

Experimental - seehttps://xapian.org/docs/deprecation#experimental- features

Results are weighted by the distance from a fixed point, or list of points, calculated according to the metric supplied. If multiple points are supplied (either in the constructor, or in the coordinates stored in a document), the closest pointwise distance is used.

Documents further away than a specified maximum range (or with no location stored in the specified slot) will not be returned.

The weight returned is computed from the distance using the formula: k1 * pow(distance + k1, -k2) (Where k1 and k2 are (strictly) positive, floating point constants, which default to 1000 and 1, respectively. Distance is measured in metres, so this means that something at the centre gets a weight of 1.0, something 1km away gets a weight of 0.5, and something 3km away gets a weight of 0.25, etc)

📋 Method resolution order:

• LatLongDistancePostingSource
• ValuePostingSource
• PostingSource
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Construct a new posting source which returns only documents within range of one of the central coordinates.
  Xapian::LatLongDistancePostingSource::LatLongDistancePostingSource(Xapian::valueno slot_, const LatLongCoords &centre_, double max_range_=0.0, double k1_=1000.0, double k2_=1.0)
  📌 Parameters:
  • slot_: The value slot to read values from.
  • centre_: The centre point to use for distance calculations.
  • max_range_: The maximum distance for documents which are returned.
  • k1_: The k1 constant to use in the weighting function.
  • k2_: The k2 constant to use in the weighting function.
  Xapian::GreatCircleMetric is used as the metric.
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_LatLongDistancePostingSource(...) — Xapian::LatLongDistancePostingSource::~LatLongDistancePostingSource()

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from ValuePostingSource:

• __disown__(self)
• __next__ = ValuePostingSource___next__(...) — Advance the current position to the next matching document.
  void Xapian::ValuePostingSource::next(double min_wt)
  The PostingSource starts before the first entry in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position. Xapian will always call init() on a PostingSource before calling this for the first time.
  📌 Parameters:
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).
• at_end = ValuePostingSource_at_end(...) — Return true if the current position is past the last entry in this list.
  bool Xapian::ValuePostingSource::at_end() const
  At least one of next(), skip_to() or check() will be called before this method is first called.
• check = ValuePostingSource_check(...) — Check if the specified docid occurs.
  bool Xapian::ValuePostingSource::check(Xapian::docid min_docid, double min_wt)
  The caller is required to ensure that the specified document id did actually exists in the database. If it does, it must move to that document id, and return true. If it does not, it may either: return true, having moved to a definite position (including "at_end"), which must be the same position as skip_to() would have moved to. or return false, having moved to an "indeterminate" position, such that a subsequent call to next() or skip_to() will move to the next matching position after did. Generally, this method should act like skip_to() and return true if that can be done at little extra cost. Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't. The default implementation calls skip_to() and always returns true. Xapian will always call init() on a PostingSource before calling this for the first time. Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.
  📌 Parameters:
  • did: The document id to check.
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).
• done = ValuePostingSource_done(...) — End the iteration.
  void Xapian::ValuePostingSource::done()
  Calls to at_end() will return true after calling this method. Added in 1.2.23 and 1.3.5.
• get_database = ValuePostingSource_get_database(...) — The database we're reading values from.
  Xapian::Database Xapian::ValuePostingSource::get_database() const
  Added in 1.2.23 and 1.3.5.
• get_docid = ValuePostingSource_get_docid(...) — Return the current docid.
  Xapian::docid Xapian::ValuePostingSource::get_docid() const
  This method may assume that it will only be called when there is a "current document". See get_weight() for details. Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the init() method for details.
• get_slot = ValuePostingSource_get_slot(...) — The slot we're reading values from.
  Xapian::valueno Xapian::ValuePostingSource::get_slot() const
  Added in 1.2.23 and 1.3.5.
• get_started = ValuePostingSource_get_started(...) — Flag indicating if we've started (true if we have).
  bool Xapian::ValuePostingSource::get_started() const
  Added in 1.2.23 and 1.3.5.
• get_termfreq_est = ValuePostingSource_get_termfreq_est(...) — An estimate of the number of documents this object can return.
  Xapian::doccount Xapian::ValuePostingSource::get_termfreq_est() const
  It must always be true that: get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_termfreq_max = ValuePostingSource_get_termfreq_max(...) — An upper bound on the number of documents this object can return.
  Xapian::doccount Xapian::ValuePostingSource::get_termfreq_max() const
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_termfreq_min = ValuePostingSource_get_termfreq_min(...) — A lower bound on the number of documents this object can return.
  Xapian::doccount Xapian::ValuePostingSource::get_termfreq_min() const
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_value = ValuePostingSource_get_value(...) — Read current value.
  std::string Xapian::ValuePostingSource::get_value() const
  Added in 1.2.23 and 1.3.5.
• init = ValuePostingSource_init(...) — Set this PostingSource to the start of the list of postings.
  void Xapian::ValuePostingSource::init(const Database &db_)
  This is called automatically by the matcher prior to each query being processed. If a PostingSource is used for multiple searches, init() will therefore be called multiple times, and must handle this by using the database passed in the most recent call.
  📌 Parameters:
  • db: The database which the PostingSource should iterate through.
  Note: in the case of a multi-database search, a separate PostingSource will be used for each database (the separate PostingSources will be obtained using clone()), and each PostingSource will be passed one of the sub-databases as the db parameter here. The db parameter will therefore always refer to a single database. All docids passed to, or returned from, the PostingSource refer to docids in that single database, rather than in the multi- database.
• set_termfreq_est = ValuePostingSource_set_termfreq_est(...) — An estimate of the term frequency.
  void Xapian::ValuePostingSource::set_termfreq_est(Xapian::doccount termfreq_est_)
  Subclasses should set this if they are overriding the next(), skip_to() or check() methods. Added in 1.2.23 and 1.3.5.
• set_termfreq_max = ValuePostingSource_set_termfreq_max(...) — An upper bound on the term frequency.
  void Xapian::ValuePostingSource::set_termfreq_max(Xapian::doccount termfreq_max_)
  Subclasses should set this if they are overriding the next(), skip_to() or check() methods. Added in 1.2.23 and 1.3.5.
• set_termfreq_min = ValuePostingSource_set_termfreq_min(...) — Set a lower bound on the term frequency.
  void Xapian::ValuePostingSource::set_termfreq_min(Xapian::doccount termfreq_min_)
  Subclasses should set this if they are overriding the next(), skip_to() or check() methods to return fewer documents. Added in 1.2.23 and 1.3.5.
• skip_to = ValuePostingSource_skip_to(...) — Advance to the specified docid.
  void Xapian::ValuePostingSource::skip_to(Xapian::docid min_docid, double min_wt)
  If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present). If the current position is already the specified docid, this method will leave the position unmodified. If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid. The default implementation calls next() repeatedly, which works but skip_to() can often be implemented much more efficiently. Xapian will always call init() on a PostingSource before calling this for the first time. Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.
  📌 Parameters:
  • did: The document id to advance to.
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

⬆️ Methods inherited from PostingSource:

• __str__ = PostingSource___str__(...) — Return a string describing this object.
  virtual std::string Xapian::PostingSource::get_description() const
  This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own PostingSource subclass from having to implement this (they may not care what get_description() gives for their subclass).
• get_maxweight = PostingSource_get_maxweight(...) — Return the currently set upper bound on what get_weight() can return.
  double Xapian::PostingSource::get_maxweight() const
• get_weight = PostingSource_get_weight(...) — Return the weight contribution for the current document.
  virtual double Xapian::PostingSource::get_weight() const
  This default implementation always returns 0, for convenience when implementing "weight-less" PostingSource subclasses. This method may assume that it will only be called when there is a "current document". In detail: Xapian will always call init() on a PostingSource before calling this for the first time. It will also only call this if the PostingSource reports that it is pointing to a valid document (ie, it will not call it before calling at least one of next(), skip_to() or check(), and will ensure that the PostingSource is not at the end by calling at_end()).
• name = PostingSource_name(...) — Name of the posting source class.
  virtual std::string Xapian::PostingSource::name() const
  This is used when serialising and unserialising posting sources; for example, for performing remote searches. If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a PostingSource subclass called "FooPostingSource" in the "Xapian" namespace the result of this call should be "Xapian::FooPostingSource". This should only be implemented if serialise() and unserialise() are also implemented. The default implementation returns an empty string. If this returns an empty string, Xapian will assume that serialise() and unserialise() are not implemented.
• release = PostingSource_release(...) — Start reference counting this object.
  const PostingSource* Xapian::PostingSource::release() const
  You can hand ownership of a dynamically allocated PostingSource object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.
• set_maxweight = PostingSource_set_maxweight(...) — Specify an upper bound on what get_weight() will return from now on.
  void Xapian::PostingSource::set_maxweight(double max_weight)
  This upper bound is used by the matcher to perform various optimisations, so if you can return a good bound, then matches will generally run faster. This method should be called after calling init(), and may be called during iteration if the upper bound drops. It is probably only useful to call from subclasses (it was actually a "protected" method prior to Xapian 1.3.4, but that makes it tricky to wrap for other languages). It is valid for the posting source to have returned a higher value from get_weight() earlier in the iteration, but the posting source must not return a higher value from get_weight() than the currently set upper bound, and the upper bound must not be increased (until init() has been called). If you don't call this method, the upper bound will default to 0, for convenience when implementing "weight-less" PostingSource subclasses.
  📌 Parameters:
  • max_weight: The upper bound to set.

⬆️ Data descriptors inherited from PostingSource:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 LatLongMetric(builtins.object)

Base class for calculating distances between two lat/long coordinates.

Experimental - seehttps://xapian.org/docs/deprecation#experimental- features

🔧 Methods defined here:

• __call__ = LatLongMetric___call__(...)
• __disown__(self)
• __init__(self) — Initialize self. See help(type(self)) for accurate signature.
• __repr__ = _swig_repr(self)
• name = LatLongMetric_name(...) — Return the full name of the metric.
  virtual std::string Xapian::LatLongMetric::name() const =0
  This is used when serialising and unserialising metrics; for example, for performing remote searches. If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a LatLongMetric subclass called "FooLatLongMetric" in the "Xapian" namespace the result of this call should be "Xapian::FooLatLongMetric".
• pointwise_distance = LatLongMetric_pointwise_distance(...) — Return the distance between two coordinates, in metres.
  virtual double Xapian::LatLongMetric::pointwise_distance(const LatLongCoord &a, const LatLongCoord &b) const =0

⚙️ Static methods defined here:

• __swig_destroy__ = delete_LatLongMetric(...) — Destructor.
  virtual Xapian::LatLongMetric::~LatLongMetric()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 LogicError(Error)

LogicError(*args, **kwargs)

The base class for exceptions indicating errors in the program logic.

A subclass of LogicError will be thrown if Xapian detects a violation of a class invariant or a logical precondition or postcondition, etc.

📋 Method resolution order:

• LogicError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

⚙️ Static methods defined here:

• __swig_destroy__ = delete_LogicError(...)

🏷️ Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

⬆️ Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  const std::string& Xapian::Error::get_context() const
  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  const char* Xapian::Error::get_error_string() const
  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.
• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  const std::string& Xapian::Error::get_msg() const
• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  const char* Xapian::Error::get_type() const

⬆️ Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

⬆️ Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

⬆️ Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

⬆️ Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📘 MSet(builtins.object)

Class representing a list of search results.

🔧 Methods defined here:

• __getitem__ = _mset_getitem(self, index) — Get an item from the MSet. The supplied index is relative to the start of the MSet, not the absolute rank of the item. Returns an MSetItem.
• __init__(self) — Default constructor.
  Xapian::MSet::MSet()
  Creates an empty MSet, mostly useful as a placeholder.
• __iter__ = _mset_gen_iter(self) — Return an iterator over the MSet. The iterator will return MSetItem objects, which will be evaluated lazily where appropriate.
• __len__ lambda self
• __repr__ = _swig_repr(self)
• __str__ = MSet___str__(...) — Return a string describing this object.
  std::string Xapian::MSet::get_description() const
• back = MSet_back(...) — Return iterator pointing to the last object in this MSet.
  MSetIterator Xapian::MSet::back() const
• convert_to_percent = MSet_convert_to_percent(...) — Convert the weight of the current iterator position to a percentage.
  int Xapian::MSet::convert_to_percent(const MSetIterator &it) const
  The matching document with the highest weight will get 100% if it matches all the weighted query terms, and proportionally less if it only matches some, and other weights are scaled by the same factor. Documents with a non-zero score will always score at least 1%. Note that these generally aren't percentages of anything meaningful (unless you use a custom weighting formula where they are!)
• empty = MSet_empty(...) — Return true if this MSet object is empty.
  bool Xapian::MSet::empty() const
• fetch = MSet_fetch(...) — Prefetch hint the whole MSet.
  void Xapian::MSet::fetch() const
  For a remote database, this may start a pipelined fetch of the requested documents from the remote server. For a disk-based database, this may send prefetch hints to the operating system such that the disk blocks the requested documents are stored in are more likely to be in the cache when we come to actually read them.
• get_docid = MSet_get_docid(...)
• get_document = MSet_get_document(...)
• get_document_percentage = MSet_get_document_percentage(...)
• get_firstitem = MSet_get_firstitem(...) — Rank of first item in this MSet.
  Xapian::doccount Xapian::MSet::get_firstitem() const
  This is the parameter first passed to Xapian::Enquire::get_mset().
• get_hit = _mset_getitem(self, index) — Get an item from the MSet. The supplied index is relative to the start of the MSet, not the absolute rank of the item. Returns an MSetItem.
• get_matches_estimated = MSet_get_matches_estimated(...) — Estimate of the total number of matching documents.
  Xapian::doccount Xapian::MSet::get_matches_estimated() const
• get_matches_lower_bound = MSet_get_matches_lower_bound(...) — Lower bound on the total number of matching documents.
  Xapian::doccount Xapian::MSet::get_matches_lower_bound() const
• get_matches_upper_bound = MSet_get_matches_upper_bound(...) — Upper bound on the total number of matching documents.
  Xapian::doccount Xapian::MSet::get_matches_upper_bound() const
• get_max_attained = MSet_get_max_attained(...) — The maximum weight attained by any document.
  double Xapian::MSet::get_max_attained() const
• get_max_possible = MSet_get_max_possible(...) — The maximum possible weight any document could achieve.
  double Xapian::MSet::get_max_possible() const
• get_termfreq = MSet_get_termfreq(...) — Get the termfreq of a term.
  Xapian::doccount Xapian::MSet::get_termfreq(const std::string &term) const
  The number of documents which term occurs in. This considers all documents in the database being searched, so gives the same answer as db.get_termfreq(term) (but is more efficient for query terms as it returns a value cached during the search.)
• get_termweight = MSet_get_termweight(...) — Get the term weight of a term.
  double Xapian::MSet::get_termweight(const std::string &term) const
  The maximum weight that term could have contributed to a document.
• get_uncollapsed_matches_estimated = MSet_get_uncollapsed_matches_estimated(...) — Estimate of the total number of matching documents before collapsing.
  Xapian::doccount Xapian::MSet::get_uncollapsed_matches_estimated() const
  Conceptually the same as get_matches_estimated() for the same query without any collapse part (though the actual value may differ).
• get_uncollapsed_matches_lower_bound = MSet_get_uncollapsed_matches_lower_bound(...) — Lower bound on the total number of matching documents before collapsing.
  Xapian::doccount Xapian::MSet::get_uncollapsed_matches_lower_bound() const
  Conceptually the same as get_matches_lower_bound() for the same query without any collapse part (though the actual value may differ).
• get_uncollapsed_matches_upper_bound = MSet_get_uncollapsed_matches_upper_bound(...) — Upper bound on the total number of matching documents before collapsing.
  Xapian::doccount Xapian::MSet::get_uncollapsed_matches_upper_bound() const
  Conceptually the same as get_matches_upper_bound() for the same query without any collapse part (though the actual value may differ).
• size = MSet_size(...) — Return number of items in this MSet object.
  Xapian::doccount Xapian::MSet::size() const
• snippet = MSet_snippet(...) — Generate a snippet.
  std::string Xapian::MSet::snippet(const std::string &text, size_t length=500, const Xapian::Stem &stemmer=Xapian::Stem(), unsigned flags=SNIPPET_BACKGROUND_MODEL|SNIPPET_EXHAUSTIVE, const std::string &hi_start="<b>", const std::string &hi_end="</b>", const std::string &omit="...") const
  This method selects a continuous run of words from text, based mainly on where the query matches (currently terms, exact phrases and wildcards are taken into account). If flag SNIPPET_BACKGROUND_MODEL is used (which it is by default) then the selection algorithm also considers the non-query terms in the text with the aim of showing a context which provides more useful information. The size of the text selected can be controlled by the length parameter, which specifies a number of bytes of text to aim to select. However slightly more text may be selected. Also the size of any escaping, highlighting or omission markers is not considered. The returned text is escaped to make it suitable for use in HTML (though beware that in upstream releases 1.4.5 and earlier this escaping was sometimes incomplete), and matches with the query will be highlighted using hi_start and hi_end. If the snippet seems to start or end mid-sentence, then omit is prepended or append (respectively) to indicate this. The same stemming algorithm which was used to build the query should be specified in stemmer. And flags contains flags controlling behaviour. Added in 1.3.5.

⚙️ Static methods defined here:

• __swig_destroy__ = delete_MSet(...) — Destructor.
  Xapian::MSet::~MSet()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

🏷️ Data and other attributes defined here:

• SNIPPET_BACKGROUND_MODEL = 1
• SNIPPET_CJK_NGRAM = 2048
• SNIPPET_EMPTY_WITHOUT_MATCH = 4
• SNIPPET_EXHAUSTIVE = 2

---

📘 MSetItem(builtins.object)

MSetItem(iter, mset)

An item returned from iteration of the MSet.

The item supports access to the following attributes and properties:

• docid: The Xapian document ID corresponding to this MSet item.
• weight: The weight corresponding to this MSet item.
• rank: The rank of this MSet item. The rank is the position in the total set of matching documents of this item. The highest document is given a rank of 0. If the MSet did not start at the highest matching document, because a non-zero 'start' parameter was supplied to get_mset(), the first document in the MSet will have a rank greater than 0 (in fact, it will be equal to the value of 'start' supplied to get_mset()).
• percent: The percentage score assigned to this MSet item.
• document: The document for this MSet item. This can be used to access the document data, or any other information stored in the document (such as term lists). It is lazily evaluated.
• collapse_key: The value of the key which was used for collapsing.
• collapse_count: An estimate of the number of documents that have been collapsed into this one.

The collapse count estimate will always be less than or equal to the actual number of other documents satisfying the match criteria with the same collapse key as this document. If may be 0 even though there are other documents with the same collapse key which satisfying the match criteria. However if this method returns non-zero, there definitely are other such documents. So this method may be used to inform the user that there are "at least N other matches in this group", or to control whether to offer a "show other documents in this group" feature (but note that it may not offer it in every case where it would show other documents).

🔧 Methods defined here:

• __init__(self, iter, mset) — Initialize self. See help(type(self)) for accurate signature.

📖 Readonly properties defined here:

• document — The document object corresponding to this MSet item.

📊 Data descriptors defined here:

• collapse_count
• collapse_key
• docid
• percent
• rank
• weight

---

📘 MSetIter(builtins.object)

MSetIter(mset)

An iterator over the items in an MSet. The iterator will return MSetItem objects, which will be evaluated lazily where appropriate.

🔧 Methods defined here:

• __init__(self, mset) — Initialize self. See help(type(self)) for accurate signature.
• __iter__(self)
• __next__(self)

---

📘 MatchDecider(builtins.object)

Base class for matcher decision functor.

🔧 Methods defined here:

• __call__ = MatchDecider___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.
  Xapian::MatchDecider::MatchDecider()
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_MatchDecider(...) — Destructor.
  virtual Xapian::MatchDecider::~MatchDecider()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 MatchSpy(builtins.object)

Abstract base class for match spies.

The subclasses will generally accumulate information seen during the match, to calculate aggregate functions, or other profiles of the matching documents.

🔧 Methods defined here:

• __call__ = MatchSpy___call__(...)
• __disown__(self)
• __init__(self) — Default constructor, needed by subclass constructors.
  Xapian::MatchSpy::MatchSpy()
• __repr__ = _swig_repr(self)
• __str__ = MatchSpy___str__(...) — Return a string describing this object.
  virtual std::string Xapian::MatchSpy::get_description() const
  This default implementation returns a generic answer, to avoid forcing those deriving their own MatchSpy subclasses from having to implement this (they may not care what get_description() gives for their subclass).
• merge_results = MatchSpy_merge_results(...) — Unserialise some results, and merge them into this matchspy.
  virtual void Xapian::MatchSpy::merge_results(const std::string &serialised)
  The order in which results are merged should not be significant, since this order is not specified (and will vary depending on the speed of the search in each sub-database). If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.
  📌 Parameters:
  • serialised: A string containing the serialised results.
• name = MatchSpy_name(...) — Return the name of this match spy.
  virtual std::string Xapian::MatchSpy::name() const
  This name is used by the remote backend. It is passed with the serialised parameters to the remote server so that it knows which class to create. Return the full namespace-qualified name of your class here - if your class is called MyApp::FooMatchSpy, return "MyApp::FooMatchSpy" from this method. If you don't want to support the remote backend in your match spy, you can use the default implementation which simply throws Xapian::UnimplementedError.
• release = MatchSpy_release(...) — Start reference counting this object.
  const MatchSpy* Xapian::MatchSpy::release() const
  You can hand ownership of a dynamically allocated MatchSpy object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⚙️ Static methods defined here:

• __swig_destroy__ = delete_MatchSpy(...) — Virtual destructor, because we have virtual methods.
  virtual Xapian::MatchSpy::~MatchSpy()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 MultiValueKeyMaker(KeyMaker)

KeyMaker subclass which combines several values.

When the result is used for sorting, results are ordered by the first value. In the event of a tie, the second is used. If this is the same for both, the third is used, and so on. If reverse is true for a value, then the sort order for that value is reversed.

When used for collapsing, the documents will only be considered equal if all the values specified match. If none of the specified values are set then the generated key will be empty, so such documents won't be collapsed (which is consistent with the behaviour in the "collapse on a value" case). If you'd prefer that documents with none of the keys set are collapsed together, then you can set reverse for at least one of the values. Other than this, it isn't useful to set reverse for collapsing.

📋 Method resolution order:

• MultiValueKeyMaker
• KeyMaker
• builtins.object

🔧 Methods defined here:

• __init__(self) — Construct a MultiValueKeyMaker from a pair of iterators.
  Xapian::MultiValueKeyMaker::MultiValueKeyMaker(Iterator begin, Iterator end)
  The iterators must be a begin/end pair returning Xapian::valueno (or a compatible type) when dereferenced.
• __repr__ = _swig_repr(self)
• add_value = MultiValueKeyMaker_add_value(...) — Add a value slot to the list to build a key from.
  void Xapian::MultiValueKeyMaker::add_value(Xapian::valueno slot, bool reverse=false, const std::string &defvalue=std::string())
  📌 Parameters:
  • slot: The value slot to add
  • reverse: Adjust values from this slot to reverse their sort order (default: false)
  • defvalue: Value to use for documents which don't have a value set in this slot (default: empty). This can be used to make such documents sort after all others by passing get_value_upper_bound(slot) + "x" this is guaranteed to be greater than any value in this slot.

⚙️ Static methods defined here:

• __swig_destroy__ = delete_MultiValueKeyMaker(...)

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from KeyMaker:

• __call__ = KeyMaker___call__(...)
• __disown__(self)
• release = KeyMaker_release(...) — Start reference counting this object.
  const KeyMaker* Xapian::KeyMaker::release() const
  You can hand ownership of a dynamically allocated KeyMaker object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⬆️ Data descriptors inherited from KeyMaker:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 NetworkError(RuntimeError)

NetworkError(*args)

Indicates a problem communicating with a remote database.

📋 Method resolution order:

• NetworkError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
  Xapian::NetworkError::NetworkError(const std::string &msg_, int errno_)
  📌 Parameters:
  • msg_: Message giving details of the error, intended for human consumption.
  • errno_: Optional errno value associated with this error.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

⚙️ Static methods defined here:

• __swig_destroy__ = delete_NetworkError(...)

🏷️ Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

⬆️ Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  const std::string& Xapian::Error::get_context() const
  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  const char* Xapian::Error::get_error_string() const
  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.
• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  const std::string& Xapian::Error::get_msg() const
• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  const char* Xapian::Error::get_type() const

⬆️ Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

⬆️ Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

⬆️ Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

⬆️ Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📘 NetworkTimeoutError(NetworkError)

NetworkTimeoutError(*args)

Indicates a timeout expired while communicating with a remote database.

📋 Method resolution order:

• NetworkTimeoutError
• NetworkError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
  Xapian::NetworkTimeoutError::NetworkTimeoutError(const std::string &msg_, int errno_)
  📌 Parameters:
  • msg_: Message giving details of the error, intended for human consumption.
  • errno_: Optional errno value associated with this error.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

⚙️ Static methods defined here:

• __swig_destroy__ = delete_NetworkTimeoutError(...)

🏷️ Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

⬆️ Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  const std::string& Xapian::Error::get_context() const
  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  const char* Xapian::Error::get_error_string() const
  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.
• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  const std::string& Xapian::Error::get_msg() const
• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  const char* Xapian::Error::get_type() const

⬆️ Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

⬆️ Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

⬆️ Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

⬆️ Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📘 NumberRangeProcessor(RangeProcessor)

NumberRangeProcessor(*args)

Handle a number range.

This class must be used on values which have been encoded using Xapian::sortable_serialise() which turns numbers into strings which will sort in the same order as the numbers (the same values can be used to implement a numeric sort).

📋 Method resolution order:

• NumberRangeProcessor
• RangeProcessor
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Constructor.
  Xapian::NumberRangeProcessor::NumberRangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
  📌 Parameters:
  • slot_: The value slot number to query.
  • str_: A string to look for to recognise values as belonging to this numeric range.
  • flags_: Zero or more of the following flags, combined with bitwise-or: Xapian::RP_SUFFIX - require str_ as a suffix instead of a prefix. Xapian::RP_REPEATED - optionally allow str_ on both ends of the range - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the end (e.g. 2..12kg). The string supplied in str_ is used by operator() to decide whether the pair of strings supplied to it constitute a valid range. If prefix_ is true, the first value in a range must begin with str_ (and the second value may optionally begin with str_); if prefix_ is false, the second value in a range must end with str_ (and the first value may optionally end with str_). If str_ is empty, the setting of prefix_ is irrelevant, and no special strings are required at the start or end of the strings defining the range. The remainder of both strings defining the endpoints must be valid floating point numbers. (FIXME: define format recognised). For example, if str_ is "$" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "$10..50" or "$10..$50", but not "10..50" or "10..$50" as valid ranges. If str_ is "kg" and prefix_ is false, the queryparser will accept "10..50kg" or "10kg..50kg", but not "10..50" or "10kg..50" as valid ranges.
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_NumberRangeProcessor(...)

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from RangeProcessor:

• __call__ = RangeProcessor___call__(...)
• __disown__(self)
• check_range = RangeProcessor_check_range(...) — Check prefix/suffix on range.
  Xapian::Query Xapian::RangeProcessor::check_range(const std::string &b, const std::string &e)
  If they match, remove the prefix/suffix and then call operator()() to try to handle the range.
• release = RangeProcessor_release(...) — Start reference counting this object.
  const RangeProcessor* Xapian::RangeProcessor::release() const
  You can hand ownership of a dynamically allocated RangeProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⬆️ Data descriptors inherited from RangeProcessor:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 NumberValueRangeProcessor(StringValueRangeProcessor)

NumberValueRangeProcessor(*args)

Handle a number range.

This class must be used on values which have been encoded using Xapian::sortable_serialise() which turns numbers into strings which will sort in the same order as the numbers (the same values can be used to implement a numeric sort).

Deprecated Use Xapian::NumberRangeProcessor instead (added in 1.3.6).

📋 Method resolution order:

• NumberValueRangeProcessor
• StringValueRangeProcessor
• ValueRangeProcessor
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Constructor.
  Xapian::NumberValueRangeProcessor::NumberValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)
  📌 Parameters:
  • slot_: The value number to return from operator().
  • str_: A string to look for to recognise values as belonging to this numeric range.
  • prefix_: Whether to look for the string at the start or end of the values. If true, the string is a prefix; if false, the string is a suffix (default: true). The string supplied in str_ is used by operator() to decide whether the pair of strings supplied to it constitute a valid range. If prefix_ is true, the first value in a range must begin with str_ (and the second value may optionally begin with str_); if prefix_ is false, the second value in a range must end with str_ (and the first value may optionally end with str_). If str_ is empty, the setting of prefix_ is irrelevant, and no special strings are required at the start or end of the strings defining the range. The remainder of both strings defining the endpoints must be valid floating point numbers. (FIXME: define format recognised). For example, if str_ is "$" and prefix_ is true, and the range processor has been added to the queryparser, the queryparser will accept "$10..50" or "$10..$50", but not "10..50" or "10..$50" as valid ranges. If str_ is "kg" and prefix_ is false, the queryparser will accept "10..50kg" or "10kg..50kg", but not "10..50" or "10kg..50" as valid ranges.
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_NumberValueRangeProcessor(...)

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from ValueRangeProcessor:

• __call__ = ValueRangeProcessor___call__(...)
• __disown__(self)
• release = ValueRangeProcessor_release(...) — Start reference counting this object.
  const ValueRangeProcessor* Xapian::ValueRangeProcessor::release() const
  You can hand ownership of a dynamically allocated ValueRangeProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⬆️ Data descriptors inherited from ValueRangeProcessor:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 PL2PlusWeight(Weight)

PL2PlusWeight(*args)

Xapian::Weight subclass implementing the PL2+ probabilistic formula.

📋 Method resolution order:

• PL2PlusWeight
• Weight
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Xapian::PL2PlusWeight::PL2PlusWeight()
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_PL2PlusWeight(...)

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from Weight:

• get_maxextra = Weight_get_maxextra(...) — Return an upper bound on what get_sumextra() can return for any document.
  virtual double Xapian::Weight::get_maxextra() const =0
  This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.
• get_maxpart = Weight_get_maxpart(...) — Return an upper bound on what get_sumpart() can return for any document.
  virtual double Xapian::Weight::get_maxpart() const =0
  This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.
• get_sumextra = Weight_get_sumextra(...) — Calculate the term-independent weight component for a document.
  virtual double Xapian::Weight::get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
  The parameter gives information about the document which may be used in the calculations:
  📌 Parameters:
  • doclen: The document's length (unnormalised).
  • uniqterms: The number of unique terms in the document.
• get_sumpart = Weight_get_sumpart(...) — Calculate the weight contribution for this object's term to a document.
  virtual double Xapian::Weight::get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
  The parameters give information about the document which may be used in the calculations:
  📌 Parameters:
  • wdf: The within document frequency of the term in the document.
  • doclen: The document's length (unnormalised).
  • uniqterms: Number of unique terms in the document (used for absolute smoothing).
• name = Weight_name(...) — Return the name of this weighting scheme.
  virtual std::string Xapian::Weight::name() const
  This name is used by the remote backend. It is passed along with the serialised parameters to the remote server so that it knows which class to create. Return the full namespace-qualified name of your class here - if your class is called FooWeight, return "FooWeight" from this method ( Xapian::BM25Weight returns "Xapian::BM25Weight" here). If you don't want to support the remote backend, you can use the default implementation which simply returns an empty string.

⬆️ Data descriptors inherited from Weight:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🏷️ Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

📘 PL2Weight(Weight)

PL2Weight(*args)

This class implements the PL2 weighting scheme.

PL2 is a representative scheme of the Divergence from Randomness Framework by Gianni Amati.

This weighting scheme is useful for tasks that require early precision.

It uses the Poisson approximation of the Binomial Probabilistic distribution (P) along with Stirling's approximation for the factorial value, the Laplace method to find the aftereffect of sampling (L) and the second wdf normalization proposed by Amati to normalize the wdf in the document to the length of the document (H2).

For more information about the DFR Framework and the PL2 scheme, please refer to : Gianni Amati and Cornelis Joost Van Rijsbergen Probabilistic models of information retrieval based on measuring the divergence from randomness ACM Transactions on Information Systems (TOIS) 20, (4), 2002, pp. 357-389.

📋 Method resolution order:

• PL2Weight
• Weight
• builtins.object

🔧 Methods defined here:

• __init__(self, *args) — Xapian::PL2Weight::PL2Weight()
• __repr__ = _swig_repr(self)

⚙️ Static methods defined here:

• __swig_destroy__ = delete_PL2Weight(...)

📊 Data descriptors defined here:

• thisown — The membership flag

⬆️ Methods inherited from Weight:

• get_maxextra = Weight_get_maxextra(...) — Return an upper bound on what get_sumextra() can return for any document.
  virtual double Xapian::Weight::get_maxextra() const =0
  This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.
• get_maxpart = Weight_get_maxpart(...) — Return an upper bound on what get_sumpart() can return for any document.
  virtual double Xapian::Weight::get_maxpart() const =0
  This information is used by the matcher to perform various optimisations, so strive to make the bound as tight as possible.
• get_sumextra = Weight_get_sumextra(...) — Calculate the term-independent weight component for a document.
  virtual double Xapian::Weight::get_sumextra(Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
  The parameter gives information about the document which may be used in the calculations:
  📌 Parameters:
  • doclen: The document's length (unnormalised).
  • uniqterms: The number of unique terms in the document.
• get_sumpart = Weight_get_sumpart(...) — Calculate the weight contribution for this object's term to a document.
  virtual double Xapian::Weight::get_sumpart(Xapian::termcount wdf, Xapian::termcount doclen, Xapian::termcount uniqterms) const =0
  The parameters give information about the document which may be used in the calculations:
  📌 Parameters:
  • wdf: The within document frequency of the term in the document.
  • doclen: The document's length (unnormalised).
  • uniqterms: Number of unique terms in the document (used for absolute smoothing).
• name = Weight_name(...) — Return the name of this weighting scheme.
  virtual std::string Xapian::Weight::name() const
  This name is used by the remote backend. It is passed along with the serialised parameters to the remote server so that it knows which class to create. Return the full namespace-qualified name of your class here - if your class is called FooWeight, return "FooWeight" from this method ( Xapian::BM25Weight returns "Xapian::BM25Weight" here). If you don't want to support the remote backend, you can use the default implementation which simply returns an empty string.

⬆️ Data descriptors inherited from Weight:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🏷️ Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

📘 PositionIter(builtins.object)

PositionIter(start=0, end=0)

An iterator over a position list. The iterator will return integers, in ascending order.

🔧 Methods defined here:

• __init__(self, start=0, end=0) — Initialize self. See help(type(self)) for accurate signature.
• __iter__(self)
• __next__(self)

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

---

📘 PostingItem(builtins.object)

PostingItem(iter)

An item returned from iteration of a posting list.

The item supports access to the following attributes and properties:

• docid: The document ID corresponding to this PostingItem.
• doclength: The length of the document corresponding to this PostingItem.
• wdf: The within document frequency of the term which the posting list is for in the document corresponding to this PostingItem.
• positer: An iterator over the positions which the term corresponing to this posting list occurs at in the document corresponding to this PostingItem. This is only available until the iterator which returned this item next moves.

🔧 Methods defined here:

• __init__(self, iter) — Initialize self. See help(type(self)) for accurate signature.

📖 Readonly properties defined here:

• positer — A position iterator for the current posting (if meaningful). The iterator will return integers representing the positions that the term occurs at. This will raise a InvalidOperationError exception if the iterator this item came from doesn't support position lists, or if the iterator has moved on since the item was returned from it.

📊 Data descriptors defined here:

• docid
• doclength
• wdf

---

📘 PostingIter(builtins.object)

PostingIter(start, end, has_positions=False)

An iterator over a posting list. The iterator will return PostingItem objects, which will be evaluated lazily where appropriate.

🔧 Methods defined here:

• __init__(self, start, end, has_positions=False) — Initialize self. See help(type(self)) for accurate signature.
• __iter__(self)
• __next__(self)
• skip_to(self, docid) — Skip the iterator forward. The iterator is advanced to the first document with a document ID which is greater than or equal to the supplied document ID. If there are no such items, this will raise StopIteration. This returns the item which the iterator is moved to. The subsequent item will be returned the next time that next() is called (unless skip_to() is called again first).

---

📘 PostingSource(builtins.object)

Base class which provides an "external" source of postings.

🔧 Methods defined here:

• __disown__(self)
• __init__(self) — Allow subclasses to be instantiated.
  Xapian::PostingSource::PostingSource()
• __next__ = PostingSource___next__(...) — Advance the current position to the next matching document.
  virtual void Xapian::PostingSource::next(double min_wt)=0
  The PostingSource starts before the first entry in the list, so next(), skip_to() or check() must be called before any methods which need the context of the current position. Xapian will always call init() on a PostingSource before calling this for the first time.
  📌 Parameters:
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).
• __repr__ = _swig_repr(self)
• __str__ = PostingSource___str__(...) — Return a string describing this object.
  virtual std::string Xapian::PostingSource::get_description() const
  This default implementation returns a generic answer. This default it provided to avoid forcing those deriving their own PostingSource subclass from having to implement this (they may not care what get_description() gives for their subclass).
• at_end = PostingSource_at_end(...) — Return true if the current position is past the last entry in this list.
  virtual bool Xapian::PostingSource::at_end() const =0
  At least one of next(), skip_to() or check() will be called before this method is first called.
• check = PostingSource_check(...) — Check if the specified docid occurs.
  virtual bool Xapian::PostingSource::check(Xapian::docid did, double min_wt)
  The caller is required to ensure that the specified document id did actually exists in the database. If it does, it must move to that document id, and return true. If it does not, it may either: return true, having moved to a definite position (including "at_end"), which must be the same position as skip_to() would have moved to. or return false, having moved to an "indeterminate" position, such that a subsequent call to next() or skip_to() will move to the next matching position after did. Generally, this method should act like skip_to() and return true if that can be done at little extra cost. Otherwise it should simply check if a particular docid is present, returning true if it is, and false if it isn't. The default implementation calls skip_to() and always returns true. Xapian will always call init() on a PostingSource before calling this for the first time. Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.
  📌 Parameters:
  • did: The document id to check.
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).
• get_docid = PostingSource_get_docid(...) — Return the current docid.
  virtual Xapian::docid Xapian::PostingSource::get_docid() const =0
  This method may assume that it will only be called when there is a "current document". See get_weight() for details. Note: in the case of a multi-database search, the returned docid should be in the single subdatabase relevant to this posting source. See the init() method for details.
• get_maxweight = PostingSource_get_maxweight(...) — Return the currently set upper bound on what get_weight() can return.
  double Xapian::PostingSource::get_maxweight() const
• get_termfreq_est = PostingSource_get_termfreq_est(...) — An estimate of the number of documents this object can return.
  virtual Xapian::doccount Xapian::PostingSource::get_termfreq_est() const =0
  It must always be true that: get_termfreq_min() <= get_termfreq_est() <= get_termfreq_max()
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_termfreq_max = PostingSource_get_termfreq_max(...) — An upper bound on the number of documents this object can return.
  virtual Xapian::doccount Xapian::PostingSource::get_termfreq_max() const =0
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_termfreq_min = PostingSource_get_termfreq_min(...) — A lower bound on the number of documents this object can return.
  virtual Xapian::doccount Xapian::PostingSource::get_termfreq_min() const =0
  Xapian will always call init() on a PostingSource before calling this for the first time.
• get_weight = PostingSource_get_weight(...) — Return the weight contribution for the current document.
  virtual double Xapian::PostingSource::get_weight() const
  This default implementation always returns 0, for convenience when implementing "weight-less" PostingSource subclasses. This method may assume that it will only be called when there is a "current document". In detail: Xapian will always call init() on a PostingSource before calling this for the first time. It will also only call this if the PostingSource reports that it is pointing to a valid document (ie, it will not call it before calling at least one of next(), skip_to() or check(), and will ensure that the PostingSource is not at the end by calling at_end()).
• init = PostingSource_init(...) — Set this PostingSource to the start of the list of postings.
  virtual void Xapian::PostingSource::init(const Database &db)=0
  This is called automatically by the matcher prior to each query being processed. If a PostingSource is used for multiple searches, init() will therefore be called multiple times, and must handle this by using the database passed in the most recent call.
  📌 Parameters:
  • db: The database which the PostingSource should iterate through.
  Note: in the case of a multi-database search, a separate PostingSource will be used for each database (the separate PostingSources will be obtained using clone()), and each PostingSource will be passed one of the sub-databases as the db parameter here. The db parameter will therefore always refer to a single database. All docids passed to, or returned from, the PostingSource refer to docids in that single database, rather than in the multi- database.
• name = PostingSource_name(...) — Name of the posting source class.
  virtual std::string Xapian::PostingSource::name() const
  This is used when serialising and unserialising posting sources; for example, for performing remote searches. If the subclass is in a C++ namespace, the namespace should be included in the name, using "::" as a separator. For example, for a PostingSource subclass called "FooPostingSource" in the "Xapian" namespace the result of this call should be "Xapian::FooPostingSource". This should only be implemented if serialise() and unserialise() are also implemented. The default implementation returns an empty string. If this returns an empty string, Xapian will assume that serialise() and unserialise() are not implemented.
• release = PostingSource_release(...) — Start reference counting this object.
  const PostingSource* Xapian::PostingSource::release() const
  You can hand ownership of a dynamically allocated PostingSource object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.
• set_maxweight = PostingSource_set_maxweight(...) — Specify an upper bound on what get_weight() will return from now on.
  void Xapian::PostingSource::set_maxweight(double max_weight)
  This upper bound is used by the matcher to perform various optimisations, so if you can return a good bound, then matches will generally run faster. This method should be called after calling init(), and may be called during iteration if the upper bound drops. It is probably only useful to call from subclasses (it was actually a "protected" method prior to Xapian 1.3.4, but that makes it tricky to wrap for other languages). It is valid for the posting source to have returned a higher value from get_weight() earlier in the iteration, but the posting source must not return a higher value from get_weight() than the currently set upper bound, and the upper bound must not be increased (until init() has been called). If you don't call this method, the upper bound will default to 0, for convenience when implementing "weight-less" PostingSource subclasses.
  📌 Parameters:
  • max_weight: The upper bound to set.
• skip_to = PostingSource_skip_to(...) — Advance to the specified docid.
  virtual void Xapian::PostingSource::skip_to(Xapian::docid did, double min_wt)
  If the specified docid isn't in the list, position ourselves on the first document after it (or at_end() if no greater docids are present). If the current position is already the specified docid, this method will leave the position unmodified. If the specified docid is earlier than the current position, the behaviour is unspecified. A sensible behaviour would be to leave the current position unmodified, but it is also reasonable to move to the specified docid. The default implementation calls next() repeatedly, which works but skip_to() can often be implemented much more efficiently. Xapian will always call init() on a PostingSource before calling this for the first time. Note: in the case of a multi-database search, the docid specified is the docid in the single subdatabase relevant to this posting source. See the init() method for details.
  📌 Parameters:
  • did: The document id to advance to.
  • min_wt: The minimum weight contribution that is needed (this is just a hint which subclasses may ignore).

⚙️ Static methods defined here:

• __swig_destroy__ = delete_PostingSource(...) — virtual Xapian::PostingSource::~PostingSource()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 Query(builtins.object)

Query(*args)

Class representing a query.

🔧 Methods defined here:

• __init__ = _query_init(self, *args) — Make a new query object. Many possible arguments are possible - see the documentation for details.
• __iter__ = _query_gen_iter(self) — Get an iterator over the terms in a query. The iterator will return string objects.
• __repr__ = _swig_repr(self)
• __str__ = Query___str__(...) — Return a string describing this object.
  std::string Xapian::Query::get_description() const
• empty = Query_empty(...) — Check if this query is Xapian::Query::MatchNothing.
  bool Xapian::Query::empty() const
• get_length = Query_get_length(...) — Return the length of this query object.
  Xapian::termcount Xapian::Query::get_length() const
• get_num_subqueries = Query_get_num_subqueries(...) — Get the number of subqueries of the top level query.
  size_t Xapian::Query::get_num_subqueries() const
• get_subquery = Query_get_subquery(...) — Read a top level subquery.
  const Query Xapian::Query::get_subquery(size_t n) const
  📌 Parameters:
  • n: Return the n-th subquery (starting from 0) - only valid when 0 <= n < get_num_subqueries().
• get_type = Query_get_type(...) — Get the type of the top level of the query.
  op Xapian::Query::get_type() const
• get_unique_terms_begin = Query_get_unique_terms_begin(...) — Begin iterator for unique terms in the query object.
  const TermIterator Xapian::Query::get_unique_terms_begin() const
  Terms are sorted and terms with the same name removed from the list. If you want the terms in ascending query position order, see get_terms_begin().
• get_unique_terms_end = Query_get_unique_terms_end(...) — End iterator for unique terms in the query object.
  const TermIterator Xapian::Query::get_unique_terms_end() const
• serialise = Query_serialise(...) — Serialise this object into a string.
  std::string Xapian::Query::serialise() const

⚙️ Static methods defined here:

• __swig_destroy__ = delete_Query(...) — Destructor.
  Xapian::Query::~Query()
• unserialise = Query_unserialise(...)

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

🏷️ Data and other attributes defined here:

• MatchAll = <xapian.Query; proxy of <Swig Object of type 'Xapian::Query...'>
• MatchNothing = <xapian.Query; proxy of <Swig Object of type 'Xapian::Q...'>
• OP_AND = 0
• OP_AND_MAYBE = 4
• OP_AND_NOT = 2
• OP_ELITE_SET = 10
• OP_FILTER = 5
• OP_INVALID = 99
• OP_MAX = 14
• OP_NEAR = 6
• OP_OR = 1
• OP_PHRASE = 7
• OP_SCALE_WEIGHT = 9
• OP_SYNONYM = 13
• OP_VALUE_GE = 11
• OP_VALUE_LE = 12
• OP_VALUE_RANGE = 8
• OP_WILDCARD = 15
• OP_XOR = 3
• WILDCARD_LIMIT_ERROR = 0
• WILDCARD_LIMIT_FIRST = 1
• WILDCARD_LIMIT_MOST_FREQUENT = 2

---

📘 QueryParser(builtins.object)

Build a Xapian::Query object from a user query string.

🔧 Methods defined here:

• __init__(self) — Default constructor.
  Xapian::QueryParser::QueryParser()
• __repr__ = _swig_repr(self)
• __str__ = QueryParser___str__(...) — Return a string describing this object.
  std::string Xapian::QueryParser::get_description() const
• add_boolean_prefix = _queryparser_add_boolean_prefix(self, s, proc, exclusive=True) — Register a FieldProcessor for a boolean prefix.
  void Xapian::QueryParser::add_boolean_prefix(const std::string &field, Xapian::FieldProcessor *proc, bool exclusive)
  This is an older version of this method - use the version with the grouping parameter in preference to this one.
• add_prefix = _queryparser_add_prefix(self, s, proc) — Register a FieldProcessor.
  void Xapian::QueryParser::add_prefix(const std::string &field, Xapian::FieldProcessor *proc)
• add_rangeprocessor = _queryparser_add_rangeprocessor(self, rproc) — Register a RangeProcessor.
  void Xapian::QueryParser::add_rangeprocessor(Xapian::RangeProcessor *range_proc, const std::string *grouping=NULL)
• add_valuerangeprocessor = _queryparser_add_valuerangeprocessor(self, vrproc) — Register a ValueRangeProcessor.
  void Xapian::QueryParser::add_valuerangeprocessor(Xapian::ValueRangeProcessor *vrproc)
  This method is provided for API compatibility with Xapian 1.2.x and is deprecated - use add_rangeprocessor() with a RangeProcessor instead. Compatibility shim.
• get_corrected_query_string = QueryParser_get_corrected_query_string(...) — Get the spelling-corrected query string.
  std::string Xapian::QueryParser::get_corrected_query_string() const
  This will only be set if FLAG_SPELLING_CORRECTION is specified when QueryParser::parse_query() was last called. If there were no corrections, an empty string is returned.
• get_default_op = QueryParser_get_default_op(...) — Get the current default operator.
  Query::op Xapian::QueryParser::get_default_op() const
• parse_query = QueryParser_parse_query(...) — Parse a query.
  Query Xapian::QueryParser::parse_query(const std::string &query_string, unsigned flags=FLAG_DEFAULT, const std::string &default_prefix=std::string())
  📌 Parameters:
  • query_string: A free-text query as entered by a user
  • flags: Zero or more QueryParser::feature_flag specifying what features the QueryParser should support. Combine multiple values with bitwise-or (|) (default FLAG_DEFAULT).
  • default_prefix: The default term prefix to use (default none). For example, you can pass "A" when parsing an "Author" field.
  If the query string can't be parsed, then Xapian::QueryParserError is thrown. You can get an English error message to report to the user by catching it and calling get_msg() on the caught exception. The current possible values (in case you want to translate them) are: Unknown range operation, parse error, Syntax: <expression> AND <expression>, Syntax: <expression> AND NOT <expression>, Syntax: <expression> NOT <expression>, Syntax: <expression> OR <expression>, Syntax: <expression> XOR <expression>.
• set_database = QueryParser_set_database(...) — Specify the database being searched.
  void Xapian::QueryParser::set_database(const Database &db)
  📌 Parameters:
  • db: The database to use for spelling correction (FLAG_SPELLING_CORRECTION), and synonyms (FLAG_SYNONYM, FLAG_AUTO_SYNONYMS, and FLAG_AUTO_MULTIWORD_SYNONYMS).
• set_default_op = QueryParser_set_default_op(...) — Set the default operator.
  void Xapian::QueryParser::set_default_op(Query::op default_op)
  📌 Parameters:
  • default_op: The operator to use to combine non-filter query items when no explicit operator is used. So for example, 'weather forecast' is parsed as if it were 'weather OR forecast' by default. The most useful values for this are OP_OR (the default) and OP_AND. OP_NEAR, OP_PHRASE, OP_ELITE_SET, OP_SYNONYM and OP_MAX are also permitted. Passing other values will result in InvalidArgumentError being thrown.
• set_max_expansion = QueryParser_set_max_expansion(...) — Specify the maximum expansion of a wildcard and/or partial term.
  void Xapian::QueryParser::set_max_expansion(Xapian::termcount max_expansion, int max_type=Xapian::Query::WILDCARD_LIMIT_ERROR, unsigned flags=FLAG_WILDCARD|FLAG_PARTIAL)
  Note: you must also set FLAG_WILDCARD and/or FLAG_PARTIAL in the flags parameter to parse_query() for this setting to have anything to affect. If you don't call this method, the default settings are no limit on wildcard expansion, and partial terms expanding to the most frequent 100 terms - i.e. as if you'd called: set_max_expansion(0); set_max_expansion(100, Xapian::Query::WILDCARD_LIMIT_MOST_FREQUENT, Xapian::QueryParser::FLAG_PARTIAL);
  📌 Parameters:
  • max_expansion: The maximum number of terms each wildcard in the query can expand to, or 0 for no limit (which is the default).
  • max_type: Xapian::Query::WILDCARD_LIMIT_ERROR, Xapian::Query::WILDCARD_LIMIT_FIRST or Xapian::Query::WILDCARD_LIMIT_MOST_FREQUENT (default: Xapian::Query::WILDCARD_LIMIT_ERROR).
  • flags: What to set the limit for (default: FLAG_WILDCARD|FLAG_PARTIAL, setting the limit for both wildcards and partial terms).
  1.3.3
• set_max_wildcard_expansion = QueryParser_set_max_wildcard_expansion(...) — Specify the maximum expansion of a wildcard.
  void Xapian::QueryParser::set_max_wildcard_expansion(Xapian::termcount)
  If any wildcard expands to more than max_expansion terms, an exception will be thrown. This method is provided for API compatibility with Xapian 1.2.x and is deprecated - replace it with: set_max_wildcard_expansion(max_expansion, Xapian::Query::WILDCARD_LIMIT_ERROR, Xapian::QueryParser::FLAG_WILDCARD);
• set_stemmer = QueryParser_set_stemmer(...) — Set the stemmer.
  void Xapian::QueryParser::set_stemmer(const Xapian::Stem &stemmer)
  This sets the stemming algorithm which will be used by the query parser. The stemming algorithm will be used according to the stemming strategy set by set_stemming_strategy(). As of 1.3.1, this defaults to STEM_SOME, but in earlier versions the default was STEM_NONE. If you want to work with older versions, you should explicitly set a stemming strategy as well as setting a stemmer, otherwise your stemmer won't actually be used.
  📌 Parameters:
  • stemmer: The Xapian::Stem object to set.
• set_stemming_strategy = QueryParser_set_stemming_strategy(...) — Set the stemming strategy.
  void Xapian::QueryParser::set_stemming_strategy(stem_strategy strategy)
  This controls how the query parser will apply the stemming algorithm. Note that the stemming algorithm is only applied to words in free-text fields - boolean filter terms are never stemmed.
  📌 Parameters:
  • strategy: The strategy to use - possible values are: STEM_NONE: Don't perform any stemming. (default in Xapian <= 1.3.0) STEM_SOME: Stem all terms except for those which start with a capital letter, or are followed by certain characters (currently: (/@<>=*[{" ), or are used with operators which need positional information. Stemmed terms are prefixed with 'Z'. (default in Xapian >= 1.3.1) STEM_SOME_FULL_POS: Like STEM_SOME but also stems terms used with operators which need positional information. Added in Xapian 1.4.8. STEM_ALL: Stem all terms (note: no 'Z' prefix is added). STEM_ALL_Z: Stem all terms (note: 'Z' prefix is added). (new in Xapian 1.2.11 and 1.3.1)
• set_stopper = _queryparser_set_stopper(self, stopper) — Set the stopper.
  void Xapian::QueryParser::set_stopper(const Stopper *stop=NULL)
  📌 Parameters:
  • stop: The Stopper object to set (default NULL, which means no stopwords).
• stoplist = _queryparser_gen_stoplist_iter(self) — Get an iterator over all the stopped terms from the previous query. This returns an iterator over all the terms which were omitted from the previously parsed query due to being considered to be stopwords. Each instance of a word omitted from the query is represented in the returned list, in the order in which the The iterator will return string objects.
• unstemlist = _queryparser_gen_unstemlist_iter(self, tname) — Get an iterator over all the unstemmed forms of a stemmed term. This returns an iterator which returns all the unstemmed words which were stemmed to the stemmed form specified by `tname` when parsing the previous query. Each instance of a word which stems to `tname` is returned by the iterator in the order in which the words appeared in the query - an individual unstemmed word may thus occur multiple times. The iterator will return string objects.

⚙️ Static methods defined here:

• __swig_destroy__ = delete_QueryParser(...) — Destructor.
  Xapian::QueryParser::~QueryParser()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

🏷️ Data and other attributes defined here:

• FLAG_ACCUMULATE = 65536
• FLAG_AUTO_MULTIWORD_SYNONYMS = 1024
• FLAG_AUTO_SYNONYMS = 512
• FLAG_BOOLEAN = 1
• FLAG_BOOLEAN_ANY_CASE = 8
• FLAG_CJK_NGRAM = 2048
• FLAG_DEFAULT = 7
• FLAG_LOVEHATE = 4
• FLAG_PARTIAL = 64
• FLAG_PHRASE = 2
• FLAG_PURE_NOT = 32
• FLAG_SPELLING_CORRECTION = 128
• FLAG_SYNONYM = 256
• FLAG_WILDCARD = 16
• STEM_ALL = 2
• STEM_ALL_Z = 3
• STEM_NONE = 0
• STEM_SOME = 1
• STEM_SOME_FULL_POS = 4

---

📘 QueryParserError(RuntimeError)

QueryParserError(*args)

Indicates a query string can't be parsed.

📋 Method resolution order:

• QueryParserError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
  Xapian::QueryParserError::QueryParserError(const std::string &msg_, int errno_)
  📌 Parameters:
  • msg_: Message giving details of the error, intended for human consumption.
  • errno_: Optional errno value associated with this error.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

⚙️ Static methods defined here:

• __swig_destroy__ = delete_QueryParserError(...)

🏷️ Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

⬆️ Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  const std::string& Xapian::Error::get_context() const
  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  const char* Xapian::Error::get_error_string() const
  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.
• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  const std::string& Xapian::Error::get_msg() const
• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  const char* Xapian::Error::get_type() const

⬆️ Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

⬆️ Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

⬆️ Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

⬆️ Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📘 RSet(builtins.object)

A relevance set (R-Set). This is the set of documents which are marked as relevant, for use in modifying the term weights, and in performing query expansion.

🔧 Methods defined here:

• __init__(self) — Default constructor.
  Xapian::RSet::RSet()
• __repr__ = _swig_repr(self)
• __str__ = RSet___str__(...) — Return a string describing this object.
  std::string Xapian::RSet::get_description() const
• add_document = RSet_add_document(...) — Add a document to the relevance set.
  void Xapian::RSet::add_document(const Xapian::MSetIterator &i)
• contains = RSet_contains(...) — Test if a given document in the relevance set.
  bool Xapian::RSet::contains(const Xapian::MSetIterator &i) const
• empty = RSet_empty(...) — Test if this R-Set is empty.
  bool Xapian::RSet::empty() const
• remove_document = RSet_remove_document(...) — Remove a document from the relevance set.
  void Xapian::RSet::remove_document(const Xapian::MSetIterator &i)
• size = RSet_size(...) — The number of documents in this R-Set.
  Xapian::doccount Xapian::RSet::size() const

⚙️ Static methods defined here:

• __swig_destroy__ = delete_RSet(...) — Destructor.
  Xapian::RSet::~RSet()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 RangeError(RuntimeError)

RangeError(*args)

RangeError indicates an attempt to access outside the bounds of a container.

📋 Method resolution order:

• RangeError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

🔧 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
  Xapian::RangeError::RangeError(const std::string &msg_, int errno_)
  📌 Parameters:
  • msg_: Message giving details of the error, intended for human consumption.
  • errno_: Optional errno value associated with this error.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

⚙️ Static methods defined here:

• __swig_destroy__ = delete_RangeError(...)

🏷️ Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

⬆️ Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  const std::string& Xapian::Error::get_context() const
  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  const char* Xapian::Error::get_error_string() const
  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.
• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  const std::string& Xapian::Error::get_msg() const
• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  const char* Xapian::Error::get_type() const

⬆️ Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

⬆️ Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

⬆️ Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

⬆️ Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

📘 RangeProcessor(builtins.object)

RangeProcessor(*args)

Base class for range processors.

🔧 Methods defined here:

• __call__ = RangeProcessor___call__(...)
• __disown__(self)
• __init__(self, *args) — Constructor.
  Xapian::RangeProcessor::RangeProcessor(Xapian::valueno slot_, const std::string &str_=std::string(), unsigned flags_=0)
  📌 Parameters:
  • slot_: Which value slot to generate ranges over.
  • str_: A string to look for to recognise values as belonging to this range (as a prefix by default, or as a suffix if flags Xapian::RP_SUFFIX is specified).
  • flags_: Zero or more of the following flags, combined with bitwise-or (| in C++): Xapian::RP_SUFFIX - require str_ as a suffix instead of a prefix. Xapian::RP_REPEATED - optionally allow str_ on both ends of the range - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the end (e.g. 2..12kg).
• __repr__ = _swig_repr(self)
• check_range = RangeProcessor_check_range(...) — Check prefix/suffix on range.
  Xapian::Query Xapian::RangeProcessor::check_range(const std::string &b, const std::string &e)
  If they match, remove the prefix/suffix and then call operator()() to try to handle the range.
• release = RangeProcessor_release(...) — Start reference counting this object.
  const RangeProcessor* Xapian::RangeProcessor::release() const
  You can hand ownership of a dynamically allocated RangeProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

⚙️ Static methods defined here:

• __swig_destroy__ = delete_RangeProcessor(...) — Destructor.
  virtual Xapian::RangeProcessor::~RangeProcessor()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

📘 Registry(builtins.object)

Registry for user subclasses. This class provides a way for the remote server to look up user subclasses when unserialising.

🔧 Methods defined here:

• __init__(self) — Default constructor.
  Xapian::Registry::Registry()
  The registry will contain all standard subclasses of user-subclassable classes.
• __repr__ = _swig_repr(self)
• get_lat_long_metric = Registry_get_lat_long_metric(...) — Get a lat-long metric given a name.
  const Xapian::LatLongMetric* Xapian::Registry::get_lat_long_metric(const std::string &name) const
  The returned metric is owned by the registry object. Returns NULL if the metric could not be found.
• get_match_spy = Registry_get_match_spy(...) — Get a match spy given a name.
  const Xapian::MatchSpy* Xapian::Registry::get_match_spy(const std::string &name) const
  📌 Parameters:
  • name: The name of the match spy to find.
  An object with the requested name, or NULL if the match spy could not be found. The returned object is owned by the registry and so must not be deleted by the caller.
• get_posting_source = Registry_get_posting_source(...) — Get a posting source given a name.
  const Xapian::PostingSource* Xapian::Registry::get_posting_source(const std::string &name) const
  📌 Parameters:
  • name: The name of the posting source to find.
  An object with the requested name, or NULL if the posting source could not be found. The returned object is owned by the registry and so must not be deleted by the caller.
• get_weighting_scheme = Registry_get_weighting_scheme(...) — Get the weighting scheme given a name.
  const Xapian::Weight* Xapian::Registry::get_weighting_scheme(const std::string &name) const
  📌 Parameters:
  • name: The name of the weighting scheme to find.
  An object with the requested name, or NULL if the weighting scheme could not be found.

📦 CLASSES

🏷️ Registry

🔒 The returned object is owned by the registry and must not be deleted by the caller.

📋 Methods defined here:

• register_lat_long_metric = Registry_register_lat_long_metric(...) — Register a user-defined lat-long metric class.
  

  void Xapian::Registry::register_lat_long_metric(const Xapian::LatLongMetric &metric)

• register_match_spy = Registry_register_match_spy(...) — Register a user-defined match spy class.
  

  void Xapian::Registry::register_match_spy(const Xapian::MatchSpy &spy)

  • 📌 spy: The match spy to register.
• register_posting_source = Registry_register_posting_source(...) — Register a user-defined posting source class.
  

  void Xapian::Registry::register_posting_source(const Xapian::PostingSource &source)

  • 📌 source: The posting source to register.
• register_weighting_scheme = Registry_register_weighting_scheme(...) — Register a weighting scheme.
  

  void Xapian::Registry::register_weighting_scheme(const Xapian::Weight &wt)

  • 📌 wt: The weighting scheme to register.

🔧 Static methods defined here:

• __swig_destroy__ = delete_Registry(...) —

  Xapian::Registry::~Registry()

📊 Data descriptors defined here:

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)
• thisown — The membership flag

---

🏷️ RuntimeError

⚡ The base class for exceptions indicating errors only detectable at runtime.

A subclass of RuntimeError will be thrown if Xapian detects an error which is exception derived from RuntimeError is thrown when an error is caused by problems with the data or environment rather than a programming mistake.

🔗 Method resolution order:

• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

📋 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_RuntimeError(...)

📊 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📦 Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
  

  const std::string& Xapian::Error::get_context() const

  This context is intended for use by Xapian::ErrorHandler (for example so it can know which remote server is unreliable and report the problem and remove that server from those being searched). But it's typically a plain-text string, and so also fit for human consumption.

• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
  

  const char* Xapian::Error::get_error_string() const

  The system error string may come from errno, h_errno (on UNIX), or GetLastError() (on MS Windows). If there is no associated system error string, NULL is returned.

• get_msg = Error_get_msg(...) — Message giving details of the error, intended for human consumption.
  

  const std::string& Xapian::Error::get_msg() const

• get_type = Error_get_type(...) — The type of this error (e.g. "DocNotFoundError".)
  

  const char* Xapian::Error::get_type() const

📊 Data descriptors inherited from Error:

• __weakref__ — list of weak references to the object (if defined)

🔧 Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

📦 Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __setstate__(...)
• with_traceback(...) — Exception.with_traceback(tb) -- set self.__traceback__ to tb and return self.

📊 Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

---

🏷️ SerialisationError

⚠️ Indicates an error in the std::string serialisation of an object.

🔗 Method resolution order:

• SerialisationError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

📋 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
  

  Xapian::SerialisationError::SerialisationError(const std::string &msg_, int errno_)

  • 📌 msg_: Message giving details of the error, intended for human consumption.
  • 📌 errno_: Optional errno value associated with this error.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_SerialisationError(...)

📊 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📦 Methods inherited from Error:

• __str__ = Error___str__(...)
• get_context = Error_get_context(...) — Optional context information.
• get_error_string = Error_get_error_string(...) — Returns any system error string associated with this exception.
• get_msg = Error_get_msg(...) — Message giving details of the error.
• get_type = Error_get_type(...) — The type of this error.

📊 Data descriptors inherited from Error:

• __weakref__

🔧 Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type

📦 Methods inherited from builtins.BaseException:

• __delattr__, __getattribute__, __reduce__, __setstate__, with_traceback

📊 Data descriptors inherited from builtins.BaseException:

• __cause__, __context__, __dict__, __suppress_context__, __traceback__, args

---

🏷️ SimpleStopper

🛑 Simple implementation of Stopper class - this will suit most users.

🔗 Method resolution order:

• SimpleStopper
• Stopper
• builtins.object

📋 Methods defined here:

• __init__(self, *args) — Initialise from a pair of iterators.
  

  Xapian::SimpleStopper::SimpleStopper(Iterator begin, Iterator end)

  Xapian includes stop list files for many languages. You can initialise from a file like that:

• __repr__ = _swig_repr(self)
• add = SimpleStopper_add(...) — Add a single stop word.
  

  void Xapian::SimpleStopper::add(const std::string &word)

🔧 Static methods defined here:

• __swig_destroy__ = delete_SimpleStopper(...)

📊 Data descriptors defined here:

• thisown — The membership flag

📦 Methods inherited from Stopper:

• __call__ = Stopper___call__(...)
• __disown__(self)
• __str__ = Stopper___str__(...) — Return a string describing this object.
• release = Stopper_release(...) — Start reference counting this object.

📊 Data descriptors inherited from Stopper:

• __dict__
• __weakref__

---

🏷️ Stem

🌿 Class representing a stemming algorithm.

📋 Methods defined here:

• __call__ = Stem___call__(...)
• __init__ = _stem_init(self, *args) — Construct a Xapian::Stem object with a user-provided stemming algorithm.
  

  Xapian::Stem::Stem(StemImplementation *p)

  You can subclass Xapian::StemImplementation to implement your own stemming algorithm (or to wrap a third-party algorithm) and then wrap your implementation in a Xapian::Stem object to pass to the Xapian API.

  • 📌 p: The user-subclassed StemImplementation object. This is reference counted, and so will be automatically deleted by the Xapian::Stem wrapper when no longer required.
• __repr__ = _swig_repr(self)
• __str__ = Stem___str__(...) — Return a string describing this object.
• is_none = Stem_is_none(...) — Return true if this is a no-op stemmer.
  

  bool Xapian::Stem::is_none() const

🔧 Static methods defined here:

• __swig_destroy__ = delete_Stem(...) — Destructor.
• get_available_languages = Stem_get_available_languages(...)

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

🏷️ StemImplementation

🔧 Class representing a stemming algorithm implementation.

📋 Methods defined here:

• __call__ = StemImplementation___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.
• __repr__ = _swig_repr(self)
• __str__ = StemImplementation___str__(...) — Return a string describing this object.

🔧 Static methods defined here:

• __swig_destroy__ = delete_StemImplementation(...) — Virtual destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

🏷️ Stopper

🛑 Base class for stop-word decision functor.

📋 Methods defined here:

• __call__ = Stopper___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.
• __repr__ = _swig_repr(self)
• __str__ = Stopper___str__(...) — Return a string describing this object.
• release = Stopper_release(...) — Start reference counting this object.

🔧 Static methods defined here:

• __swig_destroy__ = delete_Stopper(...) — Virtual destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

🏷️ StringValueRangeProcessor

🔤 Handle a string range. The end points can be any strings. Deprecated: Use Xapian::RangeProcessor instead (added in 1.3.6).

🔗 Method resolution order:

• StringValueRangeProcessor
• ValueRangeProcessor
• builtins.object

📋 Methods defined here:

• __init__(self, *args) — Constructor.
  

  Xapian::StringValueRangeProcessor::StringValueRangeProcessor(Xapian::valueno slot_, const std::string &str_, bool prefix_=true)

  • 📌 slot_: The value number to return from operator().
  • 📌 str_: A string to look for to recognise values as belonging to this range.
  • 📌 prefix_: Flag specifying whether to check for str_ as a prefix or a suffix.
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_StringValueRangeProcessor(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from ValueRangeProcessor:

• __call__ = ValueRangeProcessor___call__(...)
• __disown__(self)
• release = ValueRangeProcessor_release(...) — Start reference counting this object.

📊 Data descriptors inherited from ValueRangeProcessor:

• __dict__
• __weakref__

---

🏷️ TermGenerator

📝 Parses a piece of text and generate terms. This module takes a piece of text and parses it to produce words which are then used to generate suitable terms for indexing. The terms generated are suitable for use with Query objects produced by the QueryParser class.

📋 Methods defined here:

• __init__(self) — Default constructor.
• __repr__ = _swig_repr(self)
• __str__ = TermGenerator___str__(...) — Return a string describing this object.
• get_document = TermGenerator_get_document(...) — Get the current document.
• get_termpos = TermGenerator_get_termpos(...) — Get the current term position.
• increase_termpos = TermGenerator_increase_termpos(...) — Increase the term position used by index_text.
  

  void Xapian::TermGenerator::increase_termpos(Xapian::termpos delta=100)

  This can be used between indexing text from different fields or other places to prevent phrase searches from spanning between them.

  • 📌 delta: Amount to increase the term position by (default: 100).
• index_text = TermGenerator_index_text(...) — Index some text in a std::string.
  

  void Xapian::TermGenerator::index_text(const std::string &text, Xapian::termcount wdf_inc=1, const std::string &prefix=std::string())

  • 📌 text: The text to index.
  • 📌 wdf_inc: The wdf increment (default 1).
  • 📌 prefix: The term prefix to use (default is no prefix).
• index_text_without_positions = TermGenerator_index_text_without_positions(...) — Index some text without positional information.
• set_database = TermGenerator_set_database(...) — Set the database to index spelling data to.
• set_document = TermGenerator_set_document(...) — Set the current document.
• set_flags = TermGenerator_set_flags(...) — Set flags.
• set_max_word_length = TermGenerator_set_max_word_length(...) — Set the maximum length word to index.
• set_stemmer = TermGenerator_set_stemmer(...) — Set the Xapian::Stem object.
• set_stemming_strategy = TermGenerator_set_stemming_strategy(...) — Set the stemming strategy.
• set_stopper = _termgenerator_set_stopper(self, stopper) — Set the Xapian::Stopper object.
• set_stopper_strategy = TermGenerator_set_stopper_strategy(...) — Set the stopper strategy.
• set_termpos = TermGenerator_set_termpos(...) — Set the current term position.

🔧 Static methods defined here:

• __swig_destroy__ = delete_TermGenerator(...) — Destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

📊 Data and other attributes defined here:

• FLAG_CJK_NGRAM = 2048
• FLAG_SPELLING = 128
• STEM_ALL = 2
• STEM_ALL_Z = 3
• STEM_NONE = 0
• STEM_SOME = 1
• STEM_SOME_FULL_POS = 4
• STOP_ALL = 1
• STOP_NONE = 0
• STOP_STEMMED = 2

---

🏷️ TermIter

🔁 An iterator over a term list. The iterator will return TermListItem objects, which will be evaluated lazily where appropriate.

📋 Methods defined here:

• __init__(self, start, end, has_termfreq=0, has_wdf=0, has_positions=0, return_strings=False)
• __iter__(self)
• __next__(self)
• skip_to(self, term) — Skip the iterator forward.

📊 Data and other attributes defined here:

• EAGER = 2
• INVALID = 0
• LAZY = 1

---

🏷️ TermListItem

📄 An item returned from iteration of a term list. Supports access to term, wdf, termfreq, and positer.

📋 Methods defined here:

• __init__(self, iter, term)

🔍 Readonly properties defined here:

• positer — A position iterator for the current term (if meaningful).
• termfreq — The term frequency of the current term (if meaningful).
• wdf — The within-document-frequency of the current term (if meaningful).

📊 Data descriptors defined here:

• term

---

🏷️ TfIdfWeight

⚖️ Xapian::Weight subclass implementing the tf-idf weighting scheme.

🔗 Method resolution order:

• TfIdfWeight
• Weight
• builtins.object

📋 Methods defined here:

• __init__(self, *args) — Construct a TfIdfWeight using the default normalizations ("ntn").
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_TfIdfWeight(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from Weight:

• get_maxextra — Return an upper bound on what get_sumextra() can return.
• get_maxpart — Return an upper bound on what get_sumpart() can return.
• get_sumextra — Calculate the term-independent weight component for a document.
• get_sumpart — Calculate the weight contribution for this object's term to a document.
• name — Return the name of this weighting scheme.

📊 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📊 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

🏷️ TradWeight

⚖️ Xapian::Weight subclass implementing the traditional probabilistic formula. BM25 generally gives better results.

🔗 Method resolution order:

• TradWeight
• Weight
• builtins.object

📋 Methods defined here:

• __init__(self, k=1.0) — Construct a TradWeight.
• __repr__ = _swig_repr(self)

🔧 Static methods defined here:

• __swig_destroy__ = delete_TradWeight(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from Weight:

• get_maxextra
• get_maxpart
• get_sumextra
• get_sumpart
• name

📊 Data descriptors inherited from Weight:

• __dict__
• __weakref__

📊 Data and other attributes inherited from Weight:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

🏷️ UnimplementedError

⚠️ UnimplementedError indicates an attempt to use an unimplemented feature.

🔗 Method resolution order:

• UnimplementedError
• LogicError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

📋 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_UnimplementedError(...)

📊 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📦 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📊 Data descriptors inherited from Error:

• __weakref__

🔧 Static methods inherited from builtins.Exception:

• __new__

📦 Methods inherited from builtins.BaseException:

• __delattr__, __getattribute__, __reduce__, __setstate__, with_traceback

📊 Data descriptors inherited from builtins.BaseException:

• __cause__, __context__, __dict__, __suppress_context__, __traceback__, args

---

🏷️ ValueCountMatchSpy

📊 Class for counting the frequencies of values in the matching documents.

🔗 Method resolution order:

• ValueCountMatchSpy
• MatchSpy
• builtins.object

📋 Methods defined here:

• __init__(self, *args) — Construct a MatchSpy which counts the values in a particular slot.
• __repr__ = _swig_repr(self)
• get_total = ValueCountMatchSpy_get_total(...) — Return the total number of documents tallied.
• top_values(self, maxvalues) — Get an iterator over the most frequent values for the slot.
• values(self) — Get an iterator over all the values in the slot.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValueCountMatchSpy(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from MatchSpy:

• __call__
• __disown__
• __str__ — Return a string describing this object.
• merge_results — Unserialise some results, and merge them into this matchspy.
• name — Return the name of this match spy.
• release — Start reference counting this object.

📊 Data descriptors inherited from MatchSpy:

• __dict__
• __weakref__

---

🏷️ ValueItem

📄 An item returned from iteration of the values in a document. Supports num and value attributes.

📋 Methods defined here:

• __init__(self, num, value)

📊 Data descriptors defined here:

• num
• value

---

🏷️ ValueIter

🔁 An iterator over all the values stored in a document. Returns ValueItem objects in ascending order of value number.

📋 Methods defined here:

• __init__(self, start, end)
• __iter__(self)
• __next__(self)

📊 Data descriptors defined here:

• __dict__
• __weakref__

---

🏷️ ValueMapPostingSource

🗺️ A posting source which looks up weights in a map using values as the key.

🔗 Method resolution order:

• ValueMapPostingSource
• ValuePostingSource
• PostingSource
• builtins.object

📋 Methods defined here:

• __init__(self, slot_) — Construct a ValueMapPostingSource.
• __repr__ = _swig_repr(self)
• add_mapping = ValueMapPostingSource_add_mapping(...) — Add a mapping.
• clear_mappings = ValueMapPostingSource_clear_mappings(...) — Clear all mappings.
• set_default_weight = ValueMapPostingSource_set_default_weight(...) — Set a default weight for document values not in the map.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValueMapPostingSource(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from ValuePostingSource:

• __disown__
• __next__ — Advance to next matching document.
• at_end — Return true if past last entry.
• check — Check if specified docid occurs.
• done — End the iteration.
• get_database — The database we're reading values from.
• get_docid — Return current docid.
• get_slot — The slot we're reading values from.
• get_started — Flag indicating if we've started.
• get_termfreq_est — Estimate of number of documents.
• get_termfreq_max — Upper bound.
• get_termfreq_min — Lower bound.
• get_value — Read current value.
• init — Set to start of list.
• set_termfreq_est — Set estimate.
• set_termfreq_max — Set upper bound.
• set_termfreq_min — Set lower bound.
• skip_to — Advance to specified docid.

📦 Methods inherited from PostingSource:

• __str__ — Description.
• get_maxweight — Upper bound on weight.
• get_weight — Weight contribution.
• name — Class name.
• release — Start reference counting.
• set_maxweight — Specify upper bound.

📊 Data descriptors inherited from PostingSource:

• __dict__
• __weakref__

---

🏷️ ValuePostingSource

📊 A posting source which generates weights from a value slot. Base class for ValueWeightPostingSource and ValueMapPostingSource.

🔗 Method resolution order:

• ValuePostingSource
• PostingSource
• builtins.object

📋 Methods defined here:

• __disown__(self)
• __init__(self, slot_) — Construct a ValuePostingSource.
• __next__ = ValuePostingSource___next__(...) — Advance to next matching document.
• __repr__ = _swig_repr(self)
• at_end
• check
• done
• get_database
• get_docid
• get_slot
• get_started
• get_termfreq_est
• get_termfreq_max
• get_termfreq_min
• get_value
• init
• set_termfreq_est
• set_termfreq_max
• set_termfreq_min
• skip_to

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValuePostingSource(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from PostingSource:

• __str__
• get_maxweight
• get_weight
• name
• release
• set_maxweight

📊 Data descriptors inherited from PostingSource:

• __dict__
• __weakref__

---

🏷️ ValueRangeProcessor

🔧 Base class for value range processors.

📋 Methods defined here:

• __call__ = ValueRangeProcessor___call__(...)
• __disown__(self)
• __init__(self) — Default constructor.
• __repr__ = _swig_repr(self)
• release = ValueRangeProcessor_release(...) — Start reference counting.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValueRangeProcessor(...) — Destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

---

🏷️ ValueSetMatchDecider

🔍 MatchDecider filtering results based on whether document values are in a user-defined set.

🔗 Method resolution order:

• ValueSetMatchDecider
• MatchDecider
• builtins.object

📋 Methods defined here:

• __init__(self, slot, inclusive_) — Construct a ValueSetMatchDecider.
• __repr__ = _swig_repr(self)
• add_value = ValueSetMatchDecider_add_value(...) — Add a value to the test set.
• remove_value = ValueSetMatchDecider_remove_value(...) — Remove a value from the test set.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValueSetMatchDecider(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from MatchDecider:

• __call__
• __disown__

📊 Data descriptors inherited from MatchDecider:

• __dict__
• __weakref__

---

🏷️ ValueStreamItem

📄 An item returned from iteration of the values in a document. Supports docid and value attributes.

📋 Methods defined here:

• __init__(self, docid, value)

📊 Data descriptors defined here:

• docid
• value

---

🏷️ ValueStreamIter

🔁 An iterator over all the values stored in a document. Returns ValueStreamItem objects in ascending order of value number.

📋 Methods defined here:

• __init__(self, start, end)
• __iter__(self)
• __next__(self)
• skip_to(self, docid) — Skip the iterator forward.

📊 Data descriptors defined here:

• __dict__
• __weakref__

---

🏷️ ValueWeightPostingSource

⚖️ A posting source which reads weights from a value slot. Uses sortable_unserialise to convert values to weights.

🔗 Method resolution order:

• ValueWeightPostingSource
• ValuePostingSource
• PostingSource
• builtins.object

📋 Methods defined here:

• __disown__(self)
• __init__(self, slot_) — Construct a ValueWeightPostingSource.
• __repr__ = _swig_repr(self)
• __str__ = ValueWeightPostingSource___str__(...) — Description.
• get_weight = ValueWeightPostingSource_get_weight(...) — Return weight contribution.
• init = ValueWeightPostingSource_init(...) — Set to start of list.
• name = ValueWeightPostingSource_name(...) — Class name.

🔧 Static methods defined here:

• __swig_destroy__ = delete_ValueWeightPostingSource(...)

📊 Data descriptors defined here:

• thisown

📦 Methods inherited from ValuePostingSource:

• __next__, at_end, check, done, get_database, get_docid, get_slot, get_started, get_termfreq_est, get_termfreq_max, get_termfreq_min, get_value, set_termfreq_est, set_termfreq_max, set_termfreq_min, skip_to

📦 Methods inherited from PostingSource:

• get_maxweight
• release
• set_maxweight

📊 Data descriptors inherited from PostingSource:

• __dict__
• __weakref__

---

🏷️ Weight

⚖️ Abstract base class for weighting schemes.

📋 Methods defined here:

• __init__(self, *args, **kwargs)
• __repr__ = _swig_repr(self)
• get_maxextra — Return an upper bound on what get_sumextra() can return for any document.
• get_maxpart — Return an upper bound on what get_sumpart() can return for any document.
• get_sumextra — Calculate the term-independent weight component for a document.
• get_sumpart — Calculate the weight contribution for this object's term to a document.
• name — Return the name of this weighting scheme.

🔧 Static methods defined here:

• __swig_destroy__ = delete_Weight(...) — Virtual destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

📊 Data and other attributes defined here:

• ABSOLUTE_DISCOUNT_SMOOTHING = 3
• DIRICHLET_PLUS_SMOOTHING = 5
• DIRICHLET_SMOOTHING = 2
• JELINEK_MERCER_SMOOTHING = 4
• TWO_STAGE_SMOOTHING = 1

---

🏷️ WildcardError

⚠️ WildcardError indicates an error expanding a wildcarded query.

🔗 Method resolution order:

• WildcardError
• RuntimeError
• Error
• builtins.Exception
• builtins.BaseException
• builtins.object

📋 Methods defined here:

• __getattr__ lambda self, name
• __init__(self, *args) — Construct from message and errno value.
• __repr__ = _swig_repr(self)
• __setattr__ lambda self, name, value

🔧 Static methods defined here:

• __swig_destroy__ = delete_WildcardError(...)

📊 Data and other attributes defined here:

• __swig_getmethods__ = {}
• __swig_setmethods__ = {}

📦 Methods inherited from Error:

• __str__
• get_context
• get_error_string
• get_msg
• get_type

📊 Data descriptors inherited from Error:

• __weakref__

🔧 Static methods inherited from builtins.Exception:

• __new__

📦 Methods inherited from builtins.BaseException:

• __delattr__, __getattribute__, __reduce__, __setstate__, with_traceback

📊 Data descriptors inherited from builtins.BaseException:

• __cause__, __context__, __dict__, __suppress_context__, __traceback__, args

---

🏷️ WritableDatabase

💾 This class provides read/write access to a database.

🔗 Method resolution order:

• WritableDatabase
• Database
• builtins.object

📋 Methods defined here:

• __init__(self, *args) — Copying is allowed. The internals are reference counted, so copying is cheap.
• __repr__ = _swig_repr(self)
• add_document = WritableDatabase_add_document(...) — Add a new document to the database. Returns a newly allocated document ID.
• add_spelling = WritableDatabase_add_spelling(...) — Add a word to the spelling dictionary.
• add_synonym = WritableDatabase_add_synonym(...) — Add a synonym for a term.
• begin_transaction = WritableDatabase_begin_transaction(...) — Begin a transaction.
• cancel_transaction = WritableDatabase_cancel_transaction(...) — Abort the transaction currently in progress.
• clear_synonyms = WritableDatabase_clear_synonyms(...) — Remove all synonyms for a term.
• commit = WritableDatabase_commit(...) — Commit any pending modifications made to the database.

🔧 Static methods defined here:

• __swig_destroy__ = delete_WritableDatabase(...) — Destructor.

📊 Data descriptors defined here:

• __dict__
• __weakref__
• thisown

📦 Methods inherited from Database:

• __str__, close, delete_document, get_avlength, get_doccount, get_doclength, get_document, get_lastdocid, get_metadata, get_revision, get_spelling_suggestion, get_termfreq, get_uuid, get_value_freq, get_value_lower_bound, get_value_upper_bound, has_positions, keep_alive, metadata_keys_begin, metadata_keys_end, positionlist_begin, postlist_begin, reopen, set_metadata, spellings_begin, synonyms_begin, synonym_keys_begin, termlist_begin, valuestream_begin

📊 Data descriptors inherited from Database:

• __dict__, __weakref__

🏛️ CLASSES

💾 commit

void Xapian::WritableDatabase::commit()

To ensure this, Xapian batches up modifications.

This method may be called at any time to commit any pending modifications to the database.

If any of the modifications fail, an exception will be thrown and the database will be left in a state in which each separate addition, replacement or deletion operation has either been fully performed or not performed at all: it is then up to the application to work out which operations need to be repeated.

It's not valid to call commit() within a transaction.

Beware of calling commit() too frequently: this will make indexing take much longer.

Note that commit() need not be called explicitly: it will be called automatically when the database is closed, or when a sufficient number of modifications have been made. By default, this is every 10000 documents added, deleted, or modified. This value is rather conservative, and if you have a machine with plenty of memory, you can improve indexing throughput dramatically by setting XAPIAN_FLUSH_THRESHOLD in the environment to a larger value.

This method was new in Xapian 1.1.0 - in earlier versions it was called flush().

📋 Parameters

• Xapian::DatabaseError: will be thrown if a problem occurs while modifying the database.
• Xapian::DatabaseCorruptError: will be thrown if the database is in a corrupt state.

💳 commit_transaction

commit_transaction = WritableDatabase_commit_transaction(...)

void Xapian::WritableDatabase::commit_transaction()

Complete the transaction currently in progress.

If this method completes successfully and this is a flushed transaction, all the database modifications made during the transaction will have been committed to the database.

If an error occurs, an exception will be thrown, and none of the modifications made to the database during the transaction will have been applied to the database.

In all cases the transaction will no longer be in progress.

📋 Parameters

• Xapian::DatabaseError: will be thrown if a problem occurs while modifying the database.
• Xapian::DatabaseCorruptError: will be thrown if the database is in a corrupt state.
• Xapian::InvalidOperationError: will be thrown if a transaction is not currently in progress.
• Xapian::UnimplementedError: will be thrown if transactions are not available for this database type.

🗑️ delete_document

delete_document = WritableDatabase_delete_document(...)

void Xapian::WritableDatabase::delete_document(const std::string &unique_term)

Delete any documents indexed by a term from the database.

This method removes any documents indexed by the specified term from the database.

A major use is for convenience when UIDs from another system are mapped to terms in Xapian, although this method has other uses (for example, you could add a "deletion date" term to documents at index time and use this method to delete all documents due for deletion on a particular date).

📋 Parameters

• unique_term: The term to remove references to.

📋 Parameters (Exceptions)

• Xapian::DatabaseError: will be thrown if a problem occurs while writing to the database.
• Xapian::DatabaseCorruptError: will be thrown if the database is in a corrupt state.

🔄 flush

flush = WritableDatabase_flush(...)

void Xapian::WritableDatabase::flush()

Pre-1.1.0 name for commit().

Use commit() instead.

✂️ remove_spelling

remove_spelling = WritableDatabase_remove_spelling(...)

void Xapian::WritableDatabase::remove_spelling(const std::string &word, Xapian::termcount freqdec=1) const

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 (default 1).

🔗 remove_synonym

remove_synonym = WritableDatabase_remove_synonym(...)

void Xapian::WritableDatabase::remove_synonym(const std::string &term, const std::string &synonym) const

Remove a synonym for a term.

📋 Parameters

• term: The term to remove a synonym for.
• synonym: The synonym to remove. If this isn't currently a synonym for term, then no action is taken.

🔁 replace_document

replace_document = WritableDatabase_replace_document(...)

Xapian::docid Xapian::WritableDatabase::replace_document(const std::string &unique_term, const Xapian::Document &document)

Replace any documents matching a term.

This method replaces any documents indexed by the specified term with the specified document. If any documents are indexed by the term, the lowest document ID will be used for the document, otherwise a new document ID will be generated as for add_document.

One common use is to allow UIDs from another system to easily be mapped to terms in Xapian. Note that this method doesn't automatically add unique_term as a term, so you'll need to call document.add_term(unique_term) first when using replace_document() in this way.

Note that changes to the database won't be immediately committed to disk; see commit() for more details.

As with all database modification operations, the effect is atomic: the document(s) will either be fully replaced, or the document(s) fail to be replaced and an exception is thrown (possibly at a later time when commit() is called or the database is closed).

📋 Parameters

• unique_term: The "unique" term.
• document: The new document.

The document ID that document was given.

📋 Parameters (Exceptions)

• Xapian::DatabaseError: will be thrown if a problem occurs while writing to the database.
• Xapian::DatabaseCorruptError: will be thrown if the database is in a corrupt state.

🏷️ set_metadata

set_metadata = WritableDatabase_set_metadata(...)

void Xapian::WritableDatabase::set_metadata(const std::string &key, const std::string &metadata)

Set the user-specified metadata associated with a given key.

This method sets the metadata value associated with a given key. If there is already a metadata value stored in the database with the same key, the old value is replaced. If you want to delete an existing item of metadata, just set its value to the empty string.

User-specified metadata allows you to store arbitrary information in the form of (key, value) pairs.

There's no hard limit on the number of metadata items, or the size of the metadata values. Metadata keys have a limited length, which depend on the backend. We recommend limiting them to 200 bytes. Empty keys are not valid, and specifying one will cause an exception.

Metadata modifications are committed to disk in the same way as modifications to the documents in the database are: i.e., modifications are atomic, and won't be committed to disk immediately (see commit() for more details). This allows metadata to be used to link databases with versioned external resources by storing the appropriate version number in a metadata item.

You can also use the metadata to store arbitrary extra information associated with terms, documents, or postings by encoding the termname and/or document id into the metadata key.

📋 Parameters

• key: The key of the metadata item to set.
• metadata: The value of the metadata item to set.

📋 Parameters (Exceptions)

• Xapian::DatabaseError: will be thrown if a problem occurs while writing to the database.
• Xapian::DatabaseCorruptError: will be thrown if the database is in a corrupt state.
• Xapian::InvalidArgumentError: will be thrown if the key supplied is empty.
• Xapian::UnimplementedError: will be thrown if the database backend in use doesn't support user-specified metadata.

---

🛠️ Static methods defined here

❌ __swig_destroy__

__swig_destroy__ = delete_WritableDatabase(...)

virtual Xapian::WritableDatabase::~WritableDatabase()

Destroy this handle on the database.

If no other handles to this database remain, the database will be closed.

If a transaction is active cancel_transaction() will be implicitly called; if no transaction is active commit() will be implicitly called, but any exception will be swallowed (because throwing exceptions in C++ destructors is problematic). If you aren't using transactions and want to know about any failure to commit changes, call commit() explicitly before the destructor gets called.

---

📦 Data descriptors defined here

• thisown: The membership flag

---

📚 Methods inherited from Database

• __iter__ = _database_gen_allterms_iter(self, prefix=None): Get an iterator over all the terms in the database. The iterator will return TermListItem objects, but these will not support access to wdf, or position information. Access to term frequency information is only available until the iterator has moved on. If prefix is supplied, only terms which start with that prefix will be returned.
• __str__ = Database___str__(...): Return a string describing this object. virtual std::string Xapian::Database::get_description() const
• add_database = Database_add_database(...): Add an existing database (or group of databases) to those accessed by this object. void Xapian::Database::add_database(const Database &database). Parameters: database: the database(s) to add.
• allterms = _database_gen_allterms_iter(self, prefix=None): Same as __iter__.
• close = Database_close(...): Close the database. virtual void Xapian::Database::close(). This closes the database and closes all its file handles. For a WritableDatabase, if a transaction is active it will be aborted, while if no transaction is active commit() will be implicitly called. Also the write lock is released. Closing a database cannot be undone - in particular, calling reopen() after close() will not reopen it, but will instead throw a Xapian::DatabaseError exception. Calling close() again on a database which has already been closed has no effect (and doesn't raise an exception). After close() has been called, calls to other methods of the database, and to methods of other objects associated with the database, will either behave exactly as they would have done if the database had not been closed (this can only happen if all the required data is cached) or raise a Xapian::DatabaseError exception indicating that the database is closed. This method was added in Xapian 1.1.0.
• compact = Database_compact(...): Produce a compact version of this database. void Xapian::Database::compact(int fd, unsigned flags, int block_size, Xapian::Compactor &compactor). New 1.3.4. Various methods of the Compactor class were deprecated in 1.3.4. The compactor functor allows handling progress output and specifying how user metadata is merged. This variant writes a single-file database to the specified file descriptor. Only the glass backend supports such databases, so this form is only supported for this backend. Parameters: fd: File descriptor to write the compact version to. The descriptor needs to be readable and writable (open with O_RDWR) and seekable. The current file offset is used, allowing compacting to a single file database embedded within another file. Xapian takes ownership of the file descriptor and will close it before returning. flags: Any of the following combined using bitwise-or (| in C++): Xapian::DBCOMPACT_NO_RENUMBER, Xapian::DBCOMPACT_MULTIPASS, Xapian::DBCOMPACT_SINGLE_FILE. block_size: This specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes. compactor: Functor.
• get_average_length = Database_get_average_length(...): New name for get_avlength(). double Xapian::Database::get_average_length() const. Added for forward compatibility with the next release series. 1.4.17.
• get_avlength = Database_get_avlength(...): Get the average length of the documents in the database. Xapian::doclength Xapian::Database::get_avlength() const.
• get_collection_freq = Database_get_collection_freq(...): Return the total number of occurrences of the given term. Xapian::termcount Xapian::Database::get_collection_freq(const std::string &tname) const. This is the sum of the number of occurrences of the term in each document it indexes: i.e., the sum of the within document frequencies of the term. Parameters: tname: The term whose collection frequency is being requested.
• get_doccount = Database_get_doccount(...): Get the number of documents in the database. Xapian::doccount Xapian::Database::get_doccount() const.
• get_doclength = Database_get_doclength(...): Get the length of a document. Xapian::termcount Xapian::Database::get_doclength(Xapian::docid did) const.
• get_doclength_lower_bound = Database_get_doclength_lower_bound(...): Get a lower bound on the length of a document in this DB. Xapian::termcount Xapian::Database::get_doclength_lower_bound() const. This bound does not include any zero-length documents.
• get_doclength_upper_bound = Database_get_doclength_upper_bound(...): Get an upper bound on the length of a document in this DB. Xapian::termcount Xapian::Database::get_doclength_upper_bound() const.
• get_document = Database_get_document(...): Get a document from the database, given its document id. Xapian::Document Xapian::Database::get_document(Xapian::docid did, unsigned flags) const. This method returns a Xapian::Document object which provides the information about a document. Parameters: did: The document id of the document to retrieve. flags: Zero or more flags bitwise-or-ed together (currently only Xapian::DOC_ASSUME_VALID is supported). Returns a Xapian::Document object containing the document data. Exceptions: Xapian::DocNotFoundError, Xapian::InvalidArgumentError.
• get_lastdocid = Database_get_lastdocid(...): Get the highest document id which has been used in the database. Xapian::docid Xapian::Database::get_lastdocid() const.
• get_metadata = Database_get_metadata(...): Get the user-specified metadata associated with a given key. std::string Xapian::Database::get_metadata(const std::string &key) const. User-specified metadata allows you to store arbitrary information in the form of (key, value) pairs. See WritableDatabase::set_metadata() for more information. When invoked on a Xapian::Database object representing multiple databases, currently only the metadata for the first is considered but this behaviour may change in the future. If there is no piece of metadata associated with the specified key, an empty string is returned (this applies even for backends which don't support metadata). Empty keys are not valid, and specifying one will cause an exception. Parameters: key: The key of the metadata item to access. Returns the retrieved metadata item's value. Exceptions: Xapian::InvalidArgumentError.
• get_revision = Database_get_revision(...): Get the revision of the database. Xapian::rev Xapian::Database::get_revision() const. The revision is an unsigned integer which increases with each commit. The database must have exactly one sub-database, which must be of type chert or glass. Otherwise an exception will be thrown. Experimental - see deprecation docs.
• get_spelling_suggestion = Database_get_spelling_suggestion(...): Suggest a spelling correction. std::string Xapian::Database::get_spelling_suggestion(const std::string &word, unsigned max_edit_distance=2) const. Parameters: word: The potentially misspelled word. max_edit_distance: Only consider words which are at most max_edit_distance edits from word. An edit is a character insertion, deletion, or the transposition of two adjacent characters (default is 2).
• get_termfreq = Database_get_termfreq(...): Get the number of documents in the database indexed by a given term. Xapian::doccount Xapian::Database::get_termfreq(const std::string &tname) const.
• get_total_length = Database_get_total_length(...): Get the total length of all the documents in the database. Xapian::totallength Xapian::Database::get_total_length() const. Added in Xapian 1.4.5.
• get_unique_terms = Database_get_unique_terms(...): Get the number of unique terms in document. Xapian::termcount Xapian::Database::get_unique_terms(Xapian::docid did) const.
• get_uuid = Database_get_uuid(...): Get a UUID for the database. std::string Xapian::Database::get_uuid() const. The UUID will persist for the lifetime of the database. Replicas (eg, made with the replication protocol, or by copying all the database files) will have the same UUID. However, copies (made with copydatabase, or xapian-compact) will have different UUIDs. If the backend does not support UUIDs or this database has no subdatabases, the UUID will be empty. If this database has multiple sub-databases, the UUID string will contain the UUIDs of all the sub-databases.
• get_value_freq = Database_get_value_freq(...): Return the frequency of a given value slot. Xapian::doccount Xapian::Database::get_value_freq(Xapian::valueno slot) const. This is the number of documents which have a (non-empty) value stored in the slot. Parameters: slot: The value slot to examine.
• get_value_lower_bound = Database_get_value_lower_bound(...): Get a lower bound on the values stored in the given value slot. std::string Xapian::Database::get_value_lower_bound(Xapian::valueno slot) const. If there are no values stored in the given value slot, this will return an empty string. Parameters: slot: The value slot to examine.
• get_value_upper_bound = Database_get_value_upper_bound(...): Get an upper bound on the values stored in the given value slot. std::string Xapian::Database::get_value_upper_bound(Xapian::valueno slot) const. If there are no values stored in the given value slot, this will return an empty string. Parameters: slot: The value slot to examine.
• get_wdf_upper_bound = Database_get_wdf_upper_bound(...): Get an upper bound on the wdf of term term. Xapian::termcount Xapian::Database::get_wdf_upper_bound(const std::string &term) const.
• has_positions = Database_has_positions(...): Does this database have any positional information? bool Xapian::Database::has_positions() const.
• keep_alive = Database_keep_alive(...): Send a "keep-alive" to remote databases to stop them timing out. void Xapian::Database::keep_alive(). Has no effect on non-remote databases.
• locked = Database_locked(...): Test if this database is currently locked for writing. bool Xapian::Database::locked() const. If the underlying object is actually a WritableDatabase, always returns true. Otherwise tests 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). If there's an error while trying to test the lock, throws Xapian::DatabaseLockError. For multi-databases, this tests each sub-database and returns true if any of them are locked.
• metadata_keys = _database_gen_metadata_keys_iter(self, prefix=''): Get an iterator which returns all the metadata keys. The iterator will return string objects. If `prefix` is non-empty, only metadata keys with this prefix are returned.
• positionlist = _database_gen_positionlist_iter(self, docid, tname): Get an iterator over all the positions in a given document of a term. The iterator will return integers, in ascending order.
• postlist = _database_gen_postlist_iter(self, tname): Get an iterator over the postings which are indexed by a given term. If `tname` is empty, an iterator over all the documents will be returned (this will contain one entry for each document, will always return a wdf of 1, and will not allow access to a position iterator).
• reopen = Database_reopen(...): Re-open the database. bool Xapian::Database::reopen(). This re-opens the database(s) to the latest available version(s). It can be used either to make sure the latest results are returned, or to recover from a Xapian::DatabaseModifiedError. Calling reopen() on a database which has been closed (with close()) will always raise a Xapian::DatabaseError. Returns true if the database might have been reopened (if false is returned, the database definitely hasn't been reopened, which applications may find useful when caching results, etc). In Xapian < 1.3.0, this method did not return a value.
• size = Database_size(...): Return number of shards in this Database object. size_t Xapian::Database::size() const.
• spellings = _database_gen_spellings_iter(self): Get an iterator which returns all the spelling correction targets. The iterator will return TermListItem objects. Only the term frequency is available; wdf and positions are not meaningful.
• synonym_keys = _database_gen_synonym_keys_iter(self, prefix=''): Get an iterator which returns all the terms which have synonyms. The iterator will return string objects. If `prefix` is non-empty, only terms with this prefix are returned.
• synonyms = _database_gen_synonyms_iter(self, term): Get an iterator which returns all the synonyms for a given term. The term to return synonyms for is specified by the `term` parameter. The iterator will return string objects.
• term_exists = Database_term_exists(...): Check if a given term exists in the database. bool Xapian::Database::term_exists(const std::string &tname) const. Parameters: tname: The term to test the existence of. Returns true if and only if the term exists in the database. This is the same as (get_termfreq(tname) != 0), but will often be more efficient.
• termlist = _database_gen_termlist_iter(self, docid): Get an iterator over all the terms which index a given document ID. The iterator will return TermListItem objects. Access to term frequency and position information is only available until the iterator has moved on.
• valuestream(self, slot): Get an iterator over all the values stored in a slot in the database. The iterator will return ValueStreamItem objects, in ascending order of document id.

🛠️ Static methods inherited from Database

• check = Database_check(...)

📦 Data descriptors inherited from Database

• __dict__: dictionary for instance variables (if defined)
• __weakref__: list of weak references to the object (if defined)

🛠️ FUNCTIONS

• Database_check(...)
• __add__(...)
• __eq__(...) — Return self==value.
• __ge__(...) — Return self >= value.
• __gt__(...) — Return self > value.
• __le__(...) — Return self

  📊 DATA

  📌 Constant	🔢 Value
  📊 BAD_VALUENO	4294967295
  🔍 DBCHECK_FIX	16
  🔍 DBCHECK_FULL_TREE	2
  🔍 DBCHECK_SHORT_TREE	1
  🔍 DBCHECK_SHOW_FREELIST	4
  🔍 DBCHECK_SHOW_STATS	8
  🗜️ DBCOMPACT_MULTIPASS	8
  🗜️ DBCOMPACT_NO_RENUMBER	4
  🗜️ DBCOMPACT_SINGLE_FILE	16
  🗄️ DB_BACKEND_CHERT	512
  🗄️ DB_BACKEND_GLASS	256
  🗄️ DB_BACKEND_INMEMORY	1024
  🗄️ DB_BACKEND_STUB	768
  📁 DB_CREATE	2
  📁 DB_CREATE_OR_OPEN	0
  📁 DB_CREATE_OR_OVERWRITE	1
  📁 DB_DANGEROUS	16
  📁 DB_FULL_SYNC	8
  📁 DB_NO_SYNC	4
  📁 DB_NO_TERMLIST	32
  📁 DB_OPEN	3
  📁 DB_RETRY_LOCK	64
  ✅ DOC_ASSUME_VALID	1
  📅 RP_DATE_PREFER_MDY	4
  📅 RP_REPEATED	2
  📅 RP_SUFFIX	1
  📋 __all__	('AssertionError', 'BAD_VALUENO', 'BB2Weight', 'BM25PlusWeig...
  📋 __docformat__	'restructuredtext en'

  🏷️ VERSION

  1.4.18

  📄 FILE

  /usr/lib/python3/dist-packages/xapian/__init__.py

📖 NAME 📖 DESCRIPTION 📦 PACKAGE CONTENTS 📚 CLASSES 🏛️ CLASSES 📦 CLASSES 📦 CLASSES 🏛️ CLASSES 🛠️ FUNCTIONS 📊 DATA 🏷️ VERSION 📄 FILE