{
    "mode": "pydoc",
    "parameter": "xapian",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/pydoc/xapian/json",
    "generated": "2026-06-02T15:56:11Z",
    "sections": {
        "NAME": {
            "content": "xapian\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Xapian is a highly adaptable toolkit which allows developers to easily\nadd advanced indexing and search facilities to their own applications.\nIt has built-in support for several families of weighting models\nand also supports a rich set of boolean query operators.\n\nIn addition to the doc strings provided by this python library, you\nmay wish to look at the library's overall documentation, either\ninstalled along with the bindings or online at\n<https://xapian.org/docs/bindings/python/>, as well as the library's\ndocumentation, possibly installed with the library or with its\ndevelopment files, or again online at <https://xapian.org/docs/>.\n",
            "subsections": []
        },
        "PACKAGE CONTENTS": {
            "content": "xapian\n",
            "subsections": []
        },
        "CLASSES": {
            "content": "builtins.Exception(builtins.BaseException)\nError\nLogicError\nAssertionError\nInvalidArgumentError\nInvalidOperationError\nUnimplementedError\nRuntimeError\nDatabaseError\nDatabaseClosedError\nDatabaseCorruptError\nDatabaseCreateError\nDatabaseLockError\nDatabaseModifiedError\nDatabaseOpeningError\nDatabaseNotFoundError\nDatabaseVersionError\nDocNotFoundError\nFeatureUnavailableError\nInternalError\nNetworkError\nNetworkTimeoutError\nQueryParserError\nRangeError\nSerialisationError\nWildcardError\nbuiltins.object\nCompactor\nDatabase\nWritableDatabase\nDocument\nESet\nESetItem\nESetIter\nEnquire\nExpandDecider\nExpandDeciderAnd\nExpandDeciderFilterPrefix\nFieldProcessor\nKeyMaker\nLatLongDistanceKeyMaker\nMultiValueKeyMaker\nLatLongCoord\nLatLongCoords\nLatLongCoordsIter\nLatLongMetric\nGreatCircleMetric\nMSet\nMSetItem\nMSetIter\nMatchDecider\nValueSetMatchDecider\nMatchSpy\nValueCountMatchSpy\nPositionIter\nPostingItem\nPostingIter\nPostingSource\nFixedWeightPostingSource\nValuePostingSource\nLatLongDistancePostingSource\nValueMapPostingSource\nValueWeightPostingSource\nDecreasingValueWeightPostingSource\nQuery\nQueryParser\nRSet\nRangeProcessor\nDateRangeProcessor\nNumberRangeProcessor\nRegistry\nStem\nStemImplementation\nStopper\nSimpleStopper\nTermGenerator\nTermIter\nTermListItem\nValueItem\nValueIter\nValueRangeProcessor\nStringValueRangeProcessor\nDateValueRangeProcessor\nNumberValueRangeProcessor\nValueStreamItem\nValueStreamIter\nWeight\nBB2Weight\nBM25PlusWeight\nBM25Weight\nBoolWeight\nCoordWeight\nDLHWeight\nDPHWeight\nIfB2Weight\nInL2Weight\nIneB2Weight\nLMWeight\nPL2PlusWeight\nPL2Weight\nTfIdfWeight\nTradWeight\n",
            "subsections": [
                {
                    "name": "class AssertionError",
                    "content": "|  AssertionError(*args)\n|\n|  AssertionError is thrown if a logical assertion inside Xapian fails.\n|\n|  In a debug build of Xapian, a failed assertion in the core library\n|  code will cause AssertionError to be thrown.\n|\n|  This represents a bug in Xapian (either an invariant, precondition,\n|  etc has been violated, or the assertion is incorrect!)\n|\n|  Method resolution order:\n|      AssertionError\n|      LogicError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::AssertionError::AssertionError(const std::string &msg, int\n|      errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteAssertionError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class BB2Weight",
                    "content": "|  BB2Weight(*args)\n|\n|  This class implements the BB2 weighting scheme.\n|\n|  BB2 is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  It uses the Bose-Einstein probabilistic distribution (B) along with\n|  Stirling's power approximation, the Bernoulli method to find the\n|  aftereffect of sampling (B) and the second wdf normalization proposed\n|  by Amati to normalize the wdf in the document to the length of the\n|  document (H2).\n|\n|  For more information about the DFR Framework and the BB2 scheme,\n|  please refer to : Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389.\n|\n|  Method resolution order:\n|      BB2Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::BB2Weight::BB2Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteBB2Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class BM25PlusWeight",
                    "content": "|  BM25PlusWeight(*args)\n|\n|  Xapian::Weight subclass implementing the BM25+ probabilistic formula.\n|\n|  Method resolution order:\n|      BM25PlusWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::BM25PlusWeight::BM25PlusWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteBM25PlusWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class BM25Weight",
                    "content": "|  BM25Weight(*args)\n|\n|  Xapian::Weight subclass implementing the BM25 probabilistic formula.\n|\n|  Method resolution order:\n|      BM25Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::BM25Weight::BM25Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteBM25Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class BoolWeight",
                    "content": "|  Class implementing a \"boolean\" weighting scheme.\n|\n|  This weighting scheme gives all documents zero weight.\n|\n|  Method resolution order:\n|      BoolWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Construct a BoolWeight.\n|\n|      Xapian::BoolWeight::BoolWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteBoolWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class Compactor",
                    "content": "|  Compact a database, or merge and compact several.\n|\n|  Methods defined here:\n|\n|  disown(self)\n|\n|  init(self)\n|      Xapian::Compactor::Compactor()\n|\n|  repr = swigrepr(self)\n|\n|  addsource = Compactoraddsource(...)\n|      Add a source database.\n|\n|      void Xapian::Compactor::addsource(const std::string &srcdir)\n|\n|      Deprecated Use Database::compact(destdir[, compactor]) instead.\n|\n|      Parameters:\n|      -----------\n|\n|      srcdir:  The path to the source database to add.\n|\n|  compact = Compactorcompact(...)\n|      Perform the actual compaction/merging operation.\n|\n|      void Xapian::Compactor::compact()\n|\n|      Deprecated Use Database::compact(destdir[, compactor]) instead.\n|\n|  resolveduplicatemetadata = Compactorresolveduplicatemetadata(...)\n|      Resolve multiple user metadata entries with the same key.\n|\n|      virtual std::string\n|      Xapian::Compactor::resolveduplicatemetadata(const std::string &key,\n|      sizet numtags, const std::string tags[])\n|\n|      When merging, if the same user metadata key is set in more than one\n|      input, then this method is called to allow this to be resolving in an\n|      appropriate way.\n|\n|      The default implementation just returns tags[0].\n|\n|      For multipass this will currently get called multiple times for the\n|      same key if there are duplicates to resolve in each pass, but this may\n|      change in the future.\n|\n|      Since 1.4.6, an implementation of this method can return an empty\n|      string to indicate that the appropriate result is to not set a value\n|      for this user metadata key in the output database. In older versions,\n|      you should not return an empty string.\n|\n|      Parameters:\n|      -----------\n|\n|      key:  The metadata key with duplicate entries.\n|\n|      numtags:  How many tags there are.\n|\n|      tags:  An array of numtags strings containing the tags to merge.\n|\n|  setblocksize = Compactorsetblocksize(...)\n|      Set the block size to use for tables in the output database.\n|\n|      void Xapian::Compactor::setblocksize(sizet blocksize)\n|\n|      Parameters:\n|      -----------\n|\n|      blocksize:  The block size to use. Valid block sizes are currently\n|      powers of two between 2048 and 65536, with the default being 8192, but\n|      the valid sizes and default may change in the future.\n|\n|  setcompactionlevel = Compactorsetcompactionlevel(...)\n|      Set the compaction level.\n|\n|      void Xapian::Compactor::setcompactionlevel(compactionlevel\n|      compaction)\n|\n|      Parameters:\n|      -----------\n|\n|      compaction:  Available values are:  Xapian::Compactor::STANDARD -\n|      Don't split items unnecessarily.\n|\n|      Xapian::Compactor::FULL - Split items whenever it saves space (the\n|      default).\n|\n|      Xapian::Compactor::FULLER - Allow oversize items to save more space\n|      (not recommended if you ever plan to update the compacted database).\n|\n|  setdestdir = Compactorsetdestdir(...)\n|      Set where to write the output.\n|\n|      void Xapian::Compactor::setdestdir(const std::string &destdir)\n|\n|      Deprecated Use Database::compact(destdir[, compactor]) instead.\n|\n|      Parameters:\n|      -----------\n|\n|      destdir:  Output path. This can be the same as an input if that input\n|      is a stub database (in which case the database(s) listed in the stub\n|      will be compacted to a new database and then the stub will be\n|      atomically updated to point to this new database).\n|\n|  setmultipass = Compactorsetmultipass(...)\n|      Set whether to merge postlists in multiple passes.\n|\n|      void Xapian::Compactor::setmultipass(bool multipass)\n|\n|      Parameters:\n|      -----------\n|\n|      multipass:  If true and merging more than 3 databases, merge the\n|      postlists in multiple passes, which is generally faster but requires\n|      more disk space for temporary files. By default we don't do this.\n|\n|  setrenumber = Compactorsetrenumber(...)\n|      Set whether to preserve existing document id values.\n|\n|      void Xapian::Compactor::setrenumber(bool renumber)\n|\n|      Parameters:\n|      -----------\n|\n|      renumber:  The default is true, which means that document ids will be\n|      renumbered - currently by applying the same offset to all the document\n|      ids in a particular source database.\n|\n|      If false, then the document ids must be unique over all source\n|      databases. Currently the ranges of document ids in each source must\n|      not overlap either, though this restriction may be removed in the\n|      future.\n|\n|  setstatus = Compactorsetstatus(...)\n|      Update progress.\n|\n|      virtual void Xapian::Compactor::setstatus(const std::string &table,\n|      const std::string &status)\n|\n|      Subclass this method if you want to get progress updates during\n|      compaction. This is called for each table first with empty status, And\n|      then one or more times with non-empty status.\n|\n|      The default implementation does nothing.\n|\n|      Parameters:\n|      -----------\n|\n|      table:  The table currently being compacted.\n|\n|      status:  A status message.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteCompactor(...)\n|      virtual\n|      Xapian::Compactor::~Compactor()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  FULL = 1\n|\n|  FULLER = 2\n|\n|  STANDARD = 0\n"
                },
                {
                    "name": "class CoordWeight",
                    "content": "|  Xapian::Weight subclass implementing Coordinate Matching.\n|\n|  Each matching term score one point. See Managing Gigabytes, Second\n|  Edition p181.\n|\n|  Method resolution order:\n|      CoordWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Construct a CoordWeight.\n|\n|      Xapian::CoordWeight::CoordWeight()\n|\n|  repr = swigrepr(self)\n|\n|  init = CoordWeightinit(...)\n|      Allow the subclass to perform any initialisation it needs to.\n|\n|      void Xapian::CoordWeight::init(double factor)\n|\n|      Parameters:\n|      -----------\n|\n|      factor:  Any scaling factor (e.g. from OPSCALEWEIGHT). If the Weight\n|      object is for the term-independent weight supplied by\n|      getsumextra()/getmaxextra(), then init(0.0) is called (starting from\n|      Xapian 1.2.11 and 1.3.1 - earlier versions failed to call init() for\n|      such Weight objects).\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteCoordWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class DLHWeight",
                    "content": "|  This class implements the DLH weighting scheme, which is a\n|  representative scheme of the Divergence from Randomness Framework by\n|  Gianni Amati.\n|\n|  This is a parameter free weighting scheme and it should be used with\n|  query expansion to obtain better results. It uses the HyperGeometric\n|  Probabilistic model and Laplace's normalization to calculate the risk\n|  gain.\n|\n|  For more information about the DFR Framework and the DLH scheme,\n|  please refer to : a.) Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389. b.) FUB, IASI-CNR and University of\n|  Tor Vergata at TREC 2007 Blog Track. G. Amati and E. Ambrosi and M.\n|  Bianchi and C. Gaibisso and G. Gambosi. Proceedings of the 16th Text\n|  REtrieval Conference (TREC-2007), 2008.\n|\n|  Method resolution order:\n|      DLHWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Xapian::DLHWeight::DLHWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDLHWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class DPHWeight",
                    "content": "|  This class implements the DPH weighting scheme.\n|\n|  DPH is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  This is a parameter free weighting scheme and it should be used with\n|  query expansion to obtain better results. It uses the HyperGeometric\n|  Probabilistic model and Popper's normalization to calculate the risk\n|  gain.\n|\n|  For more information about the DFR Framework and the DPH scheme,\n|  please refer to : a.) Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389. b.) FUB, IASI-CNR and University of\n|  Tor Vergata at TREC 2007 Blog Track. G. Amati and E. Ambrosi and M.\n|  Bianchi and C. Gaibisso and G. Gambosi. Proceedings of the 16th Text\n|  Retrieval Conference (TREC-2007), 2008.\n|\n|  Method resolution order:\n|      DPHWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Construct a DPHWeight.\n|\n|      Xapian::DPHWeight::DPHWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDPHWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class Database",
                    "content": "|  Database(*args)\n|\n|  This class is used to access a database, or a group of databases.\n|\n|  For searching, this class is used in conjunction with an Enquire\n|  object.\n|\n|  Parameters:\n|  -----------\n|\n|  InvalidArgumentError:  will be thrown if an invalid argument is\n|  supplied, for example, an unknown database type.\n|\n|  DatabaseOpeningError:  may be thrown if the database cannot be opened\n|  (for example, a required file cannot be found).\n|\n|  DatabaseVersionError:  may be thrown if the database is in an\n|  unsupported format (for example, created by a newer version of Xapian\n|  which uses an incompatible format).\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Copying is allowed.\n|\n|      Xapian::Database::Database(const Database &other)\n|\n|      The internals are reference counted, so copying is cheap.\n|\n|      Parameters:\n|      -----------\n|\n|      other:  The object to copy.\n|\n|  iter = databasegenalltermsiter(self, prefix=None)\n|      Get an iterator over all the terms in the database.\n|\n|      The iterator will return TermListItem objects, but these will not support\n|      access to wdf, or position information.\n|\n|      Access to term frequency information is only available until the iterator\n|      has moved on.\n|\n|      If prefix is supplied, only terms which start with that prefix will be\n|      returned.\n|\n|  repr = swigrepr(self)\n|\n|  str = Databasestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::Database::getdescription() const\n|\n|  adddatabase = Databaseadddatabase(...)\n|      Add an existing database (or group of databases) to those accessed by\n|      this object.\n|\n|      void Xapian::Database::adddatabase(const Database &database)\n|\n|      Parameters:\n|      -----------\n|\n|      database:  the database(s) to add.\n|\n|  allterms = databasegenalltermsiter(self, prefix=None)\n|      Get an iterator over all the terms in the database.\n|\n|      The iterator will return TermListItem objects, but these will not support\n|      access to wdf, or position information.\n|\n|      Access to term frequency information is only available until the iterator\n|      has moved on.\n|\n|      If prefix is supplied, only terms which start with that prefix will be\n|      returned.\n|\n|  close = Databaseclose(...)\n|      Close the database.\n|\n|      virtual void Xapian::Database::close()\n|\n|      This closes the database and closes all its file handles.\n|\n|      For a WritableDatabase, if a transaction is active it will be aborted,\n|      while if no transaction is active commit() will be implicitly called.\n|      Also the write lock is released.\n|\n|      Closing a database cannot be undone - in particular, calling reopen()\n|      after close() will not reopen it, but will instead throw a\n|      Xapian::DatabaseError exception.\n|\n|      Calling close() again on a database which has already been closed has\n|      no effect (and doesn't raise an exception).\n|\n|      After close() has been called, calls to other methods of the database,\n|      and to methods of other objects associated with the database, will\n|      either:\n|\n|      behave exactly as they would have done if the database had not been\n|      closed (this can only happen if all the required data is cached)\n|\n|      raise a Xapian::DatabaseError exception indicating that the database\n|      is closed.\n|\n|      The reason for this behaviour is that otherwise we'd have to check\n|      that the database is still open on every method call on every object\n|      associated with a Database, when in many cases they are working on\n|      data which has already been loaded and so they are able to just behave\n|      correctly.\n|\n|      This method was added in Xapian 1.1.0.\n|\n|  compact = Databasecompact(...)\n|      Produce a compact version of this database.\n|\n|      void Xapian::Database::compact(int fd, unsigned flags, int blocksize,\n|      Xapian::Compactor &compactor)\n|\n|      New 1.3.4. Various methods of the Compactor class were deprecated in\n|      1.3.4.\n|\n|      The compactor functor allows handling progress output and specifying\n|      how user metadata is merged.\n|\n|      This variant writes a single-file database to the specified file\n|      descriptor. Only the glass backend supports such databases, so this\n|      form is only supported for this backend.\n|\n|      Parameters:\n|      -----------\n|\n|      fd:  File descriptor to write the compact version to. The descriptor\n|      needs to be readable and writable (open with ORDWR) and seekable. The\n|      current file offset is used, allowing compacting to a single file\n|      database embedded within another file. Xapian takes ownership of the\n|      file descriptor and will close it before returning.\n|\n|      flags:  Any of the following combined using bitwise-or (| in C++):\n|      Xapian::DBCOMPACTNORENUMBER By default the document ids will be\n|      renumbered the output - currently by applying the same offset to all\n|      the document ids in a particular source database. If this flag is\n|      specified, then this renumbering doesn't happen, but all the document\n|      ids must be unique over all source databases. Currently the ranges of\n|      document ids in each source must not overlap either, though this\n|      restriction may be removed in the future.\n|\n|      Xapian::DBCOMPACTMULTIPASS If merging more than 3 databases, merge\n|      the postlists in multiple passes, which is generally faster but\n|      requires more disk space for temporary files.\n|\n|      Xapian::DBCOMPACTSINGLEFILE Produce a single-file database (only\n|      supported for glass currently) - this flag is implied in this form and\n|      need not be specified explicitly.\n|\n|      blocksize:  This specifies the block size (in bytes) for to use for\n|      the output. For glass, the block size must be a power of 2 between\n|      2048 and 65536 (inclusive), and the default (also used if an invalid\n|      value is passed) is 8192 bytes.\n|\n|      compactor:  Functor\n|\n|  getaveragelength = Databasegetaveragelength(...)\n|      New name for getavlength().\n|\n|      double Xapian::Database::getaveragelength() const\n|\n|      Added for forward compatibility with the next release series.\n|\n|      1.4.17.\n|\n|  getavlength = Databasegetavlength(...)\n|      Get the average length of the documents in the database.\n|\n|      Xapian::doclength Xapian::Database::getavlength() const\n|\n|  getcollectionfreq = Databasegetcollectionfreq(...)\n|      Return the total number of occurrences of the given term.\n|\n|      Xapian::termcount Xapian::Database::getcollectionfreq(const\n|      std::string &tname) const\n|\n|      This is the sum of the number of occurrences of the term in each\n|      document it indexes: i.e., the sum of the within document frequencies\n|      of the term.\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The term whose collection frequency is being requested.\n|\n|  getdoccount = Databasegetdoccount(...)\n|      Get the number of documents in the database.\n|\n|      Xapian::doccount Xapian::Database::getdoccount() const\n|\n|  getdoclength = Databasegetdoclength(...)\n|      Get the length of a document.\n|\n|      Xapian::termcount Xapian::Database::getdoclength(Xapian::docid did)\n|      const\n|\n|  getdoclengthlowerbound = Databasegetdoclengthlowerbound(...)\n|      Get a lower bound on the length of a document in this DB.\n|\n|      Xapian::termcount Xapian::Database::getdoclengthlowerbound() const\n|\n|      This bound does not include any zero-length documents.\n|\n|  getdoclengthupperbound = Databasegetdoclengthupperbound(...)\n|      Get an upper bound on the length of a document in this DB.\n|\n|      Xapian::termcount Xapian::Database::getdoclengthupperbound() const\n|\n|  getdocument = Databasegetdocument(...)\n|      Get a document from the database, given its document id.\n|\n|      Xapian::Document Xapian::Database::getdocument(Xapian::docid did,\n|      unsigned flags) const\n|\n|      This method returns a Xapian::Document object which provides the\n|      information about a document.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id of the document to retrieve.\n|\n|      flags:  Zero or more flags bitwise-or-ed together (currently only\n|      Xapian::DOCASSUMEVALID is supported).\n|\n|      A Xapian::Document object containing the document data\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DocNotFoundError:  The document specified could not be found\n|      in the database.\n|\n|      Xapian::InvalidArgumentError:  did was 0, which is not a valid\n|      document id.\n|\n|  getlastdocid = Databasegetlastdocid(...)\n|      Get the highest document id which has been used in the database.\n|\n|      Xapian::docid Xapian::Database::getlastdocid() const\n|\n|  getmetadata = Databasegetmetadata(...)\n|      Get the user-specified metadata associated with a given key.\n|\n|      std::string Xapian::Database::getmetadata(const std::string &key)\n|      const\n|\n|      User-specified metadata allows you to store arbitrary information in\n|      the form of (key, value) pairs. See  WritableDatabase::setmetadata()\n|      for more information.\n|\n|      When invoked on a Xapian::Database object representing multiple\n|      databases, currently only the metadata for the first is considered but\n|      this behaviour may change in the future.\n|\n|      If there is no piece of metadata associated with the specified key, an\n|      empty string is returned (this applies even for backends which don't\n|      support metadata).\n|\n|      Empty keys are not valid, and specifying one will cause an exception.\n|\n|      Parameters:\n|      -----------\n|\n|      key:  The key of the metadata item to access.\n|\n|      The retrieved metadata item's value.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the key supplied is\n|      empty.\n|\n|  getrevision = Databasegetrevision(...)\n|      Get the revision of the database.\n|\n|      Xapian::rev Xapian::Database::getrevision() const\n|\n|      The revision is an unsigned integer which increases with each commit.\n|\n|      The database must have exactly one sub-database, which must be of type\n|      chert or glass. Otherwise an exception will be thrown.\n|\n|      Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|      features\n|\n|  getspellingsuggestion = Databasegetspellingsuggestion(...)\n|      Suggest a spelling correction.\n|\n|      std::string Xapian::Database::getspellingsuggestion(const\n|      std::string &word, unsigned maxeditdistance=2) const\n|\n|      Parameters:\n|      -----------\n|\n|      word:  The potentially misspelled word.\n|\n|      maxeditdistance:  Only consider words which are at most\n|      maxeditdistance edits from word. An edit is a character insertion,\n|      deletion, or the transposition of two adjacent characters (default is\n|      2).\n|\n|  gettermfreq = Databasegettermfreq(...)\n|      Get the number of documents in the database indexed by a given term.\n|\n|      Xapian::doccount Xapian::Database::gettermfreq(const std::string\n|      &tname) const\n|\n|  gettotallength = Databasegettotallength(...)\n|      Get the total length of all the documents in the database.\n|\n|      Xapian::totallength Xapian::Database::gettotallength() const\n|\n|      Added in Xapian 1.4.5.\n|\n|  getuniqueterms = Databasegetuniqueterms(...)\n|      Get the number of unique terms in document.\n|\n|      Xapian::termcount Xapian::Database::getuniqueterms(Xapian::docid\n|      did) const\n|\n|  getuuid = Databasegetuuid(...)\n|      Get a UUID for the database.\n|\n|      std::string Xapian::Database::getuuid() const\n|\n|      The UUID will persist for the lifetime of the database.\n|\n|      Replicas (eg, made with the replication protocol, or by copying all\n|      the database files) will have the same UUID. However, copies (made\n|      with copydatabase, or xapian-compact) will have different UUIDs.\n|\n|      If the backend does not support UUIDs or this database has no\n|      subdatabases, the UUID will be empty.\n|\n|      If this database has multiple sub-databases, the UUID string will\n|      contain the UUIDs of all the sub-databases.\n|\n|  getvaluefreq = Databasegetvaluefreq(...)\n|      Return the frequency of a given value slot.\n|\n|      Xapian::doccount Xapian::Database::getvaluefreq(Xapian::valueno\n|      slot) const\n|\n|      This is the number of documents which have a (non-empty) value stored\n|      in the slot.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getvaluelowerbound = Databasegetvaluelowerbound(...)\n|      Get a lower bound on the values stored in the given value slot.\n|\n|      std::string Xapian::Database::getvaluelowerbound(Xapian::valueno\n|      slot) const\n|\n|      If there are no values stored in the given value slot, this will\n|      return an empty string.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getvalueupperbound = Databasegetvalueupperbound(...)\n|      Get an upper bound on the values stored in the given value slot.\n|\n|      std::string Xapian::Database::getvalueupperbound(Xapian::valueno\n|      slot) const\n|\n|      If there are no values stored in the given value slot, this will\n|      return an empty string.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getwdfupperbound = Databasegetwdfupperbound(...)\n|      Get an upper bound on the wdf of term term.\n|\n|      Xapian::termcount Xapian::Database::getwdfupperbound(const\n|      std::string &term) const\n|\n|  haspositions = Databasehaspositions(...)\n|      Does this database have any positional information?\n|\n|      bool Xapian::Database::haspositions() const\n|\n|  keepalive = Databasekeepalive(...)\n|      Send a \"keep-alive\" to remote databases to stop them timing out.\n|\n|      void Xapian::Database::keepalive()\n|\n|      Has no effect on non-remote databases.\n|\n|  locked = Databaselocked(...)\n|      Test if this database is currently locked for writing.\n|\n|      bool Xapian::Database::locked() const\n|\n|      If the underlying object is actually a WritableDatabase, always\n|      returns true.\n|\n|      Otherwise tests if there's a writer holding the lock (or if we can't\n|      test for a lock without taking it on the current platform, throw\n|      Xapian::UnimplementedError). If there's an error while trying to test\n|      the lock, throws Xapian::DatabaseLockError.\n|\n|      For multi-databases, this tests each sub-database and returns true if\n|      any of them are locked.\n|\n|  metadatakeys = databasegenmetadatakeysiter(self, prefix='')\n|      Get an iterator which returns all the metadata keys.\n|\n|      The iterator will return string objects.\n|\n|      If `prefix` is non-empty, only metadata keys with this prefix are returned.\n|\n|  positionlist = databasegenpositionlistiter(self, docid, tname)\n|      Get an iterator over all the positions in a given document of a term.\n|\n|      The iterator will return integers, in ascending order.\n|\n|  postlist = databasegenpostlistiter(self, tname)\n|      Get an iterator over the postings which are indexed by a given term.\n|\n|      If `tname` is empty, an iterator over all the documents will be returned\n|      (this will contain one entry for each document, will always return a wdf of\n|      1, and will not allow access to a position iterator).\n|\n|  reopen = Databasereopen(...)\n|      Re-open the database.\n|\n|      bool Xapian::Database::reopen()\n|\n|      This re-opens the database(s) to the latest available version(s). It\n|      can be used either to make sure the latest results are returned, or to\n|      recover from a Xapian::DatabaseModifiedError.\n|\n|      Calling reopen() on a database which has been closed (with  close())\n|      will always raise a Xapian::DatabaseError.\n|\n|      true if the database might have been reopened (if false is returned,\n|      the database definitely hasn't been reopened, which applications may\n|      find useful when caching results, etc). In Xapian < 1.3.0, this method\n|      did not return a value.\n|\n|  size = Databasesize(...)\n|      Return number of shards in this Database object.\n|\n|      sizet Xapian::Database::size() const\n|\n|  spellings = databasegenspellingsiter(self)\n|      Get an iterator which returns all the spelling correction targets\n|\n|      The iterator will return TermListItem objects.  Only the term frequency is\n|      available; wdf and positions are not meaningful.\n|\n|  synonymkeys = databasegensynonymkeysiter(self, prefix='')\n|      Get an iterator which returns all the terms which have synonyms.\n|\n|      The iterator will return string objects.\n|\n|      If `prefix` is non-empty, only terms with this prefix are returned.\n|\n|  synonyms = databasegensynonymsiter(self, term)\n|      Get an iterator which returns all the synonyms for a given term.\n|\n|      The term to return synonyms for is specified by the `term` parameter.\n|\n|      The iterator will return string objects.\n|\n|  termexists = Databasetermexists(...)\n|      Check if a given term exists in the database.\n|\n|      bool Xapian::Database::termexists(const std::string &tname) const\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The term to test the existence of.\n|\n|      true if and only if the term exists in the database. This is the same\n|      as (gettermfreq(tname) != 0), but will often be more efficient.\n|\n|  termlist = databasegentermlistiter(self, docid)\n|      Get an iterator over all the terms which index a given document ID.\n|\n|      The iterator will return TermListItem objects.\n|\n|      Access to term frequency and position information is only available until\n|      the iterator has moved on.\n|\n|  valuestream(self, slot)\n|      Get an iterator over all the values stored in a slot in the database.\n|\n|      The iterator will return ValueStreamItem objects, in ascending order of\n|      document id.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabase(...)\n|      Destroy this handle on the database.\n|\n|      virtual Xapian::Database::~Database()\n|\n|      If there are no copies of this object remaining, the database(s) will\n|      be closed.\n|\n|  check = Databasecheck(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class DatabaseClosedError",
                    "content": "|  DatabaseClosedError(*args)\n|\n|  Indicates an attempt to access a closed database.\n|\n|  Method resolution order:\n|      DatabaseClosedError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseClosedError::DatabaseClosedError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseClosedError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseCorruptError",
                    "content": "|  DatabaseCorruptError(*args)\n|\n|  DatabaseCorruptError indicates database corruption was detected.\n|\n|  Method resolution order:\n|      DatabaseCorruptError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseCorruptError::DatabaseCorruptError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseCorruptError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseCreateError",
                    "content": "|  DatabaseCreateError(*args)\n|\n|  DatabaseCreateError indicates a failure to create a database.\n|\n|  Method resolution order:\n|      DatabaseCreateError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseCreateError::DatabaseCreateError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseCreateError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseError",
                    "content": "|  DatabaseError(*args)\n|\n|  DatabaseError indicates some sort of database related error.\n|\n|  Method resolution order:\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseError::DatabaseError(const std::string &msg, int\n|      errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseLockError",
                    "content": "|  DatabaseLockError(*args)\n|\n|  DatabaseLockError indicates failure to lock a database.\n|\n|  Method resolution order:\n|      DatabaseLockError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseLockError::DatabaseLockError(const std::string &msg,\n|      int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseLockError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseModifiedError",
                    "content": "|  DatabaseModifiedError(*args)\n|\n|  DatabaseModifiedError indicates a database was modified.\n|\n|  To recover after catching this error, you need to call\n|  Xapian::Database::reopen() on the Database and repeat the operation\n|  which failed.\n|\n|  Method resolution order:\n|      DatabaseModifiedError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseModifiedError::DatabaseModifiedError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseModifiedError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseNotFoundError",
                    "content": "|  DatabaseNotFoundError(*args)\n|\n|  Indicates an attempt to access a database not present.\n|\n|  Method resolution order:\n|      DatabaseNotFoundError\n|      DatabaseOpeningError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseNotFoundError::DatabaseNotFoundError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseNotFoundError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseOpeningError",
                    "content": "|  DatabaseOpeningError(*args)\n|\n|  DatabaseOpeningError indicates failure to open a database.\n|\n|  Method resolution order:\n|      DatabaseOpeningError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseOpeningError::DatabaseOpeningError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseOpeningError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DatabaseVersionError",
                    "content": "|  DatabaseVersionError(*args)\n|\n|  DatabaseVersionError indicates that a database is in an unsupported\n|  format.\n|\n|  From time to time, new versions of Xapian will require the database\n|  format to be changed, to allow new information to be stored or new\n|  optimisations to be performed. Backwards compatibility will sometimes\n|  be maintained, so that new versions of Xapian can open old databases,\n|  but in some cases Xapian will be unable to open a database because it\n|  is in too old (or new) a format. This can be resolved either be\n|  upgrading or downgrading the version of Xapian in use, or by\n|  rebuilding the database from scratch with the current version of\n|  Xapian.\n|\n|  Method resolution order:\n|      DatabaseVersionError\n|      DatabaseOpeningError\n|      DatabaseError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DatabaseVersionError::DatabaseVersionError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDatabaseVersionError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class DateRangeProcessor",
                    "content": "|  DateRangeProcessor(*args)\n|\n|  Handle a date range.\n|\n|  Begin and end must be dates in a recognised format.\n|\n|  Method resolution order:\n|      DateRangeProcessor\n|      RangeProcessor\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::DateRangeProcessor::DateRangeProcessor(Xapian::valueno slot,\n|      const std::string &str, unsigned flags=0, int epochyear=1970)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot number to query.\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      date range.\n|\n|      flags:  Zero or more of the following flags, combined with bitwise-\n|      or: Xapian::RPSUFFIX - require str as a suffix instead of a prefix.\n|\n|      Xapian::RPREPEATED - optionally allow str on both ends of the range\n|      - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on\n|      the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the\n|      end (e.g. 2..12kg).\n|\n|      Xapian::RPDATEPREFERMDY - interpret ambiguous dates as\n|      month/day/year rather than day/month/year.\n|\n|      epochyear:  Year to use as the epoch for dates with 2 digit years\n|      (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).\n|\n|      The string supplied in str is used by operator() to decide whether\n|      the pair of strings supplied to it constitute a valid range. If\n|      prefix is true, the first value in a range must begin with str (and\n|      the second value may optionally begin with str); if prefix is false,\n|      the second value in a range must end with str (and the first value\n|      may optionally end with str).\n|\n|      If str is empty, the Xapian::RPSUFFIX and Xapian::RPREPEATED are\n|      irrelevant, and no special strings are required at the start or end of\n|      the strings defining the range.\n|\n|      The remainder of both strings defining the endpoints must be valid\n|      dates.\n|\n|      For example, if str is \"created:\", Xapian::RPSUFFIX is not\n|      specified, and the range processor has been added to the queryparser,\n|      the queryparser will accept \"created:1/1/2000..31/12/2001\".\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDateRangeProcessor(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from RangeProcessor:\n|\n|  call = RangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  checkrange = RangeProcessorcheckrange(...)\n|      Check prefix/suffix on range.\n|\n|      Xapian::Query Xapian::RangeProcessor::checkrange(const std::string\n|      &b, const std::string &e)\n|\n|      If they match, remove the prefix/suffix and then call operator()() to\n|      try to handle the range.\n|\n|  release = RangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const RangeProcessor* Xapian::RangeProcessor::release() const\n|\n|      You can hand ownership of a dynamically allocated RangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from RangeProcessor:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class DateValueRangeProcessor",
                    "content": "|  DateValueRangeProcessor(*args)\n|\n|  Handle a date range.\n|\n|  Begin and end must be dates in a recognised format.\n|\n|  Deprecated Use Xapian::DateRangeProcessor instead (added in 1.3.6).\n|\n|  Method resolution order:\n|      DateValueRangeProcessor\n|      StringValueRangeProcessor\n|      ValueRangeProcessor\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::DateValueRangeProcessor::DateValueRangeProcessor(Xapian::valueno\n|      slot, const char *str, bool prefix=true, bool prefermdy=false,\n|      int epochyear=1970)\n|\n|      This is like the previous version, but with const char * instead of\n|      std::string - we need this overload as otherwise\n|      DateValueRangeProcessor(1, \"date:\") quietly interprets the second\n|      argument as a boolean in preference to std::string. If you want to be\n|      compatible with 1.2.12 and earlier, then explicitly convert to\n|      std::string, i.e.: DateValueRangeProcessor(1, std::string(\"date:\"))\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value number to return from operator().\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      date range.\n|\n|      prefix:  Whether to look for the string at the start or end of the\n|      values. If true, the string is a prefix; if false, the string is a\n|      suffix (default: true).\n|\n|      prefermdy:  Should ambiguous dates be interpreted as month/day/year\n|      rather than day/month/year? (default: false)\n|\n|      epochyear:  Year to use as the epoch for dates with 2 digit years\n|      (default: 1970, so 1/1/69 is 2069 while 1/1/70 is 1970).\n|\n|      The string supplied in str is used by operator() to decide whether\n|      the pair of strings supplied to it constitute a valid range. If\n|      prefix is true, the first value in a range must begin with str (and\n|      the second value may optionally begin with str); if prefix is false,\n|      the second value in a range must end with str (and the first value\n|      may optionally end with str).\n|\n|      If str is empty, the setting of prefix is irrelevant, and no special\n|      strings are required at the start or end of the strings defining the\n|      range.\n|\n|      The remainder of both strings defining the endpoints must be valid\n|      dates.\n|\n|      For example, if str is \"created:\" and prefix is true, and the\n|      range processor has been added to the queryparser, the queryparser\n|      will accept \"created:1/1/2000..31/12/2001\".\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDateValueRangeProcessor(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValueRangeProcessor:\n|\n|  call = ValueRangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  release = ValueRangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const ValueRangeProcessor* Xapian::ValueRangeProcessor::release()\n|      const\n|\n|      You can hand ownership of a dynamically allocated ValueRangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from ValueRangeProcessor:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class DecreasingValueWeightPostingSource",
                    "content": "|  DecreasingValueWeightPostingSource(slot, rangestart=0, rangeend=0)\n|\n|  Read weights from a value which is known to decrease as docid\n|  increases.\n|\n|  This posting source can be used, like ValueWeightPostingSource, to add\n|  a weight contribution to a query based on the values stored in a slot.\n|  The values in the slot must be serialised as by  sortableserialise().\n|\n|  However, this posting source is additionally given a range of document\n|  IDs, within which the weight is known to be decreasing. ie, for all\n|  documents with ids A and B within this range (including the\n|  endpoints), where A is less than B, the weight of A is less than or\n|  equal to the weight of B. This can allow the posting source to skip to\n|  the end of the range quickly if insufficient weight is left in the\n|  posting source for a particular source.\n|\n|  By default, the range is assumed to cover all document IDs.\n|\n|  The ordering property can be arranged at index time, or by sorting an\n|  indexed database to produce a new, sorted, database.\n|\n|  Method resolution order:\n|      DecreasingValueWeightPostingSource\n|      ValueWeightPostingSource\n|      ValuePostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, slot, rangestart=0, rangeend=0)\n|      Construct a DecreasingValueWeightPostingSource.\n|\n|      Xapian::DecreasingValueWeightPostingSource::DecreasingValueWeightPostingSource(Xapian::valueno\n|      slot, Xapian::docid rangestart=0, Xapian::docid rangeend=0)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to read values from.\n|\n|      rangestart:  Start of range of docids for which weights are known to\n|      be decreasing (default: first docid)\n|\n|      rangeend:  End of range of docids for which weights are known to be\n|      decreasing (default: last docid)\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDecreasingValueWeightPostingSource(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValueWeightPostingSource:\n|\n|  disown(self)\n|\n|  str = ValueWeightPostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::ValueWeightPostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  getweight = ValueWeightPostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      double Xapian::ValueWeightPostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  init = ValueWeightPostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      void Xapian::ValueWeightPostingSource::init(const Database &db)\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  name = ValueWeightPostingSourcename(...)\n|      Name of the posting source class.\n|\n|      std::string Xapian::ValueWeightPostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValuePostingSource:\n|\n|  next = ValuePostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      void Xapian::ValuePostingSource::next(double minwt)\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  atend = ValuePostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      bool Xapian::ValuePostingSource::atend() const\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = ValuePostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      bool Xapian::ValuePostingSource::check(Xapian::docid mindocid, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  done = ValuePostingSourcedone(...)\n|      End the iteration.\n|\n|      void Xapian::ValuePostingSource::done()\n|\n|      Calls to atend() will return true after calling this method.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdatabase = ValuePostingSourcegetdatabase(...)\n|      The database we're reading values from.\n|\n|      Xapian::Database Xapian::ValuePostingSource::getdatabase() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdocid = ValuePostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      Xapian::docid Xapian::ValuePostingSource::getdocid() const\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getslot = ValuePostingSourcegetslot(...)\n|      The slot we're reading values from.\n|\n|      Xapian::valueno Xapian::ValuePostingSource::getslot() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getstarted = ValuePostingSourcegetstarted(...)\n|      Flag indicating if we've started (true if we have).\n|\n|      bool Xapian::ValuePostingSource::getstarted() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  gettermfreqest = ValuePostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqest() const\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = ValuePostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmax() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = ValuePostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmin() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getvalue = ValuePostingSourcegetvalue(...)\n|      Read current value.\n|\n|      std::string Xapian::ValuePostingSource::getvalue() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqest = ValuePostingSourcesettermfreqest(...)\n|      An estimate of the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqest(Xapian::doccount\n|      termfreqest)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmax = ValuePostingSourcesettermfreqmax(...)\n|      An upper bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmax(Xapian::doccount\n|      termfreqmax)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmin = ValuePostingSourcesettermfreqmin(...)\n|      Set a lower bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmin(Xapian::doccount\n|      termfreqmin)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods to return fewer documents.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  skipto = ValuePostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      void Xapian::ValuePostingSource::skipto(Xapian::docid mindocid,\n|      double minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class DocNotFoundError",
                    "content": "|  DocNotFoundError(*args)\n|\n|  Indicates an attempt to access a document not present in the database.\n|\n|  Method resolution order:\n|      DocNotFoundError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::DocNotFoundError::DocNotFoundError(const std::string &msg,\n|      int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDocNotFoundError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class Document",
                    "content": "|  A handle representing a document in a Xapian database.\n|\n|  The Document class fetches information from the database lazily.\n|  Usually this behaviour isn't visible to users (except for the speed\n|  benefits), but if the document in the database is modified or deleted,\n|  then preexisting Document objects may return the old or new versions\n|  of data (or throw Xapian::DocNotFoundError in the case of deletion).\n|\n|  Since Database objects work on a snapshot of the database's state, the\n|  situation above can only happen with a WritableDatabase object, or if\n|  you call Database::reopen() on a Database object.\n|\n|  We recommend you avoid designs where this behaviour is an issue, but\n|  if you need a way to make a non-lazy version of a Document object, you\n|  can do this like so:doc =\n|  Xapian::Document::unserialise(doc.serialise());\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Make a new empty Document.\n|\n|      Xapian::Document::Document()\n|\n|  iter = documentgentermlistiter(self)\n|      Get an iterator over all the terms in a document.\n|\n|      The iterator will return TermListItem objects.\n|\n|      Access to term frequency and position information is only available until\n|      the iterator has moved on.\n|\n|      Note that term frequency information is only meaningful for a document\n|      retrieved from a database.  If term frequency information is requested for\n|      a document which was freshly created, an InvalidOperationError will be\n|      raised.\n|\n|  repr = swigrepr(self)\n|\n|  str = Documentstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::Document::getdescription() const\n|\n|  addbooleanterm = Documentaddbooleanterm(...)\n|      Add a boolean filter term to the document.\n|\n|      void Xapian::Document::addbooleanterm(const std::string &term)\n|\n|      This method adds term to the document with wdf of 0 - this is\n|      generally what you want for a term used for boolean filtering as the\n|      wdf of such terms is ignored, and it doesn't make sense for them to\n|      contribute to the document's length.\n|\n|      If the specified term already indexes this document, this method has\n|      no effect.\n|\n|      It is exactly the same as addterm(term, 0).\n|\n|      This method was added in Xapian 1.0.18.\n|\n|      Parameters:\n|      -----------\n|\n|      term:  The term to add.\n|\n|  addposting = Documentaddposting(...)\n|      Add an occurrence of a term at a particular position.\n|\n|      void Xapian::Document::addposting(const std::string &tname,\n|      Xapian::termpos tpos, Xapian::termcount wdfinc=1)\n|\n|      Multiple occurrences of the term at the same position are represented\n|      only once in the positional information, but do increase the wdf.\n|\n|      If the term is not already in the document, it will be added to it.\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The name of the term.\n|\n|      tpos:  The position of the term.\n|\n|      wdfinc:  The increment that will be applied to the wdf for this term.\n|\n|  addterm = Documentaddterm(...)\n|      Add a term to the document, without positional information.\n|\n|      void Xapian::Document::addterm(const std::string &tname,\n|      Xapian::termcount wdfinc=1)\n|\n|      Any existing positional information for the term will be left\n|      unmodified.\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The name of the term.\n|\n|      wdfinc:  The increment that will be applied to the wdf for this term\n|      (default: 1).\n|\n|  addvalue = Documentaddvalue(...)\n|      Add a new value.\n|\n|      void Xapian::Document::addvalue(Xapian::valueno slot, const\n|      std::string &value)\n|\n|      The new value will replace any existing value with the same number (or\n|      if the new value is empty, it will remove any existing value with the\n|      same number).\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to add the value in.\n|\n|      value:  The value to set.\n|\n|  clearterms = Documentclearterms(...)\n|      Remove all terms (and postings) from the document.\n|\n|      void Xapian::Document::clearterms()\n|\n|  clearvalues = Documentclearvalues(...)\n|      Remove all values associated with the document.\n|\n|      void Xapian::Document::clearvalues()\n|\n|  getdata = Documentgetdata(...)\n|      Get data stored in the document.\n|\n|      std::string Xapian::Document::getdata() const\n|\n|      This is potentially a relatively expensive operation, and shouldn't\n|      normally be used during the match (e.g. in a PostingSource or match\n|      decider functor. Put data for use by match deciders in a value\n|      instead.\n|\n|  getdocid = Documentgetdocid(...)\n|      Get the document id which is associated with this document (if any).\n|\n|      docid Xapian::Document::getdocid() const\n|\n|      NB If multiple databases are being searched together, then this will\n|      be the document id in the individual database, not the merged\n|      database!\n|\n|      If this document came from a database, return the document id in that\n|      database. Otherwise, return 0 (in Xapian 1.0.22/1.2.4 or later; prior\n|      to this the returned value was uninitialised).\n|\n|  getvalue = Documentgetvalue(...)\n|      Get value by number.\n|\n|      std::string Xapian::Document::getvalue(Xapian::valueno slot) const\n|\n|      Returns an empty string if no value with the given number is present\n|      in the document.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The number of the value.\n|\n|  removeposting = Documentremoveposting(...)\n|      Remove a posting of a term from the document.\n|\n|      void Xapian::Document::removeposting(const std::string &tname,\n|      Xapian::termpos tpos, Xapian::termcount wdfdec=1)\n|\n|      Note that the term will still index the document even if all\n|      occurrences are removed. To remove a term from a document completely,\n|      use removeterm().\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The name of the term.\n|\n|      tpos:  The position of the term.\n|\n|      wdfdec:  The decrement that will be applied to the wdf when removing\n|      this posting. The wdf will not go below the value of 0.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the term is not at\n|      the position specified in the position list for this term in this\n|      document.\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the term is not in\n|      the document\n|\n|  removepostings = Documentremovepostings(...)\n|      Remove a range of postings for a term.\n|\n|      Xapian::termpos Xapian::Document::removepostings(const std::string\n|      &term, Xapian::termpos termposfirst, Xapian::termpos termposlast,\n|      Xapian::termcount wdfdec=1)\n|\n|      Any instances of the term at positions >= termposfirst and <=\n|      termposlast will be removed, and the wdf reduced by wdfdec for each\n|      instance removed (the wdf will not ever go below zero though).\n|\n|      It's OK if the term doesn't occur in the range of positions specified\n|      (unlike  removeposting()). And if termposfirst > termposlast,\n|      this method does nothing.\n|\n|      The number of postings removed.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the term is not in\n|      the document\n|\n|      Added in Xapian 1.4.8.\n|\n|  removeterm = Documentremoveterm(...)\n|      Remove a term and all postings associated with it.\n|\n|      void Xapian::Document::removeterm(const std::string &tname)\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The name of the term.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the term is not in\n|      the document\n|\n|  removevalue = Documentremovevalue(...)\n|      Remove any value with the given number.\n|\n|      void Xapian::Document::removevalue(Xapian::valueno slot)\n|\n|  serialise = Documentserialise(...)\n|      Serialise document into a string.\n|\n|      std::string Xapian::Document::serialise() const\n|\n|      The document representation may change between Xapian releases: even\n|      between minor versions. However, it is guaranteed not to change if the\n|      remote database protocol has not changed between releases.\n|\n|  setdata = Documentsetdata(...)\n|      Set data stored in the document.\n|\n|      void Xapian::Document::setdata(const std::string &data)\n|\n|      Xapian treats the data as an opaque blob. It may try to compress it,\n|      but other than that it will just store it and return it when\n|      requested.\n|\n|      Parameters:\n|      -----------\n|\n|      data:  The data to store.\n|\n|  termlist = documentgentermlistiter(self)\n|      Get an iterator over all the terms in a document.\n|\n|      The iterator will return TermListItem objects.\n|\n|      Access to term frequency and position information is only available until\n|      the iterator has moved on.\n|\n|      Note that term frequency information is only meaningful for a document\n|      retrieved from a database.  If term frequency information is requested for\n|      a document which was freshly created, an InvalidOperationError will be\n|      raised.\n|\n|  termlistcount = Documenttermlistcount(...)\n|      The length of the termlist - i.e.\n|\n|      Xapian::termcount Xapian::Document::termlistcount() const\n|\n|      the number of different terms which index this document.\n|\n|  values = documentgenvaluesiter(self)\n|      Get an iterator over all the values stored in a document.\n|\n|      The iterator will return ValueItem objects, in ascending order of value number.\n|\n|  valuescount = Documentvaluescount(...)\n|      Count the values in this document.\n|\n|      Xapian::termcount Xapian::Document::valuescount() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteDocument(...)\n|      Destructor.\n|\n|      Xapian::Document::~Document()\n|\n|  unserialise = Documentunserialise(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class ESet",
                    "content": "|  Class representing a list of search results.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::ESet::ESet()\n|\n|      Creates an empty ESet, mostly useful as a placeholder.\n|\n|  iter = esetgeniter(self)\n|      Return an iterator over the ESet.\n|\n|      The iterator will return ESetItem objects.\n|\n|  len lambda self\n|\n|  repr = swigrepr(self)\n|\n|  str = ESetstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::ESet::getdescription() const\n|\n|  back = ESetback(...)\n|      Return iterator pointing to the last object in this ESet.\n|\n|      ESetIterator Xapian::ESet::back() const\n|\n|  empty = ESetempty(...)\n|      Return true if this ESet object is empty.\n|\n|      bool Xapian::ESet::empty() const\n|\n|  getebound = ESetgetebound(...)\n|      Return a bound on the full size of this ESet object.\n|\n|      Xapian::termcount Xapian::ESet::getebound() const\n|\n|      This is a bound on size() if geteset() had been called with maxitems\n|      set high enough that all results were returned.\n|\n|  size = ESetsize(...)\n|      Return number of items in this ESet object.\n|\n|      Xapian::doccount Xapian::ESet::size() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteESet(...)\n|      Destructor.\n|\n|      Xapian::ESet::~ESet()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class ESetItem",
                    "content": "|  ESetItem(iter)\n|\n|  An item returned from iteration of the ESet.\n|\n|  The item supports access to the following attributes:\n|\n|   - `term`: The term corresponding to this ESet item.\n|   - `weight`: The weight corresponding to this ESet item.\n|\n|  Methods defined here:\n|\n|  init(self, iter)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  term\n|\n|  weight\n"
                },
                {
                    "name": "class ESetIter",
                    "content": "|  ESetIter(eset)\n|\n|  An iterator over the items in an ESet.\n|\n|  The iterator will return ESetItem objects.\n|\n|  Methods defined here:\n|\n|  init(self, eset)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n"
                },
                {
                    "name": "class Enquire",
                    "content": "|  Enquire(database)\n|\n|  This class provides an interface to the information retrieval system\n|  for the purpose of searching.\n|\n|  Databases are usually opened lazily, so exceptions may not be thrown\n|  where you would expect them to be. You should catch Xapian::Error\n|  exceptions when calling any method in Xapian::Enquire.\n|\n|  Parameters:\n|  -----------\n|\n|  Xapian::InvalidArgumentError:  will be thrown if an invalid argument\n|  is supplied, for example, an unknown database type.\n|\n|  Methods defined here:\n|\n|  init(self, database)\n|      Create a Xapian::Enquire object.\n|\n|      Xapian::Enquire::Enquire(const Database &database, ErrorHandler\n|      *errorhandler)\n|\n|      This specification cannot be changed once the Xapian::Enquire is\n|      opened: you must create a new Xapian::Enquire object to access a\n|      different database, or set of databases.\n|\n|      The database supplied must have been initialised (ie, must not be the\n|      result of calling the Database::Database() constructor). If you need\n|      to handle a situation where you have no databases gracefully, a\n|      database created with DBBACKENDINMEMORY can be passed here to\n|      provide a completely empty database.\n|\n|      Parameters:\n|      -----------\n|\n|      database:  Specification of the database or databases to use.\n|\n|      errorhandler:  This parameter is deprecated (since Xapian 1.3.1), and\n|      as of 1.3.5 it's ignored completely.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if an empty Database\n|      object is supplied.\n|\n|  repr = swigrepr(self)\n|\n|  str = Enquirestr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::Enquire::getdescription() const\n|\n|  addmatchspy = enquirematchspyadd(self, decider)\n|      Add a matchspy.\n|\n|      void Xapian::Enquire::addmatchspy(MatchSpy *spy)\n|\n|      This matchspy will be called with some of the documents which match\n|      the query, during the match process. Exactly which of the matching\n|      documents are passed to it depends on exactly when certain\n|      optimisations occur during the match process, but it can be controlled\n|      to some extent by setting the checkatleast parameter to  getmset().\n|\n|      In particular, if there are enough matching documents, at least the\n|      number specified by checkatleast will be passed to the matchspy. This\n|      means that you can force the matchspy to be shown all matching\n|      documents by setting checkatleast to the number of documents in the\n|      database.\n|\n|      Parameters:\n|      -----------\n|\n|      spy:  The MatchSpy subclass to add. The caller must ensure that this\n|      remains valid while the Enquire object remains active, or until\n|      clearmatchspies() is called.\n|\n|  clearmatchspies = enquirematchspiesclear(self)\n|      Remove all the matchspies.\n|\n|      void Xapian::Enquire::clearmatchspies()\n|\n|  geteset = Enquiregeteset(...)\n|      Get the expand set for the given rset.\n|\n|      ESet Xapian::Enquire::geteset(Xapian::termcount maxitems, const RSet\n|      &rset, int flags, double k, const Xapian::ExpandDecider\n|      *edecider=NULL, double minwt=0.0) const\n|\n|      Parameters:\n|      -----------\n|\n|      maxitems:  the maximum number of items to return.\n|\n|      rset:  the relevance set to use when performing the expand operation.\n|\n|      flags:  zero or more of these values |-ed together:\n|      Xapian::Enquire::INCLUDEQUERYTERMS query terms may be returned from\n|      expand\n|\n|      Xapian::Enquire::USEEXACTTERMFREQ for multi dbs, calculate the exact\n|      termfreq; otherwise an approximation is used which can greatly improve\n|      efficiency, but still returns good results.\n|\n|      k:  the parameter k in the query expansion algorithm (default is 1.0)\n|\n|      edecider:  a decision functor to use to decide whether a given term\n|      should be put in the ESet\n|\n|      minwt:  the minimum weight for included terms\n|\n|      An ESet object containing the results of the expand.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  See class documentation.\n|\n|  getmset = Enquiregetmset(...)\n|      Get (a portion of) the match set for the current query.\n|\n|      MSet Xapian::Enquire::getmset(Xapian::doccount first,\n|      Xapian::doccount maxitems, const RSet *omrset, const MatchDecider\n|      *mdecider=0) const\n|\n|      Parameters:\n|      -----------\n|\n|      first:  the first item in the result set to return. A value of zero\n|      corresponds to the first item returned being that with the highest\n|      score. A value of 10 corresponds to the first 10 items being ignored,\n|      and the returned items starting at the eleventh.\n|\n|      maxitems:  the maximum number of items to return. If you want all\n|      matches, then you can pass the result of calling getdoccount() on the\n|      Database object (though if you are doing this so you can filter\n|      results, you are likely to get much better performance by using\n|      Xapian's match-time filtering features instead). You can pass 0 for\n|      maxitems which will give you an empty MSet with valid statistics (such\n|      as getmatchesestimated()) calculated without looking at any\n|      postings, which is very quick, but means the estimates may be more\n|      approximate and the bounds may be much looser.\n|\n|      omrset:  the relevance set to use when performing the query.\n|\n|      mdecider:  a decision functor to use to decide whether a given\n|      document should be put in the MSet.\n|\n|      A Xapian::MSet object containing the results of the query.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  See class documentation.\n|\n|  getquery = enquiregetquery(self)\n|      Get the current query.\n|\n|      const Xapian::Query& Xapian::Enquire::getquery() const\n|\n|      If called before setquery(), this will return a default initialised\n|      Query object.\n|\n|  matchingterms = enquiregeniter(self, which)\n|      Get an iterator over the terms which match a given match set item.\n|\n|      The match set item to consider is specified by the `which` parameter, which\n|      may be a document ID, or an MSetItem object.\n|\n|      The iterator will return string objects.\n|\n|  setcollapsekey = Enquiresetcollapsekey(...)\n|      Set the collapse key to use for queries.\n|\n|      void Xapian::Enquire::setcollapsekey(Xapian::valueno collapsekey,\n|      Xapian::doccount collapsemax=1)\n|\n|      Parameters:\n|      -----------\n|\n|      collapsekey:  value number to collapse on - at most one MSet entry\n|      with each particular value will be returned (default is\n|      Xapian::BADVALUENO which means no collapsing).\n|\n|      collapsemax:  Max number of items with the same key to leave after\n|      collapsing (default 1).\n|\n|      The MSet returned by getmset() will have only the \"best\" (at most)\n|      collapsemax entries with each particular value of collapsekey\n|      (\"best\" being highest ranked - i.e. highest weight or highest\n|      sorting key).\n|\n|      An example use might be to create a value for each document containing\n|      an MD5 hash of the document contents. Then duplicate documents from\n|      different sources can be eliminated at search time by collapsing with\n|      collapsemax = 1 (it's better to eliminate duplicates at index time,\n|      but this may not be always be possible - for example the search may be\n|      over more than one Xapian database).\n|\n|      Another use is to group matches in a particular category (e.g. you\n|      might collapse a mailing list search on the Subject: so that there's\n|      only one result per discussion thread). In this case you can use\n|      getcollapsecount() to give the user some idea how many other results\n|      there are. And if you index the Subject: as a boolean term as well as\n|      putting it in a value, you can offer a link to a non-collapsed search\n|      restricted to that thread using a boolean filter.\n|\n|  setcutoff = Enquiresetcutoff(...)\n|      Set the percentage and/or weight cutoffs.\n|\n|      void Xapian::Enquire::setcutoff(int percentcutoff, double\n|      weightcutoff=0)\n|\n|      Parameters:\n|      -----------\n|\n|      percentcutoff:  Minimum percentage score for returned documents. If a\n|      document has a lower percentage score than this, it will not appear in\n|      the MSet. If your intention is to return only matches which contain\n|      all the terms in the query, then it's more efficient to use\n|      Xapian::Query::OPAND instead of Xapian::Query::OPOR in the query\n|      than to use setcutoff(100). (default 0 => no percentage cut-off).\n|\n|      weightcutoff:  Minimum weight for a document to be returned. If a\n|      document has a lower score that this, it will not appear in the MSet.\n|      It is usually only possible to choose an appropriate weight for cutoff\n|      based on the results of a previous run of the same query; this is thus\n|      mainly useful for alerting operations. The other potential use is with\n|      a user specified weighting scheme. (default 0 => no weight cut-off).\n|\n|  setdocidorder = Enquiresetdocidorder(...)\n|      Set sort order for document IDs.\n|\n|      void Xapian::Enquire::setdocidorder(docidorder order)\n|\n|      This order only has an effect on documents which would otherwise have\n|      equal rank. When ordering by relevance without a sort key, this means\n|      documents with equal weight. For a boolean match with no sort key,\n|      this means all documents. And if a sort key is used, this means\n|      documents with the same sort key (and also equal weight if ordering on\n|      relevance before or after the sort key).\n|\n|      Parameters:\n|      -----------\n|\n|      order:  This can be:  Xapian::Enquire::ASCENDING docids sort in\n|      ascending order (default)\n|\n|      Xapian::Enquire::DESCENDING docids sort in descending order\n|\n|      Xapian::Enquire::DONTCARE docids sort in whatever order is most\n|      efficient for the backend\n|\n|      Note: If you add documents in strict date order, then a boolean search\n|      - i.e. setweightingscheme(Xapian::BoolWeight()) - with\n|      setdocidorder(Xapian::Enquire::DESCENDING) is an efficient way to\n|      perform \"sort by date, newest first\", and with\n|      setdocidorder(Xapian::Enquire::ASCENDING) a very efficient way to\n|      perform \"sort by date, oldest first\".\n|\n|  setexpansionscheme = Enquiresetexpansionscheme(...)\n|      Set the weighting scheme to use for expansion.\n|\n|      void Xapian::Enquire::setexpansionscheme(const std::string\n|      &eweightname, double expandk=1.0) const\n|\n|      If you don't call this method, the default is as if you'd used:\n|\n|      getexpansionscheme(\"trad\");\n|\n|      Parameters:\n|      -----------\n|\n|      eweightname:  A string in lowercase specifying the name of the scheme\n|      to be used. The following schemes are currently available: \"bo1\" :\n|      The Bo1 scheme for query expansion. \"trad\" : The TradWeight scheme\n|      for query expansion.\n|\n|      expandk:  The parameter required for TradWeight query expansion. A\n|      default value of 1.0 is used if none is specified.\n|\n|  setquery = enquiresetquery(self, query, qlen=0)\n|      Set the query to run.\n|\n|      void Xapian::Enquire::setquery(const Xapian::Query &query,\n|      Xapian::termcount qlen=0)\n|\n|      Parameters:\n|      -----------\n|\n|      query:  the new query to run.\n|\n|      qlen:  the query length to use in weight calculations - by default the\n|      sum of the wqf of all terms is used.\n|\n|  setsortbykey = enquiresetsortbykey(self, sorter, reverse)\n|      Set the sorting to be by key generated from values only.\n|\n|      void Xapian::Enquire::setsortbykey(Xapian::KeyMaker *sorter, bool\n|      reverse)\n|\n|      Parameters:\n|      -----------\n|\n|      sorter:  The functor to use for generating keys.\n|\n|      reverse:  If true, reverses the sort order.\n|\n|  setsortbykeythenrelevance = enquiresetsortbykeythenrelevance(self, sorter, reverse)\n|      Set the sorting to be by keys generated from values, then by relevance\n|      for documents with identical keys.\n|\n|      void Xapian::Enquire::setsortbykeythenrelevance(Xapian::KeyMaker\n|      *sorter, bool reverse)\n|\n|      Parameters:\n|      -----------\n|\n|      sorter:  The functor to use for generating keys.\n|\n|      reverse:  If true, reverses the sort order.\n|\n|  setsortbyrelevance = Enquiresetsortbyrelevance(...)\n|      Set the sorting to be by relevance only.\n|\n|      void Xapian::Enquire::setsortbyrelevance()\n|\n|      This is the default.\n|\n|  setsortbyrelevancethenkey = enquiresetsortbyrelevancethenkey(self, sorter, reverse)\n|      Set the sorting to be by relevance, then by keys generated from\n|      values.\n|\n|      void Xapian::Enquire::setsortbyrelevancethenkey(Xapian::KeyMaker\n|      *sorter, bool reverse)\n|\n|      Note that with the default BM25 weighting scheme parameters, non-\n|      identical documents will rarely have the same weight, so this setting\n|      will give very similar results to setsortbyrelevance(). It becomes\n|      more useful with particular BM25 parameter settings (e.g.\n|      BM25Weight(1,0,1,0,0)) or custom weighting schemes.\n|\n|      Parameters:\n|      -----------\n|\n|      sorter:  The functor to use for generating keys.\n|\n|      reverse:  If true, reverses the sort order of the generated keys.\n|      Beware that in 1.2.16 and earlier, the sense of this parameter was\n|      incorrectly inverted and inconsistent with the other setsortby...\n|      methods. This was fixed in 1.2.17, so make that version a minimum\n|      requirement if this detail matters to your application.\n|\n|  setsortbyrelevancethenvalue = Enquiresetsortbyrelevancethenvalue(...)\n|      Set the sorting to be by relevance then value.\n|\n|      void Xapian::Enquire::setsortbyrelevancethenvalue(Xapian::valueno\n|      sortkey, bool reverse)\n|\n|      Note that sorting by values uses a string comparison, so to use this\n|      to sort by a numeric value you'll need to store the numeric values in\n|      a manner which sorts appropriately. For example, you could use\n|      Xapian::sortableserialise() (which works for floating point numbers\n|      as well as integers), or store numbers padded with leading zeros or\n|      spaces, or with the number of digits prepended.\n|\n|      Note that with the default BM25 weighting scheme parameters, non-\n|      identical documents will rarely have the same weight, so this setting\n|      will give very similar results to setsortbyrelevance(). It becomes\n|      more useful with particular BM25 parameter settings (e.g.\n|      BM25Weight(1,0,1,0,0)) or custom weighting schemes.\n|\n|      Parameters:\n|      -----------\n|\n|      sortkey:  value number to sort on.\n|\n|      reverse:  If true, reverses the sort order of sortkey. Beware that in\n|      1.2.16 and earlier, the sense of this parameter was incorrectly\n|      inverted and inconsistent with the other setsortby... methods. This\n|      was fixed in 1.2.17, so make that version a minimum requirement if\n|      this detail matters to your application.\n|\n|  setsortbyvalue = Enquiresetsortbyvalue(...)\n|      Set the sorting to be by value only.\n|\n|      void Xapian::Enquire::setsortbyvalue(Xapian::valueno sortkey, bool\n|      reverse)\n|\n|      Note that sorting by values uses a string comparison, so to use this\n|      to sort by a numeric value you'll need to store the numeric values in\n|      a manner which sorts appropriately. For example, you could use\n|      Xapian::sortableserialise() (which works for floating point numbers\n|      as well as integers), or store numbers padded with leading zeros or\n|      spaces, or with the number of digits prepended.\n|\n|      Parameters:\n|      -----------\n|\n|      sortkey:  value number to sort on.\n|\n|      reverse:  If true, reverses the sort order.\n|\n|  setsortbyvaluethenrelevance = Enquiresetsortbyvaluethenrelevance(...)\n|      Set the sorting to be by value, then by relevance for documents with\n|      the same value.\n|\n|      void Xapian::Enquire::setsortbyvaluethenrelevance(Xapian::valueno\n|      sortkey, bool reverse)\n|\n|      Note that sorting by values uses a string comparison, so to use this\n|      to sort by a numeric value you'll need to store the numeric values in\n|      a manner which sorts appropriately. For example, you could use\n|      Xapian::sortableserialise() (which works for floating point numbers\n|      as well as integers), or store numbers padded with leading zeros or\n|      spaces, or with the number of digits prepended.\n|\n|      Parameters:\n|      -----------\n|\n|      sortkey:  value number to sort on.\n|\n|      reverse:  If true, reverses the sort order.\n|\n|  settimelimit = Enquiresettimelimit(...)\n|      Set a time limit for the match.\n|\n|      void Xapian::Enquire::settimelimit(double timelimit)\n|\n|      Matches with checkatleast set high can take a long time in some\n|      cases. You can set a time limit on this, after which checkatleast\n|      will be turned off.\n|\n|      Parameters:\n|      -----------\n|\n|      timelimit:  time in seconds after which to disable checkatleast\n|      (default: 0.0 which means no time limit)\n|\n|      Limitations:\n|\n|      This feature is currently supported on platforms which support POSIX\n|      interval timers. Interaction with the remote backend when using\n|      multiple databases may have bugs. There's not currently a way to force\n|      the match to end after a certain time.\n|\n|  setweightingscheme = Enquiresetweightingscheme(...)\n|      Set the weighting scheme to use for queries.\n|\n|      void Xapian::Enquire::setweightingscheme(const Weight &weight)\n|\n|      Parameters:\n|      -----------\n|\n|      weight:  the new weighting scheme. If no weighting scheme is\n|      specified, the default is BM25 with the default parameters.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteEnquire(...)\n|      Close the Xapian::Enquire object.\n|\n|      Xapian::Enquire::~Enquire()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  ASCENDING = 1\n|\n|  DESCENDING = 0\n|\n|  DONTCARE = 2\n|\n|  INCLUDEQUERYTERMS = 1\n|\n|  USEEXACTTERMFREQ = 2\n"
                },
                {
                    "name": "class Error",
                    "content": "|  Error(*args, kwargs)\n|\n|  All exceptions thrown by Xapian are subclasses of Xapian::Error.\n|\n|  This class can not be instantiated directly - instead a subclass\n|  should be used.\n|\n|  Method resolution order:\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class ExpandDecider",
                    "content": "|  Virtual base class for expand decider functor.\n|\n|  Methods defined here:\n|\n|  call = ExpandDecidercall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::ExpandDecider::ExpandDecider()\n|\n|  repr = swigrepr(self)\n|\n|  release = ExpandDeciderrelease(...)\n|      Start reference counting this object.\n|\n|      const ExpandDecider* Xapian::ExpandDecider::release() const\n|\n|      You can hand ownership of a dynamically allocated ExpandDecider object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteExpandDecider(...)\n|      Virtual destructor, because we have virtual methods.\n|\n|      virtual Xapian::ExpandDecider::~ExpandDecider()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class ExpandDeciderAnd",
                    "content": "|  ExpandDeciderAnd(first, second)\n|\n|  ExpandDecider subclass which rejects terms using two ExpandDeciders.\n|\n|  Terms are only accepted if they are accepted by both of the specified\n|  ExpandDecider objects.\n|\n|  Method resolution order:\n|      ExpandDeciderAnd\n|      ExpandDecider\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, first, second)\n|      Compatibility method.\n|\n|      Xapian::ExpandDeciderAnd::ExpandDeciderAnd(const ExpandDecider\n|      *first, const ExpandDecider *second)\n|\n|      Parameters:\n|      -----------\n|\n|      first:  First ExpandDecider object to test with.\n|\n|      second:   ExpandDecider object to test with if first accepts.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteExpandDeciderAnd(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ExpandDecider:\n|\n|  call = ExpandDecidercall(...)\n|\n|  disown(self)\n|\n|  release = ExpandDeciderrelease(...)\n|      Start reference counting this object.\n|\n|      const ExpandDecider* Xapian::ExpandDecider::release() const\n|\n|      You can hand ownership of a dynamically allocated ExpandDecider object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from ExpandDecider:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ExpandDeciderFilterPrefix",
                    "content": "|  ExpandDeciderFilterPrefix(prefix)\n|\n|  ExpandDecider subclass which restrict terms to a particular prefix.\n|\n|  ExpandDeciderFilterPrefix provides an easy way to choose terms with a\n|  particular prefix when generating an ESet.\n|\n|  Method resolution order:\n|      ExpandDeciderFilterPrefix\n|      ExpandDecider\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, prefix)\n|      The parameter specify the prefix of terms to be retained.\n|\n|      Xapian::ExpandDeciderFilterPrefix::ExpandDeciderFilterPrefix(const\n|      std::string &prefix)\n|\n|      Parameters:\n|      -----------\n|\n|      prefix:  restrict terms to the particular prefix\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteExpandDeciderFilterPrefix(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ExpandDecider:\n|\n|  call = ExpandDecidercall(...)\n|\n|  disown(self)\n|\n|  release = ExpandDeciderrelease(...)\n|      Start reference counting this object.\n|\n|      const ExpandDecider* Xapian::ExpandDecider::release() const\n|\n|      You can hand ownership of a dynamically allocated ExpandDecider object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from ExpandDecider:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class FeatureUnavailableError",
                    "content": "|  FeatureUnavailableError(*args)\n|\n|  Indicates an attempt to use a feature which is unavailable.\n|\n|  Typically a feature is unavailable because it wasn't compiled in, or\n|  because it requires other software or facilities which aren't\n|  available.\n|\n|  Method resolution order:\n|      FeatureUnavailableError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::FeatureUnavailableError::FeatureUnavailableError(const\n|      std::string &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteFeatureUnavailableError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class FieldProcessor",
                    "content": "|  Base class for field processors.\n|\n|  Methods defined here:\n|\n|  call = FieldProcessorcall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::FieldProcessor::FieldProcessor()\n|\n|  repr = swigrepr(self)\n|\n|  release = FieldProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const FieldProcessor* Xapian::FieldProcessor::release() const\n|\n|      You can hand ownership of a dynamically allocated FieldProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteFieldProcessor(...)\n|      Destructor.\n|\n|      virtual Xapian::FieldProcessor::~FieldProcessor()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class FixedWeightPostingSource",
                    "content": "|  FixedWeightPostingSource(wt)\n|\n|  A posting source which returns a fixed weight for all documents.\n|\n|  This returns entries for all documents in the given database, with a\n|  fixed weight (specified by a parameter to the constructor).\n|\n|  Method resolution order:\n|      FixedWeightPostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, wt)\n|      Construct a FixedWeightPostingSource.\n|\n|      Xapian::FixedWeightPostingSource::FixedWeightPostingSource(double wt)\n|\n|      Parameters:\n|      -----------\n|\n|      wt:  The fixed weight to return.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteFixedWeightPostingSource(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  disown(self)\n|\n|  next = PostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      virtual void Xapian::PostingSource::next(double minwt)=0\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  str = PostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::PostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  atend = PostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      virtual bool Xapian::PostingSource::atend() const =0\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = PostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      virtual bool Xapian::PostingSource::check(Xapian::docid did, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  getdocid = PostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      virtual Xapian::docid Xapian::PostingSource::getdocid() const =0\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  gettermfreqest = PostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqest()\n|      const =0\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = PostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqmax()\n|      const =0\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = PostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqmin()\n|      const =0\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getweight = PostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      virtual double Xapian::PostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  init = PostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      virtual void Xapian::PostingSource::init(const Database &db)=0\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  name = PostingSourcename(...)\n|      Name of the posting source class.\n|\n|      virtual std::string Xapian::PostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  skipto = PostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      virtual void Xapian::PostingSource::skipto(Xapian::docid did, double\n|      minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class GreatCircleMetric",
                    "content": "|  GreatCircleMetric(*args)\n|\n|  Calculate the great-circle distance between two coordinates on a\n|  sphere.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  This uses the haversine formula to calculate the distance. Note that\n|  this formula is subject to inaccuracy due to numerical errors for\n|  coordinates on the opposite side of the sphere.\n|\n|  Seehttps://en.wikipedia.org/wiki/Haversineformula\n|\n|  Method resolution order:\n|      GreatCircleMetric\n|      LatLongMetric\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a GreatCircleMetric using a specified radius.\n|\n|      Xapian::GreatCircleMetric::GreatCircleMetric(double radius)\n|\n|      This is useful for data sets in which the points are not on Earth (eg,\n|      a database of features on Mars).\n|\n|      Parameters:\n|      -----------\n|\n|      radius:  The radius of the sphere to use, in metres.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteGreatCircleMetric(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from LatLongMetric:\n|\n|  call = LatLongMetriccall(...)\n|\n|  disown(self)\n|\n|  name = LatLongMetricname(...)\n|      Return the full name of the metric.\n|\n|      virtual std::string Xapian::LatLongMetric::name() const =0\n|\n|      This is used when serialising and unserialising metrics; for example,\n|      for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      LatLongMetric subclass called \"FooLatLongMetric\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooLatLongMetric\".\n|\n|  pointwisedistance = LatLongMetricpointwisedistance(...)\n|      Return the distance between two coordinates, in metres.\n|\n|      virtual double Xapian::LatLongMetric::pointwisedistance(const\n|      LatLongCoord &a, const LatLongCoord &b) const =0\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from LatLongMetric:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class IfB2Weight",
                    "content": "|  IfB2Weight(*args)\n|\n|  This class implements the IfB2 weighting scheme.\n|\n|  IfB2 is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  It uses the Inverse term frequency model (If), the Bernoulli method to\n|  find the aftereffect of sampling (B) and the second wdf normalization\n|  proposed by Amati to normalize the wdf in the document to the length\n|  of the document (H2).\n|\n|  For more information about the DFR Framework and the IfB2 scheme,\n|  please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389.\n|\n|  Method resolution order:\n|      IfB2Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::IfB2Weight::IfB2Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteIfB2Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class InL2Weight",
                    "content": "|  InL2Weight(*args)\n|\n|  This class implements the InL2 weighting scheme.\n|\n|  InL2 is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  This weighting scheme is useful for tasks that require early\n|  precision.\n|\n|  It uses the Inverse document frequency model (In), the Laplace method\n|  to find the aftereffect of sampling (L) and the second wdf\n|  normalization proposed by Amati to normalize the wdf in the document\n|  to the length of the document (H2).\n|\n|  For more information about the DFR Framework and the InL2 scheme,\n|  please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389.\n|\n|  Method resolution order:\n|      InL2Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::InL2Weight::InL2Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteInL2Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class IneB2Weight",
                    "content": "|  IneB2Weight(*args)\n|\n|  This class implements the IneB2 weighting scheme.\n|\n|  IneB2 is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  It uses the Inverse expected document frequency model (Ine), the\n|  Bernoulli method to find the aftereffect of sampling (B) and the\n|  second wdf normalization proposed by Amati to normalize the wdf in the\n|  document to the length of the document (H2).\n|\n|  For more information about the DFR Framework and the IneB2 scheme,\n|  please refer to: Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389.\n|\n|  Method resolution order:\n|      IneB2Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::IneB2Weight::IneB2Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteIneB2Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class InternalError",
                    "content": "|  InternalError(*args)\n|\n|  InternalError indicates a runtime problem of some sort.\n|\n|  Method resolution order:\n|      InternalError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::InternalError::InternalError(const std::string &msg, int\n|      errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteInternalError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class InvalidArgumentError",
                    "content": "|  InvalidArgumentError(*args)\n|\n|  InvalidArgumentError indicates an invalid parameter value was passed\n|  to the API.\n|\n|  Method resolution order:\n|      InvalidArgumentError\n|      LogicError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::InvalidArgumentError::InvalidArgumentError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteInvalidArgumentError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class InvalidOperationError",
                    "content": "|  InvalidOperationError(*args)\n|\n|  InvalidOperationError indicates the API was used in an invalid way.\n|\n|  Method resolution order:\n|      InvalidOperationError\n|      LogicError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::InvalidOperationError::InvalidOperationError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteInvalidOperationError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class KeyMaker",
                    "content": "|  Virtual base class for key making functors.\n|\n|  Methods defined here:\n|\n|  call = KeyMakercall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::KeyMaker::KeyMaker()\n|\n|  repr = swigrepr(self)\n|\n|  release = KeyMakerrelease(...)\n|      Start reference counting this object.\n|\n|      const KeyMaker* Xapian::KeyMaker::release() const\n|\n|      You can hand ownership of a dynamically allocated KeyMaker object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteKeyMaker(...)\n|      Virtual destructor, because we have virtual methods.\n|\n|      virtual Xapian::KeyMaker::~KeyMaker()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class LMWeight",
                    "content": "|  LMWeight(*args)\n|\n|  Xapian::Weight subclass implementing the Language Model formula.\n|\n|  This class implements the \"Language Model\" Weighting scheme, as\n|  described by the early papers on LM by Bruce Croft.\n|\n|  LM works by comparing the query to a Language Model of the document.\n|  The language model itself is parameter-free, though LMWeight takes\n|  parameters which specify the smoothing used.\n|\n|  Method resolution order:\n|      LMWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a LMWeight.\n|\n|      Xapian::LMWeight::LMWeight(double paramlog=0.0, typesmoothing\n|      selectsmoothing=TWOSTAGESMOOTHING, double paramsmoothing1=-1.0,\n|      double paramsmoothing2=-1.0)\n|\n|      Parameters:\n|      -----------\n|\n|      paramlog:  A non-negative parameter controlling how much to clamp\n|      negative values returned by the log. The log is calculated by\n|      multiplying the actual weight by paramlog. If paramlog is 0.0, then\n|      the document length upper bound will be used (default: document length\n|      upper bound)\n|\n|      selectsmoothing:  A parameter of type enum typesmoothing. This\n|      parameter controls which smoothing type to use. (default:\n|      TWOSTAGESMOOTHING)\n|\n|      paramsmoothing1:  A non-negative parameter for smoothing whose\n|      meaning depends on selectsmoothing. In JELINEKMERCERSMOOTHING, it\n|      plays the role of estimation and in DIRICHLETSMOOTHING the role of\n|      query modelling. (default JELINEKMERCER, ABSOLUTE, TWOSTAGE(0.7),\n|      DIRCHLET(2000))\n|\n|      paramsmoothing2:  A non-negative parameter which is used with\n|      TWOSTAGESMOOTHING as parameter for Dirichlet's smoothing (default:\n|      2000) and as parameter delta to control the scale of the tf lower\n|      bound in the DIRICHLETPLUSSMOOTHING (default 0.05).\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLMWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class LatLongCoord",
                    "content": "|  LatLongCoord(*args)\n|\n|  A latitude-longitude coordinate.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  Note that latitude-longitude coordinates are only precisely meaningful\n|  if the datum used to define them is specified. This class ignores this\n|  issue - it is up to the caller to ensure that the datum used for each\n|  coordinate in a system is consistent.\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a coordinate.\n|\n|      Xapian::LatLongCoord::LatLongCoord(double latitude, double\n|      longitude)\n|\n|      If the supplied longitude is out of the standard range, it will be\n|      normalised to the range 0 <= longitude < 360.\n|\n|      If you want to avoid the checks (for example, you know that your\n|      values are already in range), you can use the alternate constructor to\n|      construct an uninitialised coordinate, and then set the latitude and\n|      longitude directly.\n|\n|      Parameters:\n|      -----------\n|\n|      InvalidArgumentError:  the supplied latitude is out of range.\n|\n|  repr = swigrepr(self)\n|\n|  str = LatLongCoordstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::LatLongCoord::getdescription() const\n|\n|  serialise = LatLongCoordserialise(...)\n|      Return a serialised representation of the coordinate.\n|\n|      std::string Xapian::LatLongCoord::serialise() const\n|\n|  unserialise = LatLongCoordunserialise(...)\n|      Unserialise a buffer and set this object to its coordinate.\n|\n|      void Xapian::LatLongCoord::unserialise(const char ptr, const char\n|      *end)\n|\n|      The buffer may contain further data after that for the coordinate.\n|\n|      Parameters:\n|      -----------\n|\n|      ptr:  A pointer to the start of the string. This will be updated to\n|      point to the end of the data representing the coordinate.\n|\n|      end:  A pointer to the end of the string.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::SerialisationError:  if the string does not start with a valid\n|      serialised latitude- longitude pair.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLatLongCoord(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  latitude\n|\n|  longitude\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class LatLongCoords",
                    "content": "|  LatLongCoords(*args)\n|\n|  A sequence of latitude-longitude coordinates.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a container holding one coordinate.\n|\n|      Xapian::LatLongCoords::LatLongCoords(const LatLongCoord &coord)\n|\n|  iter = latlongcoordsiter(self)\n|      Get an iterator over all the coordinates in a LatLongCoords.\n|\n|      The iterator will return xapian.LatLongCoord objects.\n|\n|  repr = swigrepr(self)\n|\n|  str = LatLongCoordsstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::LatLongCoords::getdescription() const\n|\n|  append = LatLongCoordsappend(...)\n|      Append a coordinate to the end of the sequence.\n|\n|      void Xapian::LatLongCoords::append(const LatLongCoord &coord)\n|\n|  begin = LatLongCoordsbegin(...)\n|      Get a begin iterator for the coordinates.\n|\n|      LatLongCoordsIterator Xapian::LatLongCoords::begin() const\n|\n|  empty = LatLongCoordsempty(...)\n|      Return true if and only if there are no coordinates in the container.\n|\n|      bool Xapian::LatLongCoords::empty() const\n|\n|  end = LatLongCoordsend(...)\n|      Get an end iterator for the coordinates.\n|\n|      LatLongCoordsIterator Xapian::LatLongCoords::end() const\n|\n|  serialise = LatLongCoordsserialise(...)\n|      Return a serialised form of the coordinate list.\n|\n|      std::string Xapian::LatLongCoords::serialise() const\n|\n|  size = LatLongCoordssize(...)\n|      Get the number of coordinates in the container.\n|\n|      sizet Xapian::LatLongCoords::size() const\n|\n|  unserialise = LatLongCoordsunserialise(...)\n|      Unserialise a string and set this object to the coordinates in it.\n|\n|      void Xapian::LatLongCoords::unserialise(const std::string &serialised)\n|\n|      Parameters:\n|      -----------\n|\n|      serialised:  the string to unserialise the coordinates from.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::SerialisationError:  if the string does not contain a valid\n|      serialised latitude-longitude pair, or contains junk at the end of it.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLatLongCoords(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class LatLongCoordsIter",
                    "content": "|  LatLongCoordsIter(start, end)\n|\n|  An iterator over all the coordinates in a LatLongCoords object.\n|\n|  The iterator returns LatLongCoord objects.\n|\n|  Methods defined here:\n|\n|  eq(self, other)\n|      Return self==value.\n|\n|  init(self, start, end)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  ne(self, other)\n|      Return self!=value.\n|\n|  next(self)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  hash = None\n"
                },
                {
                    "name": "class LatLongDistanceKeyMaker",
                    "content": "|  LatLongDistanceKeyMaker(*args)\n|\n|  KeyMaker subclass which sorts by distance from a latitude/longitude.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  Results are ordered by the distance from a fixed point, or list of\n|  points, calculated according to the metric supplied. If multiple\n|  points are supplied (either in the constructor, or in the coordinates\n|  stored in a document), the closest pointwise distance is used.\n|\n|  If a document contains no coordinate stored in the specified slot, a\n|  special value for the distance will be used. This defaults to a large\n|  number, so that such results get a low rank, but may be specified by a\n|  constructor parameter.\n|\n|  Method resolution order:\n|      LatLongDistanceKeyMaker\n|      KeyMaker\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a LatLongDistanceKeyMaker.\n|\n|      Xapian::LatLongDistanceKeyMaker::LatLongDistanceKeyMaker(Xapian::valueno\n|      slot, const LatLongCoord &centre)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  Value slot to use.\n|\n|      centre:  Point to calculate distance from.\n|\n|      Xapian::GreatCircleMetric is used as the metric.\n|\n|      Documents where no value is set are assumed to be a large distance\n|      away.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLatLongDistanceKeyMaker(...)\n|      Xapian::LatLongDistanceKeyMaker::~LatLongDistanceKeyMaker()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from KeyMaker:\n|\n|  call = KeyMakercall(...)\n|\n|  disown(self)\n|\n|  release = KeyMakerrelease(...)\n|      Start reference counting this object.\n|\n|      const KeyMaker* Xapian::KeyMaker::release() const\n|\n|      You can hand ownership of a dynamically allocated KeyMaker object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from KeyMaker:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class LatLongDistancePostingSource",
                    "content": "|  LatLongDistancePostingSource(*args)\n|\n|  Posting source which returns a weight based on geospatial distance.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  Results are weighted by the distance from a fixed point, or list of\n|  points, calculated according to the metric supplied. If multiple\n|  points are supplied (either in the constructor, or in the coordinates\n|  stored in a document), the closest pointwise distance is used.\n|\n|  Documents further away than a specified maximum range (or with no\n|  location stored in the specified slot) will not be returned.\n|\n|  The weight returned is computed from the distance using the formula:\n|\n|  k1 * pow(distance + k1, -k2)\n|\n|  (Where k1 and k2 are (strictly) positive, floating point constants,\n|  which default to 1000 and 1, respectively. Distance is measured in\n|  metres, so this means that something at the centre gets a weight of\n|  1.0, something 1km away gets a weight of 0.5, and something 3km away\n|  gets a weight of 0.25, etc)\n|\n|  Method resolution order:\n|      LatLongDistancePostingSource\n|      ValuePostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a new posting source which returns only documents within\n|      range of one of the central coordinates.\n|\n|      Xapian::LatLongDistancePostingSource::LatLongDistancePostingSource(Xapian::valueno\n|      slot, const LatLongCoords &centre, double maxrange=0.0, double\n|      k1=1000.0, double k2=1.0)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to read values from.\n|\n|      centre:  The centre point to use for distance calculations.\n|\n|      maxrange:  The maximum distance for documents which are returned.\n|\n|      k1:  The k1 constant to use in the weighting function.\n|\n|      k2:  The k2 constant to use in the weighting function.\n|\n|      Xapian::GreatCircleMetric is used as the metric.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLatLongDistancePostingSource(...)\n|      Xapian::LatLongDistancePostingSource::~LatLongDistancePostingSource()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValuePostingSource:\n|\n|  disown(self)\n|\n|  next = ValuePostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      void Xapian::ValuePostingSource::next(double minwt)\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  atend = ValuePostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      bool Xapian::ValuePostingSource::atend() const\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = ValuePostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      bool Xapian::ValuePostingSource::check(Xapian::docid mindocid, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  done = ValuePostingSourcedone(...)\n|      End the iteration.\n|\n|      void Xapian::ValuePostingSource::done()\n|\n|      Calls to atend() will return true after calling this method.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdatabase = ValuePostingSourcegetdatabase(...)\n|      The database we're reading values from.\n|\n|      Xapian::Database Xapian::ValuePostingSource::getdatabase() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdocid = ValuePostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      Xapian::docid Xapian::ValuePostingSource::getdocid() const\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getslot = ValuePostingSourcegetslot(...)\n|      The slot we're reading values from.\n|\n|      Xapian::valueno Xapian::ValuePostingSource::getslot() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getstarted = ValuePostingSourcegetstarted(...)\n|      Flag indicating if we've started (true if we have).\n|\n|      bool Xapian::ValuePostingSource::getstarted() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  gettermfreqest = ValuePostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqest() const\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = ValuePostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmax() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = ValuePostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmin() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getvalue = ValuePostingSourcegetvalue(...)\n|      Read current value.\n|\n|      std::string Xapian::ValuePostingSource::getvalue() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  init = ValuePostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      void Xapian::ValuePostingSource::init(const Database &db)\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  settermfreqest = ValuePostingSourcesettermfreqest(...)\n|      An estimate of the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqest(Xapian::doccount\n|      termfreqest)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmax = ValuePostingSourcesettermfreqmax(...)\n|      An upper bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmax(Xapian::doccount\n|      termfreqmax)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmin = ValuePostingSourcesettermfreqmin(...)\n|      Set a lower bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmin(Xapian::doccount\n|      termfreqmin)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods to return fewer documents.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  skipto = ValuePostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      void Xapian::ValuePostingSource::skipto(Xapian::docid mindocid,\n|      double minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  str = PostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::PostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  getweight = PostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      virtual double Xapian::PostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  name = PostingSourcename(...)\n|      Name of the posting source class.\n|\n|      virtual std::string Xapian::PostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class LatLongMetric",
                    "content": "|  Base class for calculating distances between two lat/long coordinates.\n|\n|  Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|  features\n|\n|  Methods defined here:\n|\n|  call = LatLongMetriccall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr = swigrepr(self)\n|\n|  name = LatLongMetricname(...)\n|      Return the full name of the metric.\n|\n|      virtual std::string Xapian::LatLongMetric::name() const =0\n|\n|      This is used when serialising and unserialising metrics; for example,\n|      for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      LatLongMetric subclass called \"FooLatLongMetric\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooLatLongMetric\".\n|\n|  pointwisedistance = LatLongMetricpointwisedistance(...)\n|      Return the distance between two coordinates, in metres.\n|\n|      virtual double Xapian::LatLongMetric::pointwisedistance(const\n|      LatLongCoord &a, const LatLongCoord &b) const =0\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLatLongMetric(...)\n|      Destructor.\n|\n|      virtual Xapian::LatLongMetric::~LatLongMetric()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class LogicError",
                    "content": "|  LogicError(*args, kwargs)\n|\n|  The base class for exceptions indicating errors in the program logic.\n|\n|  A subclass of LogicError will be thrown if Xapian detects a violation\n|  of a class invariant or a logical precondition or postcondition, etc.\n|\n|  Method resolution order:\n|      LogicError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteLogicError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class MSet",
                    "content": "|  Class representing a list of search results.\n|\n|  Methods defined here:\n|\n|  getitem = msetgetitem(self, index)\n|      Get an item from the MSet.\n|\n|      The supplied index is relative to the start of the MSet, not the absolute\n|      rank of the item.\n|\n|      Returns an MSetItem.\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::MSet::MSet()\n|\n|      Creates an empty MSet, mostly useful as a placeholder.\n|\n|  iter = msetgeniter(self)\n|      Return an iterator over the MSet.\n|\n|      The iterator will return MSetItem objects, which will be evaluated lazily\n|      where appropriate.\n|\n|  len lambda self\n|\n|  repr = swigrepr(self)\n|\n|  str = MSetstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::MSet::getdescription() const\n|\n|  back = MSetback(...)\n|      Return iterator pointing to the last object in this MSet.\n|\n|      MSetIterator Xapian::MSet::back() const\n|\n|  converttopercent = MSetconverttopercent(...)\n|      Convert the weight of the current iterator position to a percentage.\n|\n|      int Xapian::MSet::converttopercent(const MSetIterator &it) const\n|\n|      The matching document with the highest weight will get 100% if it\n|      matches all the weighted query terms, and proportionally less if it\n|      only matches some, and other weights are scaled by the same factor.\n|\n|      Documents with a non-zero score will always score at least 1%.\n|\n|      Note that these generally aren't percentages of anything meaningful\n|      (unless you use a custom weighting formula where they are!)\n|\n|  empty = MSetempty(...)\n|      Return true if this MSet object is empty.\n|\n|      bool Xapian::MSet::empty() const\n|\n|  fetch = MSetfetch(...)\n|      Prefetch hint the whole MSet.\n|\n|      void Xapian::MSet::fetch() const\n|\n|      For a remote database, this may start a pipelined fetch of the\n|      requested documents from the remote server.\n|\n|      For a disk-based database, this may send prefetch hints to the\n|      operating system such that the disk blocks the requested documents are\n|      stored in are more likely to be in the cache when we come to actually\n|      read them.\n|\n|  getdocid = MSetgetdocid(...)\n|\n|  getdocument = MSetgetdocument(...)\n|\n|  getdocumentpercentage = MSetgetdocumentpercentage(...)\n|\n|  getfirstitem = MSetgetfirstitem(...)\n|      Rank of first item in this MSet.\n|\n|      Xapian::doccount Xapian::MSet::getfirstitem() const\n|\n|      This is the parameter first passed to Xapian::Enquire::getmset().\n|\n|  gethit = msetgetitem(self, index)\n|      Get an item from the MSet.\n|\n|      The supplied index is relative to the start of the MSet, not the absolute\n|      rank of the item.\n|\n|      Returns an MSetItem.\n|\n|  getmatchesestimated = MSetgetmatchesestimated(...)\n|      Estimate of the total number of matching documents.\n|\n|      Xapian::doccount Xapian::MSet::getmatchesestimated() const\n|\n|  getmatcheslowerbound = MSetgetmatcheslowerbound(...)\n|      Lower bound on the total number of matching documents.\n|\n|      Xapian::doccount Xapian::MSet::getmatcheslowerbound() const\n|\n|  getmatchesupperbound = MSetgetmatchesupperbound(...)\n|      Upper bound on the total number of matching documents.\n|\n|      Xapian::doccount Xapian::MSet::getmatchesupperbound() const\n|\n|  getmaxattained = MSetgetmaxattained(...)\n|      The maximum weight attained by any document.\n|\n|      double Xapian::MSet::getmaxattained() const\n|\n|  getmaxpossible = MSetgetmaxpossible(...)\n|      The maximum possible weight any document could achieve.\n|\n|      double Xapian::MSet::getmaxpossible() const\n|\n|  gettermfreq = MSetgettermfreq(...)\n|      Get the termfreq of a term.\n|\n|      Xapian::doccount Xapian::MSet::gettermfreq(const std::string &term)\n|      const\n|\n|      The number of documents which term occurs in. This considers all\n|      documents in the database being searched, so gives the same answer as\n|      db.gettermfreq(term) (but is more efficient for query terms as it\n|      returns a value cached during the search.)\n|\n|  gettermweight = MSetgettermweight(...)\n|      Get the term weight of a term.\n|\n|      double Xapian::MSet::gettermweight(const std::string &term) const\n|\n|      The maximum weight that term could have contributed to a document.\n|\n|  getuncollapsedmatchesestimated = MSetgetuncollapsedmatchesestimated(...)\n|      Estimate of the total number of matching documents before collapsing.\n|\n|      Xapian::doccount Xapian::MSet::getuncollapsedmatchesestimated()\n|      const\n|\n|      Conceptually the same as getmatchesestimated() for the same query\n|      without any collapse part (though the actual value may differ).\n|\n|  getuncollapsedmatcheslowerbound = MSetgetuncollapsedmatcheslowerbound(...)\n|      Lower bound on the total number of matching documents before\n|      collapsing.\n|\n|      Xapian::doccount Xapian::MSet::getuncollapsedmatcheslowerbound()\n|      const\n|\n|      Conceptually the same as getmatcheslowerbound() for the same query\n|      without any collapse part (though the actual value may differ).\n|\n|  getuncollapsedmatchesupperbound = MSetgetuncollapsedmatchesupperbound(...)\n|      Upper bound on the total number of matching documents before\n|      collapsing.\n|\n|      Xapian::doccount Xapian::MSet::getuncollapsedmatchesupperbound()\n|      const\n|\n|      Conceptually the same as getmatchesupperbound() for the same query\n|      without any collapse part (though the actual value may differ).\n|\n|  size = MSetsize(...)\n|      Return number of items in this MSet object.\n|\n|      Xapian::doccount Xapian::MSet::size() const\n|\n|  snippet = MSetsnippet(...)\n|      Generate a snippet.\n|\n|      std::string Xapian::MSet::snippet(const std::string &text, sizet\n|      length=500, const Xapian::Stem &stemmer=Xapian::Stem(), unsigned\n|      flags=SNIPPETBACKGROUNDMODEL|SNIPPETEXHAUSTIVE, const std::string\n|      &histart=\"<b>\", const std::string &hiend=\"</b>\", const\n|      std::string &omit=\"...\") const\n|\n|      This method selects a continuous run of words from text, based mainly\n|      on where the query matches (currently terms, exact phrases and\n|      wildcards are taken into account). If flag SNIPPETBACKGROUNDMODEL is\n|      used (which it is by default) then the selection algorithm also\n|      considers the non-query terms in the text with the aim of showing a\n|      context which provides more useful information.\n|\n|      The size of the text selected can be controlled by the length\n|      parameter, which specifies a number of bytes of text to aim to select.\n|      However slightly more text may be selected. Also the size of any\n|      escaping, highlighting or omission markers is not considered.\n|\n|      The returned text is escaped to make it suitable for use in HTML\n|      (though beware that in upstream releases 1.4.5 and earlier this\n|      escaping was sometimes incomplete), and matches with the query will be\n|      highlighted using histart and hiend.\n|\n|      If the snippet seems to start or end mid-sentence, then omit is\n|      prepended or append (respectively) to indicate this.\n|\n|      The same stemming algorithm which was used to build the query should\n|      be specified in stemmer.\n|\n|      And flags contains flags controlling behaviour.\n|\n|      Added in 1.3.5.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteMSet(...)\n|      Destructor.\n|\n|      Xapian::MSet::~MSet()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  SNIPPETBACKGROUNDMODEL = 1\n|\n|  SNIPPETCJKNGRAM = 2048\n|\n|  SNIPPETEMPTYWITHOUTMATCH = 4\n|\n|  SNIPPETEXHAUSTIVE = 2\n"
                },
                {
                    "name": "class MSetItem",
                    "content": "|  MSetItem(iter, mset)\n|\n|  An item returned from iteration of the MSet.\n|\n|  The item supports access to the following attributes and properties:\n|\n|   - `docid`: The Xapian document ID corresponding to this MSet item.\n|   - `weight`: The weight corresponding to this MSet item.\n|   - `rank`: The rank of this MSet item.  The rank is the position in the\n|     total set of matching documents of this item.  The highest document is\n|     given a rank of 0.  If the MSet did not start at the highest matching\n|     document, because a non-zero 'start' parameter was supplied to\n|     getmset(), the first document in the MSet will have a rank greater than\n|     0 (in fact, it will be equal to the value of 'start' supplied to\n|     getmset()).\n|   - `percent`: The percentage score assigned to this MSet item.\n|   - `document`: The document for this MSet item.  This can be used to access\n|     the document data, or any other information stored in the document (such\n|     as term lists).  It is lazily evaluated.\n|   - `collapsekey`: The value of the key which was used for collapsing.\n|   - `collapsecount`: An estimate of the number of documents that have been\n|     collapsed into this one.\n|\n|  The collapse count estimate will always be less than or equal to the actual\n|  number of other documents satisfying the match criteria with the same\n|  collapse key as this document.  If may be 0 even though there are other\n|  documents with the same collapse key which satisfying the match criteria.\n|  However if this method returns non-zero, there definitely are other such\n|  documents.  So this method may be used to inform the user that there are\n|  \"at least N other matches in this group\", or to control whether to offer a\n|  \"show other documents in this group\" feature (but note that it may not\n|  offer it in every case where it would show other documents).\n|\n|  Methods defined here:\n|\n|  init(self, iter, mset)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  document\n|      The document object corresponding to this MSet item.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  collapsecount\n|\n|  collapsekey\n|\n|  docid\n|\n|  percent\n|\n|  rank\n|\n|  weight\n"
                },
                {
                    "name": "class MSetIter",
                    "content": "|  MSetIter(mset)\n|\n|  An iterator over the items in an MSet.\n|\n|  The iterator will return MSetItem objects, which will be evaluated lazily\n|  where appropriate.\n|\n|  Methods defined here:\n|\n|  init(self, mset)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n"
                },
                {
                    "name": "class MatchDecider",
                    "content": "|  Base class for matcher decision functor.\n|\n|  Methods defined here:\n|\n|  call = MatchDecidercall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::MatchDecider::MatchDecider()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteMatchDecider(...)\n|      Destructor.\n|\n|      virtual Xapian::MatchDecider::~MatchDecider()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class MatchSpy",
                    "content": "|  Abstract base class for match spies.\n|\n|  The subclasses will generally accumulate information seen during the\n|  match, to calculate aggregate functions, or other profiles of the\n|  matching documents.\n|\n|  Methods defined here:\n|\n|  call = MatchSpycall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor, needed by subclass constructors.\n|\n|      Xapian::MatchSpy::MatchSpy()\n|\n|  repr = swigrepr(self)\n|\n|  str = MatchSpystr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::MatchSpy::getdescription() const\n|\n|      This default implementation returns a generic answer, to avoid forcing\n|      those deriving their own MatchSpy subclasses from having to implement\n|      this (they may not care what getdescription() gives for their\n|      subclass).\n|\n|  mergeresults = MatchSpymergeresults(...)\n|      Unserialise some results, and merge them into this matchspy.\n|\n|      virtual void Xapian::MatchSpy::mergeresults(const std::string\n|      &serialised)\n|\n|      The order in which results are merged should not be significant, since\n|      this order is not specified (and will vary depending on the speed of\n|      the search in each sub-database).\n|\n|      If you don't want to support the remote backend in your match spy, you\n|      can use the default implementation which simply throws\n|      Xapian::UnimplementedError.\n|\n|      Parameters:\n|      -----------\n|\n|      serialised:  A string containing the serialised results.\n|\n|  name = MatchSpyname(...)\n|      Return the name of this match spy.\n|\n|      virtual std::string Xapian::MatchSpy::name() const\n|\n|      This name is used by the remote backend. It is passed with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called MyApp::FooMatchSpy, return \"MyApp::FooMatchSpy\" from\n|      this method.\n|\n|      If you don't want to support the remote backend in your match spy, you\n|      can use the default implementation which simply throws\n|      Xapian::UnimplementedError.\n|\n|  release = MatchSpyrelease(...)\n|      Start reference counting this object.\n|\n|      const MatchSpy* Xapian::MatchSpy::release() const\n|\n|      You can hand ownership of a dynamically allocated MatchSpy object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteMatchSpy(...)\n|      Virtual destructor, because we have virtual methods.\n|\n|      virtual Xapian::MatchSpy::~MatchSpy()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class MultiValueKeyMaker",
                    "content": "|  KeyMaker subclass which combines several values.\n|\n|  When the result is used for sorting, results are ordered by the first\n|  value. In the event of a tie, the second is used. If this is the same\n|  for both, the third is used, and so on. If reverse is true for a\n|  value, then the sort order for that value is reversed.\n|\n|  When used for collapsing, the documents will only be considered equal\n|  if all the values specified match. If none of the specified values are\n|  set then the generated key will be empty, so such documents won't be\n|  collapsed (which is consistent with the behaviour in the \"collapse on\n|  a value\" case). If you'd prefer that documents with none of the keys\n|  set are collapsed together, then you can set reverse for at least one\n|  of the values. Other than this, it isn't useful to set reverse for\n|  collapsing.\n|\n|  Method resolution order:\n|      MultiValueKeyMaker\n|      KeyMaker\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Construct a MultiValueKeyMaker from a pair of iterators.\n|\n|      Xapian::MultiValueKeyMaker::MultiValueKeyMaker(Iterator begin,\n|      Iterator end)\n|\n|      The iterators must be a begin/end pair returning Xapian::valueno (or a\n|      compatible type) when dereferenced.\n|\n|  repr = swigrepr(self)\n|\n|  addvalue = MultiValueKeyMakeraddvalue(...)\n|      Add a value slot to the list to build a key from.\n|\n|      void Xapian::MultiValueKeyMaker::addvalue(Xapian::valueno slot, bool\n|      reverse=false, const std::string &defvalue=std::string())\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to add\n|\n|      reverse:  Adjust values from this slot to reverse their sort order\n|      (default: false)\n|\n|      defvalue:  Value to use for documents which don't have a value set in\n|      this slot (default: empty). This can be used to make such documents\n|      sort after all others by passing getvalueupperbound(slot) + \"x\"\n|      this is guaranteed to be greater than any value in this slot.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteMultiValueKeyMaker(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from KeyMaker:\n|\n|  call = KeyMakercall(...)\n|\n|  disown(self)\n|\n|  release = KeyMakerrelease(...)\n|      Start reference counting this object.\n|\n|      const KeyMaker* Xapian::KeyMaker::release() const\n|\n|      You can hand ownership of a dynamically allocated KeyMaker object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from KeyMaker:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class NetworkError",
                    "content": "|  NetworkError(*args)\n|\n|  Indicates a problem communicating with a remote database.\n|\n|  Method resolution order:\n|      NetworkError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::NetworkError::NetworkError(const std::string &msg, int\n|      errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteNetworkError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class NetworkTimeoutError",
                    "content": "|  NetworkTimeoutError(*args)\n|\n|  Indicates a timeout expired while communicating with a remote\n|  database.\n|\n|  Method resolution order:\n|      NetworkTimeoutError\n|      NetworkError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::NetworkTimeoutError::NetworkTimeoutError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteNetworkTimeoutError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class NumberRangeProcessor",
                    "content": "|  NumberRangeProcessor(*args)\n|\n|  Handle a number range.\n|\n|  This class must be used on values which have been encoded using\n|  Xapian::sortableserialise() which turns numbers into strings which\n|  will sort in the same order as the numbers (the same values can be\n|  used to implement a numeric sort).\n|\n|  Method resolution order:\n|      NumberRangeProcessor\n|      RangeProcessor\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::NumberRangeProcessor::NumberRangeProcessor(Xapian::valueno\n|      slot, const std::string &str=std::string(), unsigned flags=0)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot number to query.\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      numeric range.\n|\n|      flags:  Zero or more of the following flags, combined with bitwise-\n|      or: Xapian::RPSUFFIX - require str as a suffix instead of a prefix.\n|\n|      Xapian::RPREPEATED - optionally allow str on both ends of the range\n|      - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on\n|      the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the\n|      end (e.g. 2..12kg).\n|\n|      The string supplied in str is used by operator() to decide whether\n|      the pair of strings supplied to it constitute a valid range. If\n|      prefix is true, the first value in a range must begin with str (and\n|      the second value may optionally begin with str); if prefix is false,\n|      the second value in a range must end with str (and the first value\n|      may optionally end with str).\n|\n|      If str is empty, the setting of prefix is irrelevant, and no special\n|      strings are required at the start or end of the strings defining the\n|      range.\n|\n|      The remainder of both strings defining the endpoints must be valid\n|      floating point numbers. (FIXME: define format recognised).\n|\n|      For example, if str is \"$\" and prefix is true, and the range\n|      processor has been added to the queryparser, the queryparser will\n|      accept \"$10..50\" or \"$10..$50\", but not \"10..50\" or \"10..$50\"\n|      as valid ranges. If str is \"kg\" and prefix is false, the\n|      queryparser will accept \"10..50kg\" or \"10kg..50kg\", but not\n|      \"10..50\" or \"10kg..50\" as valid ranges.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteNumberRangeProcessor(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from RangeProcessor:\n|\n|  call = RangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  checkrange = RangeProcessorcheckrange(...)\n|      Check prefix/suffix on range.\n|\n|      Xapian::Query Xapian::RangeProcessor::checkrange(const std::string\n|      &b, const std::string &e)\n|\n|      If they match, remove the prefix/suffix and then call operator()() to\n|      try to handle the range.\n|\n|  release = RangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const RangeProcessor* Xapian::RangeProcessor::release() const\n|\n|      You can hand ownership of a dynamically allocated RangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from RangeProcessor:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class NumberValueRangeProcessor",
                    "content": "|  NumberValueRangeProcessor(*args)\n|\n|  Handle a number range.\n|\n|  This class must be used on values which have been encoded using\n|  Xapian::sortableserialise() which turns numbers into strings which\n|  will sort in the same order as the numbers (the same values can be\n|  used to implement a numeric sort).\n|\n|  Deprecated Use Xapian::NumberRangeProcessor instead (added in 1.3.6).\n|\n|  Method resolution order:\n|      NumberValueRangeProcessor\n|      StringValueRangeProcessor\n|      ValueRangeProcessor\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::NumberValueRangeProcessor::NumberValueRangeProcessor(Xapian::valueno\n|      slot, const std::string &str, bool prefix=true)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value number to return from operator().\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      numeric range.\n|\n|      prefix:  Whether to look for the string at the start or end of the\n|      values. If true, the string is a prefix; if false, the string is a\n|      suffix (default: true).\n|\n|      The string supplied in str is used by operator() to decide whether\n|      the pair of strings supplied to it constitute a valid range. If\n|      prefix is true, the first value in a range must begin with str (and\n|      the second value may optionally begin with str); if prefix is false,\n|      the second value in a range must end with str (and the first value\n|      may optionally end with str).\n|\n|      If str is empty, the setting of prefix is irrelevant, and no special\n|      strings are required at the start or end of the strings defining the\n|      range.\n|\n|      The remainder of both strings defining the endpoints must be valid\n|      floating point numbers. (FIXME: define format recognised).\n|\n|      For example, if str is \"$\" and prefix is true, and the range\n|      processor has been added to the queryparser, the queryparser will\n|      accept \"$10..50\" or \"$10..$50\", but not \"10..50\" or \"10..$50\"\n|      as valid ranges. If str is \"kg\" and prefix is false, the\n|      queryparser will accept \"10..50kg\" or \"10kg..50kg\", but not\n|      \"10..50\" or \"10kg..50\" as valid ranges.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteNumberValueRangeProcessor(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValueRangeProcessor:\n|\n|  call = ValueRangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  release = ValueRangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const ValueRangeProcessor* Xapian::ValueRangeProcessor::release()\n|      const\n|\n|      You can hand ownership of a dynamically allocated ValueRangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from ValueRangeProcessor:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class PL2PlusWeight",
                    "content": "|  PL2PlusWeight(*args)\n|\n|  Xapian::Weight subclass implementing the PL2+ probabilistic formula.\n|\n|  Method resolution order:\n|      PL2PlusWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::PL2PlusWeight::PL2PlusWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deletePL2PlusWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class PL2Weight",
                    "content": "|  PL2Weight(*args)\n|\n|  This class implements the PL2 weighting scheme.\n|\n|  PL2 is a representative scheme of the Divergence from Randomness\n|  Framework by Gianni Amati.\n|\n|  This weighting scheme is useful for tasks that require early\n|  precision.\n|\n|  It uses the Poisson approximation of the Binomial Probabilistic\n|  distribution (P) along with Stirling's approximation for the factorial\n|  value, the Laplace method to find the aftereffect of sampling (L) and\n|  the second wdf normalization proposed by Amati to normalize the wdf in\n|  the document to the length of the document (H2).\n|\n|  For more information about the DFR Framework and the PL2 scheme,\n|  please refer to : Gianni Amati and Cornelis Joost Van Rijsbergen\n|  Probabilistic models of information retrieval based on measuring the\n|  divergence from randomness ACM Transactions on Information Systems\n|  (TOIS) 20, (4), 2002, pp. 357-389.\n|\n|  Method resolution order:\n|      PL2Weight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Xapian::PL2Weight::PL2Weight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deletePL2Weight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class PositionIter",
                    "content": "|  PositionIter(start=0, end=0)\n|\n|  An iterator over a position list.\n|\n|  The iterator will return integers, in ascending order.\n|\n|  Methods defined here:\n|\n|  init(self, start=0, end=0)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class PostingItem",
                    "content": "|  PostingItem(iter)\n|\n|  An item returned from iteration of a posting list.\n|\n|  The item supports access to the following attributes and properties:\n|\n|   - `docid`: The document ID corresponding to this PostingItem.\n|   - `doclength`: The length of the document corresponding to this\n|     PostingItem.\n|   - `wdf`: The within document frequency of the term which the posting list\n|     is for in the document corresponding to this PostingItem.\n|   - `positer`: An iterator over the positions which the term corresponing to\n|     this posting list occurs at in the document corresponding to this\n|     PostingItem.  This is only available until the iterator which returned\n|     this item next moves.\n|\n|  Methods defined here:\n|\n|  init(self, iter)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  positer\n|      A position iterator for the current posting (if meaningful).\n|\n|      The iterator will return integers representing the positions that the term\n|      occurs at.\n|\n|      This will raise a InvalidOperationError exception if the iterator this item\n|      came from doesn't support position lists, or if the iterator has moved on\n|      since the item was returned from it.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  docid\n|\n|  doclength\n|\n|  wdf\n"
                },
                {
                    "name": "class PostingIter",
                    "content": "|  PostingIter(start, end, haspositions=False)\n|\n|  An iterator over a posting list.\n|\n|  The iterator will return PostingItem objects, which will be evaluated\n|  lazily where appropriate.\n|\n|  Methods defined here:\n|\n|  init(self, start, end, haspositions=False)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n|\n|  skipto(self, docid)\n|      Skip the iterator forward.\n|\n|      The iterator is advanced to the first document with a document ID\n|      which is greater than or equal to the supplied document ID.\n|\n|      If there are no such items, this will raise StopIteration.\n|\n|      This returns the item which the iterator is moved to.  The subsequent\n|      item will be returned the next time that next() is called (unless\n|      skipto() is called again first).\n"
                },
                {
                    "name": "class PostingSource",
                    "content": "|  Base class which provides an \"external\" source of postings.\n|\n|  Methods defined here:\n|\n|  disown(self)\n|\n|  init(self)\n|      Allow subclasses to be instantiated.\n|\n|      Xapian::PostingSource::PostingSource()\n|\n|  next = PostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      virtual void Xapian::PostingSource::next(double minwt)=0\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  repr = swigrepr(self)\n|\n|  str = PostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::PostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  atend = PostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      virtual bool Xapian::PostingSource::atend() const =0\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = PostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      virtual bool Xapian::PostingSource::check(Xapian::docid did, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  getdocid = PostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      virtual Xapian::docid Xapian::PostingSource::getdocid() const =0\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  gettermfreqest = PostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqest()\n|      const =0\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = PostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqmax()\n|      const =0\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = PostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      virtual Xapian::doccount Xapian::PostingSource::gettermfreqmin()\n|      const =0\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getweight = PostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      virtual double Xapian::PostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  init = PostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      virtual void Xapian::PostingSource::init(const Database &db)=0\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  name = PostingSourcename(...)\n|      Name of the posting source class.\n|\n|      virtual std::string Xapian::PostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  skipto = PostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      virtual void Xapian::PostingSource::skipto(Xapian::docid did, double\n|      minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deletePostingSource(...)\n|      virtual\n|      Xapian::PostingSource::~PostingSource()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class Query",
                    "content": "|  Query(*args)\n|\n|  Class representing a query.\n|\n|  Methods defined here:\n|\n|  init = queryinit(self, *args)\n|      Make a new query object.\n|\n|      Many possible arguments are possible - see the documentation for details.\n|\n|  iter = querygeniter(self)\n|      Get an iterator over the terms in a query.\n|\n|      The iterator will return string objects.\n|\n|  repr = swigrepr(self)\n|\n|  str = Querystr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::Query::getdescription() const\n|\n|  empty = Queryempty(...)\n|      Check if this query is Xapian::Query::MatchNothing.\n|\n|      bool Xapian::Query::empty() const\n|\n|  getlength = Querygetlength(...)\n|      Return the length of this query object.\n|\n|      Xapian::termcount Xapian::Query::getlength() const\n|\n|  getnumsubqueries = Querygetnumsubqueries(...)\n|      Get the number of subqueries of the top level query.\n|\n|      sizet Xapian::Query::getnumsubqueries() const\n|\n|  getsubquery = Querygetsubquery(...)\n|      Read a top level subquery.\n|\n|      const Query Xapian::Query::getsubquery(sizet n) const\n|\n|      Parameters:\n|      -----------\n|\n|      n:  Return the n-th subquery (starting from 0) - only valid when 0 <=\n|      n < getnumsubqueries().\n|\n|  gettype = Querygettype(...)\n|      Get the type of the top level of the query.\n|\n|      op Xapian::Query::gettype() const\n|\n|  getuniquetermsbegin = Querygetuniquetermsbegin(...)\n|      Begin iterator for unique terms in the query object.\n|\n|      const TermIterator Xapian::Query::getuniquetermsbegin() const\n|\n|      Terms are sorted and terms with the same name removed from the list.\n|\n|      If you want the terms in ascending query position order, see\n|      gettermsbegin().\n|\n|  getuniquetermsend = Querygetuniquetermsend(...)\n|      End iterator for unique terms in the query object.\n|\n|      const TermIterator Xapian::Query::getuniquetermsend() const\n|\n|  serialise = Queryserialise(...)\n|      Serialise this object into a string.\n|\n|      std::string Xapian::Query::serialise() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteQuery(...)\n|      Destructor.\n|\n|      Xapian::Query::~Query()\n|\n|  unserialise = Queryunserialise(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  MatchAll = <xapian.Query; proxy of <Swig Object of type 'Xapian::Query...\n|\n|  MatchNothing = <xapian.Query; proxy of <Swig Object of type 'Xapian::Q...\n|\n|  OPAND = 0\n|\n|  OPANDMAYBE = 4\n|\n|  OPANDNOT = 2\n|\n|  OPELITESET = 10\n|\n|  OPFILTER = 5\n|\n|  OPINVALID = 99\n|\n|  OPMAX = 14\n|\n|  OPNEAR = 6\n|\n|  OPOR = 1\n|\n|  OPPHRASE = 7\n|\n|  OPSCALEWEIGHT = 9\n|\n|  OPSYNONYM = 13\n|\n|  OPVALUEGE = 11\n|\n|  OPVALUELE = 12\n|\n|  OPVALUERANGE = 8\n|\n|  OPWILDCARD = 15\n|\n|  OPXOR = 3\n|\n|  WILDCARDLIMITERROR = 0\n|\n|  WILDCARDLIMITFIRST = 1\n|\n|  WILDCARDLIMITMOSTFREQUENT = 2\n"
                },
                {
                    "name": "class QueryParser",
                    "content": "|  Build a Xapian::Query object from a user query string.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::QueryParser::QueryParser()\n|\n|  repr = swigrepr(self)\n|\n|  str = QueryParserstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::QueryParser::getdescription() const\n|\n|  addbooleanprefix = queryparseraddbooleanprefix(self, s, proc, exclusive=True)\n|      Register a FieldProcessor for a boolean prefix.\n|\n|      void Xapian::QueryParser::addbooleanprefix(const std::string &field,\n|      Xapian::FieldProcessor *proc, bool exclusive)\n|\n|      This is an older version of this method - use the version with the\n|      grouping parameter in preference to this one.\n|\n|  addprefix = queryparseraddprefix(self, s, proc)\n|      Register a FieldProcessor.\n|\n|      void Xapian::QueryParser::addprefix(const std::string &field,\n|      Xapian::FieldProcessor *proc)\n|\n|  addrangeprocessor = queryparseraddrangeprocessor(self, rproc)\n|      Register a RangeProcessor.\n|\n|      void Xapian::QueryParser::addrangeprocessor(Xapian::RangeProcessor\n|      *rangeproc, const std::string *grouping=NULL)\n|\n|  addvaluerangeprocessor = queryparseraddvaluerangeprocessor(self, vrproc)\n|      Register a ValueRangeProcessor.\n|\n|      void\n|      Xapian::QueryParser::addvaluerangeprocessor(Xapian::ValueRangeProcessor\n|      *vrproc)\n|\n|      This method is provided for API compatibility with Xapian 1.2.x and is\n|      deprecated - use  addrangeprocessor() with a RangeProcessor instead.\n|\n|      Compatibility shim.\n|\n|  getcorrectedquerystring = QueryParsergetcorrectedquerystring(...)\n|      Get the spelling-corrected query string.\n|\n|      std::string Xapian::QueryParser::getcorrectedquerystring() const\n|\n|      This will only be set if FLAGSPELLINGCORRECTION is specified when\n|      QueryParser::parsequery() was last called.\n|\n|      If there were no corrections, an empty string is returned.\n|\n|  getdefaultop = QueryParsergetdefaultop(...)\n|      Get the current default operator.\n|\n|      Query::op Xapian::QueryParser::getdefaultop() const\n|\n|  parsequery = QueryParserparsequery(...)\n|      Parse a query.\n|\n|      Query Xapian::QueryParser::parsequery(const std::string\n|      &querystring, unsigned flags=FLAGDEFAULT, const std::string\n|      &defaultprefix=std::string())\n|\n|      Parameters:\n|      -----------\n|\n|      querystring:  A free-text query as entered by a user\n|\n|      flags:  Zero or more QueryParser::featureflag specifying what\n|      features the QueryParser should support. Combine multiple values with\n|      bitwise-or (|) (default FLAGDEFAULT).\n|\n|      defaultprefix:  The default term prefix to use (default none). For\n|      example, you can pass \"A\" when parsing an \"Author\" field.\n|\n|      Parameters:\n|      -----------\n|\n|      If:  the query string can't be parsed, then Xapian::QueryParserError\n|      is thrown. You can get an English error message to report to the user\n|      by catching it and calling getmsg() on the caught exception. The\n|      current possible values (in case you want to translate them) are:\n|\n|      Unknown range operation\n|\n|      parse error\n|\n|      Syntax: <expression> AND <expression>\n|\n|      Syntax: <expression> AND NOT <expression>\n|\n|      Syntax: <expression> NOT <expression>\n|\n|      Syntax: <expression> OR <expression>\n|\n|      Syntax: <expression> XOR <expression>\n|\n|  setdatabase = QueryParsersetdatabase(...)\n|      Specify the database being searched.\n|\n|      void Xapian::QueryParser::setdatabase(const Database &db)\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database to use for spelling correction\n|      (FLAGSPELLINGCORRECTION), and synonyms (FLAGSYNONYM,\n|      FLAGAUTOSYNONYMS, and FLAGAUTOMULTIWORDSYNONYMS).\n|\n|  setdefaultop = QueryParsersetdefaultop(...)\n|      Set the default operator.\n|\n|      void Xapian::QueryParser::setdefaultop(Query::op defaultop)\n|\n|      Parameters:\n|      -----------\n|\n|      defaultop:  The operator to use to combine non-filter query items\n|      when no explicit operator is used.\n|\n|      So for example, 'weather forecast' is parsed as if it were 'weather OR\n|      forecast' by default.\n|\n|      The most useful values for this are OPOR (the default) and OPAND.\n|      OPNEAR, OPPHRASE, OPELITESET, OPSYNONYM and OPMAX are also\n|      permitted. Passing other values will result in InvalidArgumentError\n|      being thrown.\n|\n|  setmaxexpansion = QueryParsersetmaxexpansion(...)\n|      Specify the maximum expansion of a wildcard and/or partial term.\n|\n|      void Xapian::QueryParser::setmaxexpansion(Xapian::termcount\n|      maxexpansion, int maxtype=Xapian::Query::WILDCARDLIMITERROR,\n|      unsigned flags=FLAGWILDCARD|FLAGPARTIAL)\n|\n|      Note: you must also set FLAGWILDCARD and/or FLAGPARTIAL in the flags\n|      parameter to  parsequery() for this setting to have anything to\n|      affect.\n|\n|      If you don't call this method, the default settings are no limit on\n|      wildcard expansion, and partial terms expanding to the most frequent\n|      100 terms - i.e. as if you'd called:\n|\n|      setmaxexpansion(0); setmaxexpansion(100,\n|      Xapian::Query::WILDCARDLIMITMOSTFREQUENT,\n|      Xapian::QueryParser::FLAGPARTIAL);\n|\n|      Parameters:\n|      -----------\n|\n|      maxexpansion:  The maximum number of terms each wildcard in the query\n|      can expand to, or 0 for no limit (which is the default).\n|\n|      maxtype:    Xapian::Query::WILDCARDLIMITERROR,\n|      Xapian::Query::WILDCARDLIMITFIRST or\n|      Xapian::Query::WILDCARDLIMITMOSTFREQUENT (default:\n|      Xapian::Query::WILDCARDLIMITERROR).\n|\n|      flags:  What to set the limit for (default:\n|      FLAGWILDCARD|FLAGPARTIAL, setting the limit for both wildcards and\n|      partial terms).\n|\n|      1.3.3\n|\n|  setmaxwildcardexpansion = QueryParsersetmaxwildcardexpansion(...)\n|      Specify the maximum expansion of a wildcard.\n|\n|      void\n|      Xapian::QueryParser::setmaxwildcardexpansion(Xapian::termcount)\n|\n|      If any wildcard expands to more than maxexpansion terms, an exception\n|      will be thrown.\n|\n|      This method is provided for API compatibility with Xapian 1.2.x and is\n|      deprecated - replace it with:\n|\n|      setmaxwildcardexpansion(maxexpansion,\n|      Xapian::Query::WILDCARDLIMITERROR,\n|      Xapian::QueryParser::FLAGWILDCARD);\n|\n|  setstemmer = QueryParsersetstemmer(...)\n|      Set the stemmer.\n|\n|      void Xapian::QueryParser::setstemmer(const Xapian::Stem &stemmer)\n|\n|      This sets the stemming algorithm which will be used by the query\n|      parser. The stemming algorithm will be used according to the stemming\n|      strategy set by setstemmingstrategy(). As of 1.3.1, this defaults to\n|      STEMSOME, but in earlier versions the default was STEMNONE. If you\n|      want to work with older versions, you should explicitly set a stemming\n|      strategy as well as setting a stemmer, otherwise your stemmer won't\n|      actually be used.\n|\n|      Parameters:\n|      -----------\n|\n|      stemmer:  The Xapian::Stem object to set.\n|\n|  setstemmingstrategy = QueryParsersetstemmingstrategy(...)\n|      Set the stemming strategy.\n|\n|      void Xapian::QueryParser::setstemmingstrategy(stemstrategy\n|      strategy)\n|\n|      This controls how the query parser will apply the stemming algorithm.\n|      Note that the stemming algorithm is only applied to words in free-text\n|      fields - boolean filter terms are never stemmed.\n|\n|      Parameters:\n|      -----------\n|\n|      strategy:  The strategy to use - possible values are: STEMNONE: Don't\n|      perform any stemming. (default in Xapian <= 1.3.0)\n|\n|      STEMSOME: Stem all terms except for those which start with a capital\n|      letter, or are followed by certain characters (currently: (/@<>=*[{\"\n|      ), or are used with operators which need positional information.\n|      Stemmed terms are prefixed with 'Z'. (default in Xapian >= 1.3.1)\n|\n|      STEMSOMEFULLPOS: Like STEMSOME but also stems terms used with\n|      operators which need positional information. Added in Xapian 1.4.8.\n|\n|      STEMALL: Stem all terms (note: no 'Z' prefix is added).\n|\n|      STEMALLZ: Stem all terms (note: 'Z' prefix is added). (new in Xapian\n|      1.2.11 and 1.3.1)\n|\n|  setstopper = queryparsersetstopper(self, stopper)\n|      Set the stopper.\n|\n|      void Xapian::QueryParser::setstopper(const Stopper *stop=NULL)\n|\n|      Parameters:\n|      -----------\n|\n|      stop:  The Stopper object to set (default NULL, which means no\n|      stopwords).\n|\n|  stoplist = queryparsergenstoplistiter(self)\n|      Get an iterator over all the stopped terms from the previous query.\n|\n|      This returns an iterator over all the terms which were omitted from the\n|      previously parsed query due to being considered to be stopwords.  Each\n|      instance of a word omitted from the query is represented in the returned\n|      list, in the order in which the\n|\n|      The iterator will return string objects.\n|\n|  unstemlist = queryparsergenunstemlistiter(self, tname)\n|      Get an iterator over all the unstemmed forms of a stemmed term.\n|\n|      This returns an iterator which returns all the unstemmed words which were\n|      stemmed to the stemmed form specified by `tname` when parsing the previous\n|      query.  Each instance of a word which stems to `tname` is returned by the\n|      iterator in the order in which the words appeared in the query - an\n|      individual unstemmed word may thus occur multiple times.\n|\n|      The iterator will return string objects.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteQueryParser(...)\n|      Destructor.\n|\n|      Xapian::QueryParser::~QueryParser()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  FLAGACCUMULATE = 65536\n|\n|  FLAGAUTOMULTIWORDSYNONYMS = 1024\n|\n|  FLAGAUTOSYNONYMS = 512\n|\n|  FLAGBOOLEAN = 1\n|\n|  FLAGBOOLEANANYCASE = 8\n|\n|  FLAGCJKNGRAM = 2048\n|\n|  FLAGDEFAULT = 7\n|\n|  FLAGLOVEHATE = 4\n|\n|  FLAGPARTIAL = 64\n|\n|  FLAGPHRASE = 2\n|\n|  FLAGPURENOT = 32\n|\n|  FLAGSPELLINGCORRECTION = 128\n|\n|  FLAGSYNONYM = 256\n|\n|  FLAGWILDCARD = 16\n|\n|  STEMALL = 2\n|\n|  STEMALLZ = 3\n|\n|  STEMNONE = 0\n|\n|  STEMSOME = 1\n|\n|  STEMSOMEFULLPOS = 4\n"
                },
                {
                    "name": "class QueryParserError",
                    "content": "|  QueryParserError(*args)\n|\n|  Indicates a query string can't be parsed.\n|\n|  Method resolution order:\n|      QueryParserError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::QueryParserError::QueryParserError(const std::string &msg,\n|      int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteQueryParserError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class RSet",
                    "content": "|  A relevance set (R-Set).\n|\n|  This is the set of documents which are marked as relevant, for use in\n|  modifying the term weights, and in performing query expansion.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::RSet::RSet()\n|\n|  repr = swigrepr(self)\n|\n|  str = RSetstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::RSet::getdescription() const\n|\n|  adddocument = RSetadddocument(...)\n|      Add a document to the relevance set.\n|\n|      void Xapian::RSet::adddocument(const Xapian::MSetIterator &i)\n|\n|  contains = RSetcontains(...)\n|      Test if a given document in the relevance set.\n|\n|      bool Xapian::RSet::contains(const Xapian::MSetIterator &i) const\n|\n|  empty = RSetempty(...)\n|      Test if this R-Set is empty.\n|\n|      bool Xapian::RSet::empty() const\n|\n|  removedocument = RSetremovedocument(...)\n|      Remove a document from the relevance set.\n|\n|      void Xapian::RSet::removedocument(const Xapian::MSetIterator &i)\n|\n|  size = RSetsize(...)\n|      The number of documents in this R-Set.\n|\n|      Xapian::doccount Xapian::RSet::size() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteRSet(...)\n|      Destructor.\n|\n|      Xapian::RSet::~RSet()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class RangeError",
                    "content": "|  RangeError(*args)\n|\n|  RangeError indicates an attempt to access outside the bounds of a\n|  container.\n|\n|  Method resolution order:\n|      RangeError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::RangeError::RangeError(const std::string &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteRangeError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class RangeProcessor",
                    "content": "|  RangeProcessor(*args)\n|\n|  Base class for range processors.\n|\n|  Methods defined here:\n|\n|  call = RangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::RangeProcessor::RangeProcessor(Xapian::valueno slot, const\n|      std::string &str=std::string(), unsigned flags=0)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  Which value slot to generate ranges over.\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      range (as a prefix by default, or as a suffix if flags\n|      Xapian::RPSUFFIX is specified).\n|\n|      flags:  Zero or more of the following flags, combined with bitwise-or\n|      (| in C++): Xapian::RPSUFFIX - require str as a suffix instead of a\n|      prefix.\n|\n|      Xapian::RPREPEATED - optionally allow str on both ends of the range\n|      - e.g. $1..$10 or 5m..50m. By default a prefix is only checked for on\n|      the start (e.g. date:1/1/1980..31/12/1989), and a suffix only on the\n|      end (e.g. 2..12kg).\n|\n|  repr = swigrepr(self)\n|\n|  checkrange = RangeProcessorcheckrange(...)\n|      Check prefix/suffix on range.\n|\n|      Xapian::Query Xapian::RangeProcessor::checkrange(const std::string\n|      &b, const std::string &e)\n|\n|      If they match, remove the prefix/suffix and then call operator()() to\n|      try to handle the range.\n|\n|  release = RangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const RangeProcessor* Xapian::RangeProcessor::release() const\n|\n|      You can hand ownership of a dynamically allocated RangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteRangeProcessor(...)\n|      Destructor.\n|\n|      virtual Xapian::RangeProcessor::~RangeProcessor()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class Registry",
                    "content": "|  Registry for user subclasses.\n|\n|  This class provides a way for the remote server to look up user\n|  subclasses when unserialising.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::Registry::Registry()\n|\n|      The registry will contain all standard subclasses of user-subclassable\n|      classes.\n|\n|  repr = swigrepr(self)\n|\n|  getlatlongmetric = Registrygetlatlongmetric(...)\n|      Get a lat-long metric given a name.\n|\n|      const Xapian::LatLongMetric*\n|      Xapian::Registry::getlatlongmetric(const std::string &name) const\n|\n|      The returned metric is owned by the registry object.\n|\n|      Returns NULL if the metric could not be found.\n|\n|  getmatchspy = Registrygetmatchspy(...)\n|      Get a match spy given a name.\n|\n|      const Xapian::MatchSpy* Xapian::Registry::getmatchspy(const\n|      std::string &name) const\n|\n|      Parameters:\n|      -----------\n|\n|      name:  The name of the match spy to find.\n|\n|      An object with the requested name, or NULL if the match spy could not\n|      be found. The returned object is owned by the registry and so must not\n|      be deleted by the caller.\n|\n|  getpostingsource = Registrygetpostingsource(...)\n|      Get a posting source given a name.\n|\n|      const Xapian::PostingSource*\n|      Xapian::Registry::getpostingsource(const std::string &name) const\n|\n|      Parameters:\n|      -----------\n|\n|      name:  The name of the posting source to find.\n|\n|      An object with the requested name, or NULL if the posting source could\n|      not be found. The returned object is owned by the registry and so must\n|      not be deleted by the caller.\n|\n|  getweightingscheme = Registrygetweightingscheme(...)\n|      Get the weighting scheme given a name.\n|\n|      const Xapian::Weight* Xapian::Registry::getweightingscheme(const\n|      std::string &name) const\n|\n|      Parameters:\n|      -----------\n|\n|      name:  The name of the weighting scheme to find.\n|\n|      An object with the requested name, or NULL if the weighting scheme\n|      could not be found. The returned object is owned by the registry and\n|      so must not be deleted by the caller.\n|\n|  registerlatlongmetric = Registryregisterlatlongmetric(...)\n|      Register a user-defined lat-long metric class.\n|\n|      void Xapian::Registry::registerlatlongmetric(const\n|      Xapian::LatLongMetric &metric)\n|\n|  registermatchspy = Registryregistermatchspy(...)\n|      Register a user-defined match spy class.\n|\n|      void Xapian::Registry::registermatchspy(const Xapian::MatchSpy &spy)\n|\n|      Parameters:\n|      -----------\n|\n|      spy:  The match spy to register.\n|\n|  registerpostingsource = Registryregisterpostingsource(...)\n|      Register a user-defined posting source class.\n|\n|      void Xapian::Registry::registerpostingsource(const\n|      Xapian::PostingSource &source)\n|\n|      Parameters:\n|      -----------\n|\n|      source:  The posting source to register.\n|\n|  registerweightingscheme = Registryregisterweightingscheme(...)\n|      Register a weighting scheme.\n|\n|      void Xapian::Registry::registerweightingscheme(const Xapian::Weight\n|      &wt)\n|\n|      Parameters:\n|      -----------\n|\n|      wt:  The weighting scheme to register.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteRegistry(...)\n|      Xapian::Registry::~Registry()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class RuntimeError",
                    "content": "|  RuntimeError(*args, kwargs)\n|\n|  The base class for exceptions indicating errors only detectable at\n|  runtime.\n|\n|  A subclass of RuntimeError will be thrown if Xapian detects an error\n|  which is exception derived from RuntimeError is thrown when an error\n|  is caused by problems with the data or environment rather than a\n|  programming mistake.\n|\n|  Method resolution order:\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteRuntimeError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class SerialisationError",
                    "content": "|  SerialisationError(*args)\n|\n|  Indicates an error in the std::string serialisation of an object.\n|\n|  Method resolution order:\n|      SerialisationError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::SerialisationError::SerialisationError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteSerialisationError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class SimpleStopper",
                    "content": "|  SimpleStopper(*args)\n|\n|  Simple implementation of Stopper class - this will suit most users.\n|\n|  Method resolution order:\n|      SimpleStopper\n|      Stopper\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Initialise from a pair of iterators.\n|\n|      Xapian::SimpleStopper::SimpleStopper(Iterator begin, Iterator end)\n|\n|      Xapian includes stop list files for many languages. You can initialise\n|      from a file like that:\n|\n|  repr = swigrepr(self)\n|\n|  add = SimpleStopperadd(...)\n|      Add a single stop word.\n|\n|      void Xapian::SimpleStopper::add(const std::string &word)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteSimpleStopper(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Stopper:\n|\n|  call = Stoppercall(...)\n|\n|  disown(self)\n|\n|  str = Stopperstr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::Stopper::getdescription() const\n|\n|  release = Stopperrelease(...)\n|      Start reference counting this object.\n|\n|      const Stopper* Xapian::Stopper::release() const\n|\n|      You can hand ownership of a dynamically allocated Stopper object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Stopper:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class Stem",
                    "content": "|  Stem(*args)\n|\n|  Class representing a stemming algorithm.\n|\n|  Methods defined here:\n|\n|  call = Stemcall(...)\n|\n|  init = steminit(self, *args)\n|      Construct a Xapian::Stem object with a user-provided stemming\n|      algorithm.\n|\n|      Xapian::Stem::Stem(StemImplementation *p)\n|\n|      You can subclass Xapian::StemImplementation to implement your own\n|      stemming algorithm (or to wrap a third-party algorithm) and then wrap\n|      your implementation in a Xapian::Stem object to pass to the Xapian\n|      API.\n|\n|      Parameters:\n|      -----------\n|\n|      p:  The user-subclassed StemImplementation object. This is reference\n|      counted, and so will be automatically deleted by the Xapian::Stem\n|      wrapper when no longer required.\n|\n|  repr = swigrepr(self)\n|\n|  str = Stemstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::Stem::getdescription() const\n|\n|  isnone = Stemisnone(...)\n|      Return true if this is a no-op stemmer.\n|\n|      bool Xapian::Stem::isnone() const\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteStem(...)\n|      Destructor.\n|\n|      Xapian::Stem::~Stem()\n|\n|  getavailablelanguages = Stemgetavailablelanguages(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class StemImplementation",
                    "content": "|  Class representing a stemming algorithm implementation.\n|\n|  Methods defined here:\n|\n|  call = StemImplementationcall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::StemImplementation::StemImplementation()\n|\n|  repr = swigrepr(self)\n|\n|  str = StemImplementationstr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::StemImplementation::getdescription()\n|      const =0\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteStemImplementation(...)\n|      Virtual destructor.\n|\n|      virtual Xapian::StemImplementation::~StemImplementation()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class Stopper",
                    "content": "|  Base class for stop-word decision functor.\n|\n|  Methods defined here:\n|\n|  call = Stoppercall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::Stopper::Stopper()\n|\n|  repr = swigrepr(self)\n|\n|  str = Stopperstr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::Stopper::getdescription() const\n|\n|  release = Stopperrelease(...)\n|      Start reference counting this object.\n|\n|      const Stopper* Xapian::Stopper::release() const\n|\n|      You can hand ownership of a dynamically allocated Stopper object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteStopper(...)\n|      Class has virtual methods, so provide a virtual destructor.\n|\n|      virtual Xapian::Stopper::~Stopper()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class StringValueRangeProcessor",
                    "content": "|  StringValueRangeProcessor(*args)\n|\n|  Handle a string range.\n|\n|  The end points can be any strings.\n|\n|  Deprecated Use Xapian::RangeProcessor instead (added in 1.3.6).\n|\n|  Method resolution order:\n|      StringValueRangeProcessor\n|      ValueRangeProcessor\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Constructor.\n|\n|      Xapian::StringValueRangeProcessor::StringValueRangeProcessor(Xapian::valueno\n|      slot, const std::string &str, bool prefix=true)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value number to return from operator().\n|\n|      str:  A string to look for to recognise values as belonging to this\n|      range.\n|\n|      prefix:  Flag specifying whether to check for str as a prefix or a\n|      suffix.\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteStringValueRangeProcessor(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValueRangeProcessor:\n|\n|  call = ValueRangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  release = ValueRangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const ValueRangeProcessor* Xapian::ValueRangeProcessor::release()\n|      const\n|\n|      You can hand ownership of a dynamically allocated ValueRangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from ValueRangeProcessor:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class TermGenerator",
                    "content": "|  Parses a piece of text and generate terms.\n|\n|  This module takes a piece of text and parses it to produce words which\n|  are then used to generate suitable terms for indexing. The terms\n|  generated are suitable for use with Query objects produced by the\n|  QueryParser class.\n|\n|  Methods defined here:\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::TermGenerator::TermGenerator()\n|\n|  repr = swigrepr(self)\n|\n|  str = TermGeneratorstr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::TermGenerator::getdescription() const\n|\n|  getdocument = TermGeneratorgetdocument(...)\n|      Get the current document.\n|\n|      const Xapian::Document& Xapian::TermGenerator::getdocument() const\n|\n|  gettermpos = TermGeneratorgettermpos(...)\n|      Get the current term position.\n|\n|      Xapian::termpos Xapian::TermGenerator::gettermpos() const\n|\n|  increasetermpos = TermGeneratorincreasetermpos(...)\n|      Increase the term position used by indextext.\n|\n|      void Xapian::TermGenerator::increasetermpos(Xapian::termpos\n|      delta=100)\n|\n|      This can be used between indexing text from different fields or other\n|      places to prevent phrase searches from spanning between them (e.g.\n|      between the title and body text, or between two chapters in a book).\n|\n|      Parameters:\n|      -----------\n|\n|      delta:  Amount to increase the term position by (default: 100).\n|\n|  indextext = TermGeneratorindextext(...)\n|      Index some text in a std::string.\n|\n|      void Xapian::TermGenerator::indextext(const std::string &text,\n|      Xapian::termcount wdfinc=1, const std::string &prefix=std::string())\n|\n|      Parameters:\n|      -----------\n|\n|      text:  The text to index.\n|\n|      wdfinc:  The wdf increment (default 1).\n|\n|      prefix:  The term prefix to use (default is no prefix).\n|\n|  indextextwithoutpositions = TermGeneratorindextextwithoutpositions(...)\n|      Index some text in a std::string without positional information.\n|\n|      void Xapian::TermGenerator::indextextwithoutpositions(const\n|      std::string &text, Xapian::termcount wdfinc=1, const std::string\n|      &prefix=std::string())\n|\n|      Just like indextext, but no positional information is generated. This\n|      means that the database will be significantly smaller, but that phrase\n|      searching and NEAR won't be supported.\n|\n|      Parameters:\n|      -----------\n|\n|      text:  The text to index.\n|\n|      wdfinc:  The wdf increment (default 1).\n|\n|      prefix:  The term prefix to use (default is no prefix).\n|\n|  setdatabase = TermGeneratorsetdatabase(...)\n|      Set the database to index spelling data to.\n|\n|      void Xapian::TermGenerator::setdatabase(const\n|      Xapian::WritableDatabase &db)\n|\n|  setdocument = TermGeneratorsetdocument(...)\n|      Set the current document.\n|\n|      void Xapian::TermGenerator::setdocument(const Xapian::Document &doc)\n|\n|  setflags = TermGeneratorsetflags(...)\n|      Set flags.\n|\n|      flags Xapian::TermGenerator::setflags(flags toggle, flags\n|      mask=flags(0))\n|\n|      The new value of flags is: (flags & mask) ^ toggle\n|\n|      To just set the flags, pass the new flags in toggle and the default\n|      value for mask.\n|\n|      Parameters:\n|      -----------\n|\n|      toggle:  Flags to XOR.\n|\n|      mask:  Flags to AND with first.\n|\n|      The old flags setting.\n|\n|  setmaxwordlength = TermGeneratorsetmaxwordlength(...)\n|      Set the maximum length word to index.\n|\n|      void Xapian::TermGenerator::setmaxwordlength(unsigned\n|      maxwordlength)\n|\n|      The limit is on the length of a word prior to stemming and prior to\n|      adding any term prefix.\n|\n|      The backends mostly impose a limit on the length of terms (often of\n|      about 240 bytes), but it's generally useful to have a lower limit to\n|      help prevent the index being bloated by useless junk terms from trying\n|      to indexing things like binary data, uuencoded data, ASCII art, etc.\n|\n|      This method was new in Xapian 1.3.1.\n|\n|      Parameters:\n|      -----------\n|\n|      maxwordlength:  The maximum length word to index, in bytes in UTF-8\n|      representation. Default is 64.\n|\n|  setstemmer = TermGeneratorsetstemmer(...)\n|      Set the Xapian::Stem object to be used for generating stemmed terms.\n|\n|      void Xapian::TermGenerator::setstemmer(const Xapian::Stem &stemmer)\n|\n|  setstemmingstrategy = TermGeneratorsetstemmingstrategy(...)\n|      Set the stemming strategy.\n|\n|      void Xapian::TermGenerator::setstemmingstrategy(stemstrategy\n|      strategy)\n|\n|      This method controls how the stemming algorithm is applied. It was new\n|      in Xapian 1.3.1.\n|\n|      Parameters:\n|      -----------\n|\n|      strategy:  The strategy to use - possible values are: STEMNONE: Don't\n|      perform any stemming - only unstemmed terms are generated.\n|\n|      STEMSOME: Generate both stemmed (with a \"Z\" prefix) and unstemmed\n|      terms. No positional information is stored for unstemmed terms. This\n|      is the default strategy.\n|\n|      STEMSOMEFULLPOS: Like STEMSOME but positional information is\n|      stored for both stemmed and unstemmed terms. Added in Xapian 1.4.8.\n|\n|      STEMALL: Generate only stemmed terms (but without a \"Z\" prefix).\n|\n|      STEMALLZ: Generate only stemmed terms (with a \"Z\" prefix).\n|\n|  setstopper = termgeneratorsetstopper(self, stopper)\n|      Set the Xapian::Stopper object to be used for identifying stopwords.\n|\n|      void Xapian::TermGenerator::setstopper(const Xapian::Stopper\n|      *stop=NULL)\n|\n|      Stemmed forms of stopwords aren't indexed, but unstemmed forms still\n|      are so that searches for phrases including stop words still work.\n|\n|      Parameters:\n|      -----------\n|\n|      stop:  The Stopper object to set (default NULL, which means no\n|      stopwords).\n|\n|  setstopperstrategy = TermGeneratorsetstopperstrategy(...)\n|      Set the stopper strategy.\n|\n|      void Xapian::TermGenerator::setstopperstrategy(stopstrategy\n|      strategy)\n|\n|      The method controls how the stopper is used. It was added in Xapian\n|      1.4.1.\n|\n|      You need to also call  setstopper() for this to have any effect.\n|\n|      Parameters:\n|      -----------\n|\n|      strategy:  The strategy to use - possible values are: STOPNONE: Don't\n|      use the stopper.\n|\n|      STOPALL: If a word is identified as a stop word, skip it completely.\n|\n|      STOPSTEMMED: If a word is identified as a stop word, index its\n|      unstemmed form but skip the stem. Unstemmed forms are indexed with\n|      positional information by default, so this allows searches for phrases\n|      containing stopwords to be supported. (This is the default mode).\n|\n|  settermpos = TermGeneratorsettermpos(...)\n|      Set the current term position.\n|\n|      void Xapian::TermGenerator::settermpos(Xapian::termpos termpos)\n|\n|      Parameters:\n|      -----------\n|\n|      termpos:  The new term position to set.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteTermGenerator(...)\n|      Destructor.\n|\n|      Xapian::TermGenerator::~TermGenerator()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  FLAGCJKNGRAM = 2048\n|\n|  FLAGSPELLING = 128\n|\n|  STEMALL = 2\n|\n|  STEMALLZ = 3\n|\n|  STEMNONE = 0\n|\n|  STEMSOME = 1\n|\n|  STEMSOMEFULLPOS = 4\n|\n|  STOPALL = 1\n|\n|  STOPNONE = 0\n|\n|  STOPSTEMMED = 2\n"
                },
                {
                    "name": "class TermIter",
                    "content": "|  TermIter(start, end, hastermfreq=0, haswdf=0, haspositions=0, returnstrings=False)\n|\n|  An iterator over a term list.\n|\n|  The iterator will return TermListItem objects, which will be evaluated\n|  lazily where appropriate.\n|\n|  Methods defined here:\n|\n|  init(self, start, end, hastermfreq=0, haswdf=0, haspositions=0, returnstrings=False)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n|\n|  skipto(self, term)\n|      Skip the iterator forward.\n|\n|      The iterator is advanced to the first term at or after the current\n|      position which is greater than or equal to the supplied term.\n|\n|      If there are no such items, this will raise StopIteration.\n|\n|      This returns the item which the iterator is moved to.  The subsequent\n|      item will be returned the next time that next() is called (unless\n|      skipto() is called again first).\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  EAGER = 2\n|\n|  INVALID = 0\n|\n|  LAZY = 1\n"
                },
                {
                    "name": "class TermListItem",
                    "content": "|  TermListItem(iter, term)\n|\n|  An item returned from iteration of a term list.\n|\n|  The item supports access to the following attributes and properties:\n|\n|   - `term`: The term corresponding to this TermListItem.\n|   - `wdf`: The within document frequency of this term.\n|   - `termfreq`: The number of documents in the collection which are indexed\n|     by the term\n|   - `positer`: An iterator over the positions which the term appears at in\n|     the document.  This is only available until the iterator which returned\n|     this item next moves.\n|\n|  Methods defined here:\n|\n|  init(self, iter, term)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Readonly properties defined here:\n|\n|  positer\n|      A position iterator for the current term (if meaningful).\n|\n|      The iterator will return integers representing the positions that the term\n|      occurs at.\n|\n|      This will raise a InvalidOperationError exception if the iterator this item\n|      came from doesn't support position lists, or if the iterator has moved on\n|      since the item was returned from it.\n|\n|  termfreq\n|      The term frequency of the current term (if meaningful).\n|\n|      This is the number of documents in the collection which are indexed by the\n|      term.\n|\n|      This will raise a InvalidOperationError exception if the iterator\n|      this item came from doesn't support term frequencies.\n|\n|  wdf\n|      The within-document-frequency of the current term (if meaningful).\n|\n|      This will raise a InvalidOperationError exception if the iterator\n|      this item came from doesn't support within-document-frequencies.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  term\n"
                },
                {
                    "name": "class TfIdfWeight",
                    "content": "|  TfIdfWeight(*args)\n|\n|  Xapian::Weight subclass implementing the tf-idf weighting scheme.\n|\n|  Method resolution order:\n|      TfIdfWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a TfIdfWeight using the default normalizations (\"ntn\").\n|\n|      Xapian::TfIdfWeight::TfIdfWeight()\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteTfIdfWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class TradWeight",
                    "content": "|  TradWeight(k=1.0)\n|\n|  Xapian::Weight subclass implementing the traditional probabilistic\n|  formula.\n|\n|  This class implements the \"traditional\" Probabilistic Weighting\n|  scheme, as described by the early papers on Probabilistic Retrieval.\n|  BM25 generally gives better results.\n|\n|  TradWeight(k) is equivalent to BM25Weight(k, 0, 0, 1, 0), except that\n|  the latter returns weights (k+1) times larger.\n|\n|  Method resolution order:\n|      TradWeight\n|      Weight\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, k=1.0)\n|      Construct a TradWeight.\n|\n|      Xapian::TradWeight::TradWeight(double k=1.0)\n|\n|      Parameters:\n|      -----------\n|\n|      k:  A non-negative parameter controlling how influential within-\n|      document- frequency (wdf) and document length are. k=0 means that wdf\n|      and document length don't affect the weights. The larger k is, the\n|      more they do. (default 1)\n|\n|  repr = swigrepr(self)\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteTradWeight(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Weight:\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Weight:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes inherited from Weight:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class UnimplementedError",
                    "content": "|  UnimplementedError(*args)\n|\n|  UnimplementedError indicates an attempt to use an unimplemented\n|  feature.\n|\n|  Method resolution order:\n|      UnimplementedError\n|      LogicError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::UnimplementedError::UnimplementedError(const std::string\n|      &msg, int errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteUnimplementedError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class ValueCountMatchSpy",
                    "content": "|  ValueCountMatchSpy(*args)\n|\n|  Class for counting the frequencies of values in the matching\n|  documents.\n|\n|  Method resolution order:\n|      ValueCountMatchSpy\n|      MatchSpy\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Construct a MatchSpy which counts the values in a particular slot.\n|\n|      Xapian::ValueCountMatchSpy::ValueCountMatchSpy(Xapian::valueno slot)\n|\n|  repr = swigrepr(self)\n|\n|  gettotal = ValueCountMatchSpygettotal(...)\n|      Return the total number of documents tallied.\n|\n|      sizet Xapian::ValueCountMatchSpy::gettotal() const\n|\n|  topvalues(self, maxvalues)\n|      Get an iterator over the most frequent values for the slot.\n|\n|      Values will be returned in descending order of frequency.  Values with\n|      the same frequency will be returned in ascending alphabetical order.\n|\n|      The iterator will return TermListItem objects: the value can be\n|      accessed as the `term` property, and the frequency can be accessed as\n|      the `termfreq` property.\n|\n|  values(self)\n|      Get an iterator over all the values in the slot.\n|\n|      Values will be returned in ascending alphabetical order.\n|\n|      The iterator will return TermListItem objects: the value can be\n|      accessed as the `term` property, and the frequency can be accessed as\n|      the `termfreq` property.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValueCountMatchSpy(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from MatchSpy:\n|\n|  call = MatchSpycall(...)\n|\n|  disown(self)\n|\n|  str = MatchSpystr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::MatchSpy::getdescription() const\n|\n|      This default implementation returns a generic answer, to avoid forcing\n|      those deriving their own MatchSpy subclasses from having to implement\n|      this (they may not care what getdescription() gives for their\n|      subclass).\n|\n|  mergeresults = MatchSpymergeresults(...)\n|      Unserialise some results, and merge them into this matchspy.\n|\n|      virtual void Xapian::MatchSpy::mergeresults(const std::string\n|      &serialised)\n|\n|      The order in which results are merged should not be significant, since\n|      this order is not specified (and will vary depending on the speed of\n|      the search in each sub-database).\n|\n|      If you don't want to support the remote backend in your match spy, you\n|      can use the default implementation which simply throws\n|      Xapian::UnimplementedError.\n|\n|      Parameters:\n|      -----------\n|\n|      serialised:  A string containing the serialised results.\n|\n|  name = MatchSpyname(...)\n|      Return the name of this match spy.\n|\n|      virtual std::string Xapian::MatchSpy::name() const\n|\n|      This name is used by the remote backend. It is passed with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called MyApp::FooMatchSpy, return \"MyApp::FooMatchSpy\" from\n|      this method.\n|\n|      If you don't want to support the remote backend in your match spy, you\n|      can use the default implementation which simply throws\n|      Xapian::UnimplementedError.\n|\n|  release = MatchSpyrelease(...)\n|      Start reference counting this object.\n|\n|      const MatchSpy* Xapian::MatchSpy::release() const\n|\n|      You can hand ownership of a dynamically allocated MatchSpy object to\n|      Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from MatchSpy:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValueItem",
                    "content": "|  ValueItem(num, value)\n|\n|  An item returned from iteration of the values in a document.\n|\n|  The item supports access to the following attributes:\n|\n|   - `num`: The number of the value.\n|   - `value`: The contents of the value.\n|\n|  Methods defined here:\n|\n|  init(self, num, value)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  num\n|\n|  value\n"
                },
                {
                    "name": "class ValueIter",
                    "content": "|  ValueIter(start, end)\n|\n|  An iterator over all the values stored in a document.\n|\n|  The iterator will return ValueItem objects, in ascending order of value number.\n|\n|  Methods defined here:\n|\n|  init(self, start, end)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValueMapPostingSource",
                    "content": "|  ValueMapPostingSource(slot)\n|\n|  A posting source which looks up weights in a map using values as the\n|  key.\n|\n|  This allows will return entries for all documents in the given\n|  database which have a value in the slot specified. The values will be\n|  mapped to the corresponding weight in the weight map. If there is no\n|  mapping for a particular value, the default weight will be returned\n|  (which itself defaults to 0.0).\n|\n|  Method resolution order:\n|      ValueMapPostingSource\n|      ValuePostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, slot)\n|      Construct a ValueMapPostingSource.\n|\n|      Xapian::ValueMapPostingSource::ValueMapPostingSource(Xapian::valueno\n|      slot)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to read values from.\n|\n|  repr = swigrepr(self)\n|\n|  addmapping = ValueMapPostingSourceaddmapping(...)\n|      Add a mapping.\n|\n|      void Xapian::ValueMapPostingSource::addmapping(const std::string\n|      &key, double wt)\n|\n|      Parameters:\n|      -----------\n|\n|      key:  The key looked up from the value slot.\n|\n|      wt:  The weight to give this key.\n|\n|  clearmappings = ValueMapPostingSourceclearmappings(...)\n|      Clear all mappings.\n|\n|      void Xapian::ValueMapPostingSource::clearmappings()\n|\n|  setdefaultweight = ValueMapPostingSourcesetdefaultweight(...)\n|      Set a default weight for document values not in the map.\n|\n|      void Xapian::ValueMapPostingSource::setdefaultweight(double wt)\n|\n|      Parameters:\n|      -----------\n|\n|      wt:  The weight to set as the default.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValueMapPostingSource(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValuePostingSource:\n|\n|  disown(self)\n|\n|  next = ValuePostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      void Xapian::ValuePostingSource::next(double minwt)\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  atend = ValuePostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      bool Xapian::ValuePostingSource::atend() const\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = ValuePostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      bool Xapian::ValuePostingSource::check(Xapian::docid mindocid, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  done = ValuePostingSourcedone(...)\n|      End the iteration.\n|\n|      void Xapian::ValuePostingSource::done()\n|\n|      Calls to atend() will return true after calling this method.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdatabase = ValuePostingSourcegetdatabase(...)\n|      The database we're reading values from.\n|\n|      Xapian::Database Xapian::ValuePostingSource::getdatabase() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdocid = ValuePostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      Xapian::docid Xapian::ValuePostingSource::getdocid() const\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getslot = ValuePostingSourcegetslot(...)\n|      The slot we're reading values from.\n|\n|      Xapian::valueno Xapian::ValuePostingSource::getslot() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getstarted = ValuePostingSourcegetstarted(...)\n|      Flag indicating if we've started (true if we have).\n|\n|      bool Xapian::ValuePostingSource::getstarted() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  gettermfreqest = ValuePostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqest() const\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = ValuePostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmax() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = ValuePostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmin() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getvalue = ValuePostingSourcegetvalue(...)\n|      Read current value.\n|\n|      std::string Xapian::ValuePostingSource::getvalue() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  init = ValuePostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      void Xapian::ValuePostingSource::init(const Database &db)\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  settermfreqest = ValuePostingSourcesettermfreqest(...)\n|      An estimate of the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqest(Xapian::doccount\n|      termfreqest)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmax = ValuePostingSourcesettermfreqmax(...)\n|      An upper bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmax(Xapian::doccount\n|      termfreqmax)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmin = ValuePostingSourcesettermfreqmin(...)\n|      Set a lower bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmin(Xapian::doccount\n|      termfreqmin)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods to return fewer documents.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  skipto = ValuePostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      void Xapian::ValuePostingSource::skipto(Xapian::docid mindocid,\n|      double minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  str = PostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::PostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  getweight = PostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      virtual double Xapian::PostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  name = PostingSourcename(...)\n|      Name of the posting source class.\n|\n|      virtual std::string Xapian::PostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValuePostingSource",
                    "content": "|  ValuePostingSource(slot)\n|\n|  A posting source which generates weights from a value slot.\n|\n|  This is a base class for classes which generate weights using values\n|  stored in the specified slot. For example, ValueWeightPostingSource\n|  uses sortableunserialise to convert values directly to weights.\n|\n|  The upper bound on the weight returned is set to DBLMAX. Subclasses\n|  should call setmaxweight() in their init() methods after calling\n|  ValuePostingSource::init() if they know a tighter bound on the weight.\n|\n|  Method resolution order:\n|      ValuePostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  disown(self)\n|\n|  init(self, slot)\n|      Construct a ValuePostingSource.\n|\n|      Xapian::ValuePostingSource::ValuePostingSource(Xapian::valueno slot)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to read values from.\n|\n|  next = ValuePostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      void Xapian::ValuePostingSource::next(double minwt)\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  repr = swigrepr(self)\n|\n|  atend = ValuePostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      bool Xapian::ValuePostingSource::atend() const\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = ValuePostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      bool Xapian::ValuePostingSource::check(Xapian::docid mindocid, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  done = ValuePostingSourcedone(...)\n|      End the iteration.\n|\n|      void Xapian::ValuePostingSource::done()\n|\n|      Calls to atend() will return true after calling this method.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdatabase = ValuePostingSourcegetdatabase(...)\n|      The database we're reading values from.\n|\n|      Xapian::Database Xapian::ValuePostingSource::getdatabase() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdocid = ValuePostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      Xapian::docid Xapian::ValuePostingSource::getdocid() const\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getslot = ValuePostingSourcegetslot(...)\n|      The slot we're reading values from.\n|\n|      Xapian::valueno Xapian::ValuePostingSource::getslot() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getstarted = ValuePostingSourcegetstarted(...)\n|      Flag indicating if we've started (true if we have).\n|\n|      bool Xapian::ValuePostingSource::getstarted() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  gettermfreqest = ValuePostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqest() const\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = ValuePostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmax() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = ValuePostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmin() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getvalue = ValuePostingSourcegetvalue(...)\n|      Read current value.\n|\n|      std::string Xapian::ValuePostingSource::getvalue() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  init = ValuePostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      void Xapian::ValuePostingSource::init(const Database &db)\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  settermfreqest = ValuePostingSourcesettermfreqest(...)\n|      An estimate of the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqest(Xapian::doccount\n|      termfreqest)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmax = ValuePostingSourcesettermfreqmax(...)\n|      An upper bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmax(Xapian::doccount\n|      termfreqmax)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmin = ValuePostingSourcesettermfreqmin(...)\n|      Set a lower bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmin(Xapian::doccount\n|      termfreqmin)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods to return fewer documents.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  skipto = ValuePostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      void Xapian::ValuePostingSource::skipto(Xapian::docid mindocid,\n|      double minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValuePostingSource(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  str = PostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::PostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  getweight = PostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      virtual double Xapian::PostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  name = PostingSourcename(...)\n|      Name of the posting source class.\n|\n|      virtual std::string Xapian::PostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValueRangeProcessor",
                    "content": "|  Base class for value range processors.\n|\n|  Methods defined here:\n|\n|  call = ValueRangeProcessorcall(...)\n|\n|  disown(self)\n|\n|  init(self)\n|      Default constructor.\n|\n|      Xapian::ValueRangeProcessor::ValueRangeProcessor()\n|\n|  repr = swigrepr(self)\n|\n|  release = ValueRangeProcessorrelease(...)\n|      Start reference counting this object.\n|\n|      const ValueRangeProcessor* Xapian::ValueRangeProcessor::release()\n|      const\n|\n|      You can hand ownership of a dynamically allocated ValueRangeProcessor\n|      object to Xapian by calling release() and then passing the object to a\n|      Xapian method. Xapian will arrange to delete the object once it is no\n|      longer required.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValueRangeProcessor(...)\n|      Destructor.\n|\n|      virtual Xapian::ValueRangeProcessor::~ValueRangeProcessor()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n"
                },
                {
                    "name": "class ValueSetMatchDecider",
                    "content": "|  ValueSetMatchDecider(slot, inclusive)\n|\n|  MatchDecider filtering results based on whether document values are in\n|  a user- defined set.\n|\n|  Method resolution order:\n|      ValueSetMatchDecider\n|      MatchDecider\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, slot, inclusive)\n|      Construct a ValueSetMatchDecider.\n|\n|      Xapian::ValueSetMatchDecider::ValueSetMatchDecider(Xapian::valueno\n|      slot, bool inclusive)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot number to look in.\n|\n|      inclusive:  If true, match decider accepts documents which have a\n|      value in the specified slot which is a member of the test set; if\n|      false, match decider accepts documents which do not have a value in\n|      the specified slot.\n|\n|  repr = swigrepr(self)\n|\n|  addvalue = ValueSetMatchDecideraddvalue(...)\n|      Add a value to the test set.\n|\n|      void Xapian::ValueSetMatchDecider::addvalue(const std::string &value)\n|\n|      Parameters:\n|      -----------\n|\n|      value:  The value to add to the test set.\n|\n|  removevalue = ValueSetMatchDeciderremovevalue(...)\n|      Remove a value from the test set.\n|\n|      void Xapian::ValueSetMatchDecider::removevalue(const std::string\n|      &value)\n|\n|      Parameters:\n|      -----------\n|\n|      value:  The value to remove from the test set.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValueSetMatchDecider(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from MatchDecider:\n|\n|  call = MatchDecidercall(...)\n|\n|  disown(self)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from MatchDecider:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValueStreamItem",
                    "content": "|  ValueStreamItem(docid, value)\n|\n|  An item returned from iteration of the values in a document.\n|\n|  The item supports access to the following attributes:\n|\n|   - `docid`: The docid for the item.\n|   - `value`: The contents of the value.\n|\n|  Methods defined here:\n|\n|  init(self, docid, value)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  docid\n|\n|  value\n"
                },
                {
                    "name": "class ValueStreamIter",
                    "content": "|  ValueStreamIter(start, end)\n|\n|  An iterator over all the values stored in a document.\n|\n|  The iterator will return ValueStreamItem objects, in ascending order of value number.\n|\n|  Methods defined here:\n|\n|  init(self, start, end)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  iter(self)\n|\n|  next(self)\n|\n|  skipto(self, docid)\n|      Skip the iterator forward.\n|\n|      The iterator is advanced to the first document with a document ID\n|      which is greater than or equal to the supplied document ID.\n|\n|      If there are no such items, this will raise StopIteration.\n|\n|      This returns the item which the iterator is moved to.  The subsequent\n|      item will be returned the next time that next() is called (unless\n|      skipto() is called again first).\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class ValueWeightPostingSource",
                    "content": "|  ValueWeightPostingSource(slot)\n|\n|  A posting source which reads weights from a value slot.\n|\n|  This returns entries for all documents in the given database which\n|  have a non empty values in the specified slot. It returns a weight\n|  calculated by applying sortableunserialise to the value stored in the\n|  slot (so the values stored should probably have been calculated by\n|  applying sortableserialise to a floating point number at index time).\n|\n|  The upper bound on the weight returned is set using the upper bound on\n|  the values in the specified slot, or DBLMAX if value bounds aren't\n|  supported by the current backend.\n|\n|  For efficiency, this posting source doesn't check that the stored\n|  values are valid in any way, so it will never raise an exception due\n|  to invalid stored values. In particular, it doesn't ensure that the\n|  unserialised values are positive, which is a requirement for weights.\n|  The behaviour if the slot contains values which unserialise to\n|  negative values is undefined.\n|\n|  Method resolution order:\n|      ValueWeightPostingSource\n|      ValuePostingSource\n|      PostingSource\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  disown(self)\n|\n|  init(self, slot)\n|      Construct a ValueWeightPostingSource.\n|\n|      Xapian::ValueWeightPostingSource::ValueWeightPostingSource(Xapian::valueno\n|      slot)\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to read values from.\n|\n|  repr = swigrepr(self)\n|\n|  str = ValueWeightPostingSourcestr(...)\n|      Return a string describing this object.\n|\n|      std::string Xapian::ValueWeightPostingSource::getdescription() const\n|\n|      This default implementation returns a generic answer. This default it\n|      provided to avoid forcing those deriving their own PostingSource\n|      subclass from having to implement this (they may not care what\n|      getdescription() gives for their subclass).\n|\n|  getweight = ValueWeightPostingSourcegetweight(...)\n|      Return the weight contribution for the current document.\n|\n|      double Xapian::ValueWeightPostingSource::getweight() const\n|\n|      This default implementation always returns 0, for convenience when\n|      implementing \"weight-less\" PostingSource subclasses.\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". In detail: Xapian will always call init() on a\n|      PostingSource before calling this for the first time. It will also\n|      only call this if the PostingSource reports that it is pointing to a\n|      valid document (ie, it will not call it before calling at least one of\n|      next(), skipto() or check(), and will ensure that the PostingSource\n|      is not at the end by calling atend()).\n|\n|  init = ValueWeightPostingSourceinit(...)\n|      Set this PostingSource to the start of the list of postings.\n|\n|      void Xapian::ValueWeightPostingSource::init(const Database &db)\n|\n|      This is called automatically by the matcher prior to each query being\n|      processed.\n|\n|      If a PostingSource is used for multiple searches,  init() will\n|      therefore be called multiple times, and must handle this by using the\n|      database passed in the most recent call.\n|\n|      Parameters:\n|      -----------\n|\n|      db:  The database which the PostingSource should iterate through.\n|\n|      Note: in the case of a multi-database search, a separate PostingSource\n|      will be used for each database (the separate PostingSources will be\n|      obtained using  clone()), and each PostingSource will be passed one of\n|      the sub-databases as the db parameter here. The db parameter will\n|      therefore always refer to a single database. All docids passed to, or\n|      returned from, the PostingSource refer to docids in that single\n|      database, rather than in the multi- database.\n|\n|  name = ValueWeightPostingSourcename(...)\n|      Name of the posting source class.\n|\n|      std::string Xapian::ValueWeightPostingSource::name() const\n|\n|      This is used when serialising and unserialising posting sources; for\n|      example, for performing remote searches.\n|\n|      If the subclass is in a C++ namespace, the namespace should be\n|      included in the name, using \"::\" as a separator. For example, for a\n|      PostingSource subclass called \"FooPostingSource\" in the \"Xapian\"\n|      namespace the result of this call should be\n|      \"Xapian::FooPostingSource\".\n|\n|      This should only be implemented if serialise() and unserialise() are\n|      also implemented. The default implementation returns an empty string.\n|\n|      If this returns an empty string, Xapian will assume that serialise()\n|      and unserialise() are not implemented.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteValueWeightPostingSource(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from ValuePostingSource:\n|\n|  next = ValuePostingSourcenext(...)\n|      Advance the current position to the next matching document.\n|\n|      void Xapian::ValuePostingSource::next(double minwt)\n|\n|      The PostingSource starts before the first entry in the list, so\n|      next(), skipto() or check() must be called before any methods which\n|      need the context of the current position.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Parameters:\n|      -----------\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  atend = ValuePostingSourceatend(...)\n|      Return true if the current position is past the last entry in this\n|      list.\n|\n|      bool Xapian::ValuePostingSource::atend() const\n|\n|      At least one of  next(),  skipto() or  check() will be called before\n|      this method is first called.\n|\n|  check = ValuePostingSourcecheck(...)\n|      Check if the specified docid occurs.\n|\n|      bool Xapian::ValuePostingSource::check(Xapian::docid mindocid, double\n|      minwt)\n|\n|      The caller is required to ensure that the specified document id did\n|      actually exists in the database. If it does, it must move to that\n|      document id, and return true. If it does not, it may either:\n|\n|      return true, having moved to a definite position (including\n|      \"atend\"), which must be the same position as skipto() would have\n|      moved to.\n|\n|      or\n|\n|      return false, having moved to an \"indeterminate\" position, such that\n|      a subsequent call to next() or skipto() will move to the next\n|      matching position after did.\n|\n|      Generally, this method should act like skipto() and return true if\n|      that can be done at little extra cost.\n|\n|      Otherwise it should simply check if a particular docid is present,\n|      returning true if it is, and false if it isn't.\n|\n|      The default implementation calls skipto() and always returns true.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to check.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  done = ValuePostingSourcedone(...)\n|      End the iteration.\n|\n|      void Xapian::ValuePostingSource::done()\n|\n|      Calls to atend() will return true after calling this method.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdatabase = ValuePostingSourcegetdatabase(...)\n|      The database we're reading values from.\n|\n|      Xapian::Database Xapian::ValuePostingSource::getdatabase() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getdocid = ValuePostingSourcegetdocid(...)\n|      Return the current docid.\n|\n|      Xapian::docid Xapian::ValuePostingSource::getdocid() const\n|\n|      This method may assume that it will only be called when there is a\n|      \"current document\". See  getweight() for details.\n|\n|      Note: in the case of a multi-database search, the returned docid\n|      should be in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|  getslot = ValuePostingSourcegetslot(...)\n|      The slot we're reading values from.\n|\n|      Xapian::valueno Xapian::ValuePostingSource::getslot() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  getstarted = ValuePostingSourcegetstarted(...)\n|      Flag indicating if we've started (true if we have).\n|\n|      bool Xapian::ValuePostingSource::getstarted() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  gettermfreqest = ValuePostingSourcegettermfreqest(...)\n|      An estimate of the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqest() const\n|\n|      It must always be true that:\n|\n|      gettermfreqmin() <= gettermfreqest() <= gettermfreqmax()\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmax = ValuePostingSourcegettermfreqmax(...)\n|      An upper bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmax() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  gettermfreqmin = ValuePostingSourcegettermfreqmin(...)\n|      A lower bound on the number of documents this object can return.\n|\n|      Xapian::doccount Xapian::ValuePostingSource::gettermfreqmin() const\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|  getvalue = ValuePostingSourcegetvalue(...)\n|      Read current value.\n|\n|      std::string Xapian::ValuePostingSource::getvalue() const\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqest = ValuePostingSourcesettermfreqest(...)\n|      An estimate of the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqest(Xapian::doccount\n|      termfreqest)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmax = ValuePostingSourcesettermfreqmax(...)\n|      An upper bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmax(Xapian::doccount\n|      termfreqmax)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  settermfreqmin = ValuePostingSourcesettermfreqmin(...)\n|      Set a lower bound on the term frequency.\n|\n|      void Xapian::ValuePostingSource::settermfreqmin(Xapian::doccount\n|      termfreqmin)\n|\n|      Subclasses should set this if they are overriding the next(),\n|      skipto() or check() methods to return fewer documents.\n|\n|      Added in 1.2.23 and 1.3.5.\n|\n|  skipto = ValuePostingSourceskipto(...)\n|      Advance to the specified docid.\n|\n|      void Xapian::ValuePostingSource::skipto(Xapian::docid mindocid,\n|      double minwt)\n|\n|      If the specified docid isn't in the list, position ourselves on the\n|      first document after it (or atend() if no greater docids are\n|      present).\n|\n|      If the current position is already the specified docid, this method\n|      will leave the position unmodified.\n|\n|      If the specified docid is earlier than the current position, the\n|      behaviour is unspecified. A sensible behaviour would be to leave the\n|      current position unmodified, but it is also reasonable to move to the\n|      specified docid.\n|\n|      The default implementation calls next() repeatedly, which works but\n|      skipto() can often be implemented much more efficiently.\n|\n|      Xapian will always call init() on a PostingSource before calling this\n|      for the first time.\n|\n|      Note: in the case of a multi-database search, the docid specified is\n|      the docid in the single subdatabase relevant to this posting source.\n|      See the  init() method for details.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id to advance to.\n|\n|      minwt:  The minimum weight contribution that is needed (this is just\n|      a hint which subclasses may ignore).\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from PostingSource:\n|\n|  getmaxweight = PostingSourcegetmaxweight(...)\n|      Return the currently set upper bound on what getweight() can return.\n|\n|      double Xapian::PostingSource::getmaxweight() const\n|\n|  release = PostingSourcerelease(...)\n|      Start reference counting this object.\n|\n|      const PostingSource* Xapian::PostingSource::release() const\n|\n|      You can hand ownership of a dynamically allocated PostingSource object\n|      to Xapian by calling release() and then passing the object to a Xapian\n|      method. Xapian will arrange to delete the object once it is no longer\n|      required.\n|\n|  setmaxweight = PostingSourcesetmaxweight(...)\n|      Specify an upper bound on what getweight() will return from now on.\n|\n|      void Xapian::PostingSource::setmaxweight(double maxweight)\n|\n|      This upper bound is used by the matcher to perform various\n|      optimisations, so if you can return a good bound, then matches will\n|      generally run faster.\n|\n|      This method should be called after calling init(), and may be called\n|      during iteration if the upper bound drops. It is probably only useful\n|      to call from subclasses (it was actually a \"protected\" method prior\n|      to Xapian 1.3.4, but that makes it tricky to wrap for other\n|      languages).\n|\n|      It is valid for the posting source to have returned a higher value\n|      from getweight() earlier in the iteration, but the posting source\n|      must not return a higher value from getweight() than the currently\n|      set upper bound, and the upper bound must not be increased (until\n|      init() has been called).\n|\n|      If you don't call this method, the upper bound will default to 0, for\n|      convenience when implementing \"weight-less\" PostingSource\n|      subclasses.\n|\n|      Parameters:\n|      -----------\n|\n|      maxweight:  The upper bound to set.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from PostingSource:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                },
                {
                    "name": "class Weight",
                    "content": "|  Weight(*args, kwargs)\n|\n|  Abstract base class for weighting schemes.\n|\n|  Methods defined here:\n|\n|  init(self, *args, kwargs)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  repr = swigrepr(self)\n|\n|  getmaxextra = Weightgetmaxextra(...)\n|      Return an upper bound on what getsumextra() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxextra() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getmaxpart = Weightgetmaxpart(...)\n|      Return an upper bound on what getsumpart() can return for any\n|      document.\n|\n|      virtual double Xapian::Weight::getmaxpart() const =0\n|\n|      This information is used by the matcher to perform various\n|      optimisations, so strive to make the bound as tight as possible.\n|\n|  getsumextra = Weightgetsumextra(...)\n|      Calculate the term-independent weight component for a document.\n|\n|      virtual double Xapian::Weight::getsumextra(Xapian::termcount doclen,\n|      Xapian::termcount uniqterms) const =0\n|\n|      The parameter gives information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  The number of unique terms in the document.\n|\n|  getsumpart = Weightgetsumpart(...)\n|      Calculate the weight contribution for this object's term to a\n|      document.\n|\n|      virtual double Xapian::Weight::getsumpart(Xapian::termcount wdf,\n|      Xapian::termcount doclen, Xapian::termcount uniqterms) const =0\n|\n|      The parameters give information about the document which may be used\n|      in the calculations:\n|\n|      Parameters:\n|      -----------\n|\n|      wdf:  The within document frequency of the term in the document.\n|\n|      doclen:  The document's length (unnormalised).\n|\n|      uniqterms:  Number of unique terms in the document (used for absolute\n|      smoothing).\n|\n|  name = Weightname(...)\n|      Return the name of this weighting scheme.\n|\n|      virtual std::string Xapian::Weight::name() const\n|\n|      This name is used by the remote backend. It is passed along with the\n|      serialised parameters to the remote server so that it knows which\n|      class to create.\n|\n|      Return the full namespace-qualified name of your class here - if your\n|      class is called FooWeight, return \"FooWeight\" from this method (\n|      Xapian::BM25Weight returns \"Xapian::BM25Weight\" here).\n|\n|      If you don't want to support the remote backend, you can use the\n|      default implementation which simply returns an empty string.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteWeight(...)\n|      Virtual destructor, because we have virtual methods.\n|\n|      virtual Xapian::Weight::~Weight()\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  ABSOLUTEDISCOUNTSMOOTHING = 3\n|\n|  DIRICHLETPLUSSMOOTHING = 5\n|\n|  DIRICHLETSMOOTHING = 2\n|\n|  JELINEKMERCERSMOOTHING = 4\n|\n|  TWOSTAGESMOOTHING = 1\n"
                },
                {
                    "name": "class WildcardError",
                    "content": "|  WildcardError(*args)\n|\n|  WildcardError indicates an error expanding a wildcarded query.\n|\n|  Method resolution order:\n|      WildcardError\n|      RuntimeError\n|      Error\n|      builtins.Exception\n|      builtins.BaseException\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  getattr lambda self, name\n|\n|  init(self, *args)\n|      Construct from message and errno value.\n|\n|      Xapian::WildcardError::WildcardError(const std::string &msg, int\n|      errno)\n|\n|      Parameters:\n|      -----------\n|\n|      msg:  Message giving details of the error, intended for human\n|      consumption.\n|\n|      errno:  Optional errno value associated with this error.\n|\n|  repr = swigrepr(self)\n|\n|  setattr lambda self, name, value\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteWildcardError(...)\n|\n|  ----------------------------------------------------------------------\n|  Data and other attributes defined here:\n|\n|  swiggetmethods = {}\n|\n|  swigsetmethods = {}\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Error:\n|\n|  str = Errorstr(...)\n|\n|  getcontext = Errorgetcontext(...)\n|      Optional context information.\n|\n|      const std::string& Xapian::Error::getcontext() const\n|\n|      This context is intended for use by Xapian::ErrorHandler (for example\n|      so it can know which remote server is unreliable and report the\n|      problem and remove that server from those being searched). But it's\n|      typically a plain-text string, and so also fit for human consumption.\n|\n|  geterrorstring = Errorgeterrorstring(...)\n|      Returns any system error string associated with this exception.\n|\n|      const char* Xapian::Error::geterrorstring() const\n|\n|      The system error string may come from errno, herrno (on UNIX), or\n|      GetLastError() (on MS Windows). If there is no associated system error\n|      string, NULL is returned.\n|\n|  getmsg = Errorgetmsg(...)\n|      Message giving details of the error, intended for human consumption.\n|\n|      const std::string& Xapian::Error::getmsg() const\n|\n|  gettype = Errorgettype(...)\n|      The type of this error (e.g. \"DocNotFoundError\".)\n|\n|      const char* Xapian::Error::gettype() const\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Error:\n|\n|  weakref\n|      list of weak references to the object (if defined)\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from builtins.Exception:\n|\n|  new(*args, kwargs) from builtins.type\n|      Create and return a new object.  See help(type) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from builtins.BaseException:\n|\n|  delattr(self, name, /)\n|      Implement delattr(self, name).\n|\n|  getattribute(self, name, /)\n|      Return getattr(self, name).\n|\n|  reduce(...)\n|      Helper for pickle.\n|\n|  setstate(...)\n|\n|  withtraceback(...)\n|      Exception.withtraceback(tb) --\n|      set self.traceback to tb and return self.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from builtins.BaseException:\n|\n|  cause\n|      exception cause\n|\n|  context\n|      exception context\n|\n|  dict\n|\n|  suppresscontext\n|\n|  traceback\n|\n|  args\n"
                },
                {
                    "name": "class WritableDatabase",
                    "content": "|  WritableDatabase(*args)\n|\n|  This class provides read/write access to a database.\n|\n|  Method resolution order:\n|      WritableDatabase\n|      Database\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, *args)\n|      Copying is allowed.\n|\n|      Xapian::WritableDatabase::WritableDatabase(const WritableDatabase\n|      &other)\n|\n|      The internals are reference counted, so copying is cheap.\n|\n|      Parameters:\n|      -----------\n|\n|      other:  The object to copy.\n|\n|  repr = swigrepr(self)\n|\n|  adddocument = WritableDatabaseadddocument(...)\n|      Add a new document to the database.\n|\n|      Xapian::docid Xapian::WritableDatabase::adddocument(const\n|      Xapian::Document &document)\n|\n|      This method adds the specified document to the database, returning a\n|      newly allocated document ID. Automatically allocated document IDs come\n|      from a per-database monotonically increasing counter, so IDs from\n|      deleted documents won't be reused.\n|\n|      If you want to specify the document ID to be used, you should call\n|      replacedocument() instead.\n|\n|      Note that changes to the database won't be immediately committed to\n|      disk; see commit() for more details.\n|\n|      As with all database modification operations, the effect is atomic:\n|      the document will either be fully added, or the document fails to be\n|      added and an exception is thrown (possibly at a later time when\n|      commit() is called or the database is closed).\n|\n|      Parameters:\n|      -----------\n|\n|      document:  The new document to be added.\n|\n|      The document ID of the newly added document.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      writing to the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|  addspelling = WritableDatabaseaddspelling(...)\n|      Add a word to the spelling dictionary.\n|\n|      void Xapian::WritableDatabase::addspelling(const std::string &word,\n|      Xapian::termcount freqinc=1) const\n|\n|      If the word is already present, its frequency is increased.\n|\n|      Parameters:\n|      -----------\n|\n|      word:  The word to add.\n|\n|      freqinc:  How much to increase its frequency by (default 1).\n|\n|  addsynonym = WritableDatabaseaddsynonym(...)\n|      Add a synonym for a term.\n|\n|      void Xapian::WritableDatabase::addsynonym(const std::string &term,\n|      const std::string &synonym) const\n|\n|      Parameters:\n|      -----------\n|\n|      term:  The term to add a synonym for.\n|\n|      synonym:  The synonym to add. If this is already a synonym for term,\n|      then no action is taken.\n|\n|  begintransaction = WritableDatabasebegintransaction(...)\n|      Begin a transaction.\n|\n|      void Xapian::WritableDatabase::begintransaction(bool flushed=true)\n|\n|      In Xapian a transaction is a group of modifications to the database\n|      which are linked such that either all will be applied simultaneously\n|      or none will be applied at all. Even in the case of a power failure,\n|      this characteristic should be preserved (as long as the filesystem\n|      isn't corrupted, etc).\n|\n|      A transaction is started with begintransaction() and can either be\n|      committed by calling committransaction() or aborted by calling\n|      canceltransaction().\n|\n|      By default, a transaction implicitly calls commit() before and after\n|      so that the modifications stand and fall without affecting\n|      modifications before or after.\n|\n|      The downside of these implicit calls to commit() is that small\n|      transactions can harm indexing performance in the same way that\n|      explicitly calling commit() frequently can.\n|\n|      If you're applying atomic groups of changes and only wish to ensure\n|      that each group is either applied or not applied, then you can prevent\n|      the automatic commit() before and after the transaction by starting\n|      the transaction with begintransaction(false). However, if\n|      canceltransaction is called (or if committransaction isn't called\n|      before the WritableDatabase object is destroyed) then any changes\n|      which were pending before the transaction began will also be\n|      discarded.\n|\n|      Transactions aren't currently supported by the InMemory backend.\n|\n|      Parameters:\n|      -----------\n|\n|      flushed:  Is this a flushed transaction? By default transactions are\n|      \"flushed\", which means that committing a transaction will ensure\n|      those changes are permanently written to the database. By contrast,\n|      unflushed transactions only ensure that changes within the transaction\n|      are either all applied or all aren't.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::UnimplementedError:  will be thrown if transactions are not\n|      available for this database type.\n|\n|      Xapian::InvalidOperationError:  will be thrown if this is called at an\n|      invalid time, such as when a transaction is already in progress.\n|\n|  canceltransaction = WritableDatabasecanceltransaction(...)\n|      Abort the transaction currently in progress, discarding the pending\n|      modifications made to the database.\n|\n|      void Xapian::WritableDatabase::canceltransaction()\n|\n|      If an error occurs in this method, an exception will be thrown, but\n|      the transaction will be cancelled anyway.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      modifying the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|      Xapian::InvalidOperationError:  will be thrown if a transaction is not\n|      currently in progress.\n|\n|      Xapian::UnimplementedError:  will be thrown if transactions are not\n|      available for this database type.\n|\n|  clearsynonyms = WritableDatabaseclearsynonyms(...)\n|      Remove all synonyms for a term.\n|\n|      void Xapian::WritableDatabase::clearsynonyms(const std::string &term)\n|      const\n|\n|      Parameters:\n|      -----------\n|\n|      term:  The term to remove all synonyms for. If the term has no\n|      synonyms, no action is taken.\n|\n|  commit = WritableDatabasecommit(...)\n|      Commit any pending modifications made to the database.\n|\n|      void Xapian::WritableDatabase::commit()\n|\n|      For efficiency reasons, when performing multiple updates to a database\n|      it is best (indeed, almost essential) to make as many modifications as\n|      memory will permit in a single pass through the database. To ensure\n|      this, Xapian batches up modifications.\n|\n|      This method may be called at any time to commit any pending\n|      modifications to the database.\n|\n|      If any of the modifications fail, an exception will be thrown and the\n|      database will be left in a state in which each separate addition,\n|      replacement or deletion operation has either been fully performed or\n|      not performed at all: it is then up to the application to work out\n|      which operations need to be repeated.\n|\n|      It's not valid to call commit() within a transaction.\n|\n|      Beware of calling commit() too frequently: this will make indexing\n|      take much longer.\n|\n|      Note that commit() need not be called explicitly: it will be called\n|      automatically when the database is closed, or when a sufficient number\n|      of modifications have been made. By default, this is every 10000\n|      documents added, deleted, or modified. This value is rather\n|      conservative, and if you have a machine with plenty of memory, you can\n|      improve indexing throughput dramatically by setting\n|      XAPIANFLUSHTHRESHOLD in the environment to a larger value.\n|\n|      This method was new in Xapian 1.1.0 - in earlier versions it was\n|      called flush().\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      modifying the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|  committransaction = WritableDatabasecommittransaction(...)\n|      Complete the transaction currently in progress.\n|\n|      void Xapian::WritableDatabase::committransaction()\n|\n|      If this method completes successfully and this is a flushed\n|      transaction, all the database modifications made during the\n|      transaction will have been committed to the database.\n|\n|      If an error occurs, an exception will be thrown, and none of the\n|      modifications made to the database during the transaction will have\n|      been applied to the database.\n|\n|      In all cases the transaction will no longer be in progress.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      modifying the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|      Xapian::InvalidOperationError:  will be thrown if a transaction is not\n|      currently in progress.\n|\n|      Xapian::UnimplementedError:  will be thrown if transactions are not\n|      available for this database type.\n|\n|  deletedocument = WritableDatabasedeletedocument(...)\n|      Delete any documents indexed by a term from the database.\n|\n|      void Xapian::WritableDatabase::deletedocument(const std::string\n|      &uniqueterm)\n|\n|      This method removes any documents indexed by the specified term from\n|      the database.\n|\n|      A major use is for convenience when UIDs from another system are\n|      mapped to terms in Xapian, although this method has other uses (for\n|      example, you could add a \"deletion date\" term to documents at index\n|      time and use this method to delete all documents due for deletion on a\n|      particular date).\n|\n|      Parameters:\n|      -----------\n|\n|      uniqueterm:  The term to remove references to.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      writing to the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|  flush = WritableDatabaseflush(...)\n|      Pre-1.1.0 name for commit().\n|\n|      void Xapian::WritableDatabase::flush()\n|\n|      Use commit() instead.\n|\n|  removespelling = WritableDatabaseremovespelling(...)\n|      Remove a word from the spelling dictionary.\n|\n|      void Xapian::WritableDatabase::removespelling(const std::string\n|      &word, Xapian::termcount freqdec=1) const\n|\n|      The word's frequency is decreased, and if would become zero or less\n|      then the word is removed completely.\n|\n|      Parameters:\n|      -----------\n|\n|      word:  The word to remove.\n|\n|      freqdec:  How much to decrease its frequency by (default 1).\n|\n|  removesynonym = WritableDatabaseremovesynonym(...)\n|      Remove a synonym for a term.\n|\n|      void Xapian::WritableDatabase::removesynonym(const std::string &term,\n|      const std::string &synonym) const\n|\n|      Parameters:\n|      -----------\n|\n|      term:  The term to remove a synonym for.\n|\n|      synonym:  The synonym to remove. If this isn't currently a synonym for\n|      term, then no action is taken.\n|\n|  replacedocument = WritableDatabasereplacedocument(...)\n|      Replace any documents matching a term.\n|\n|      Xapian::docid Xapian::WritableDatabase::replacedocument(const\n|      std::string &uniqueterm, const Xapian::Document &document)\n|\n|      This method replaces any documents indexed by the specified term with\n|      the specified document. If any documents are indexed by the term, the\n|      lowest document ID will be used for the document, otherwise a new\n|      document ID will be generated as for adddocument.\n|\n|      One common use is to allow UIDs from another system to easily be\n|      mapped to terms in Xapian. Note that this method doesn't automatically\n|      add uniqueterm as a term, so you'll need to call\n|      document.addterm(uniqueterm) first when using replacedocument() in\n|      this way.\n|\n|      Note that changes to the database won't be immediately committed to\n|      disk; see commit() for more details.\n|\n|      As with all database modification operations, the effect is atomic:\n|      the document(s) will either be fully replaced, or the document(s) fail\n|      to be replaced and an exception is thrown (possibly at a later time\n|      when commit() is called or the database is closed).\n|\n|      Parameters:\n|      -----------\n|\n|      uniqueterm:  The \"unique\" term.\n|\n|      document:  The new document.\n|\n|      The document ID that document was given.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      writing to the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|  setmetadata = WritableDatabasesetmetadata(...)\n|      Set the user-specified metadata associated with a given key.\n|\n|      void Xapian::WritableDatabase::setmetadata(const std::string &key,\n|      const std::string &metadata)\n|\n|      This method sets the metadata value associated with a given key. If\n|      there is already a metadata value stored in the database with the same\n|      key, the old value is replaced. If you want to delete an existing item\n|      of metadata, just set its value to the empty string.\n|\n|      User-specified metadata allows you to store arbitrary information in\n|      the form of (key, value) pairs.\n|\n|      There's no hard limit on the number of metadata items, or the size of\n|      the metadata values. Metadata keys have a limited length, which depend\n|      on the backend. We recommend limiting them to 200 bytes. Empty keys\n|      are not valid, and specifying one will cause an exception.\n|\n|      Metadata modifications are committed to disk in the same way as\n|      modifications to the documents in the database are: i.e.,\n|      modifications are atomic, and won't be committed to disk immediately\n|      (see commit() for more details). This allows metadata to be used to\n|      link databases with versioned external resources by storing the\n|      appropriate version number in a metadata item.\n|\n|      You can also use the metadata to store arbitrary extra information\n|      associated with terms, documents, or postings by encoding the termname\n|      and/or document id into the metadata key.\n|\n|      Parameters:\n|      -----------\n|\n|      key:  The key of the metadata item to set.\n|\n|      metadata:  The value of the metadata item to set.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DatabaseError:  will be thrown if a problem occurs while\n|      writing to the database.\n|\n|      Xapian::DatabaseCorruptError:  will be thrown if the database is in a\n|      corrupt state.\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the key supplied is\n|      empty.\n|\n|      Xapian::UnimplementedError:  will be thrown if the database backend in\n|      use doesn't support user- specified metadata.\n|\n|  ----------------------------------------------------------------------\n|  Static methods defined here:\n|\n|  swigdestroy = deleteWritableDatabase(...)\n|      Destroy this handle on the database.\n|\n|      virtual Xapian::WritableDatabase::~WritableDatabase()\n|\n|      If no other handles to this database remain, the database will be\n|      closed.\n|\n|      If a transaction is active canceltransaction() will be implicitly\n|      called; if no transaction is active commit() will be implicitly\n|      called, but any exception will be swallowed (because throwing\n|      exceptions in C++ destructors is problematic). If you aren't using\n|      transactions and want to know about any failure to commit changes,\n|      call commit() explicitly before the destructor gets called.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors defined here:\n|\n|  thisown\n|      The membership flag\n|\n|  ----------------------------------------------------------------------\n|  Methods inherited from Database:\n|\n|  iter = databasegenalltermsiter(self, prefix=None)\n|      Get an iterator over all the terms in the database.\n|\n|      The iterator will return TermListItem objects, but these will not support\n|      access to wdf, or position information.\n|\n|      Access to term frequency information is only available until the iterator\n|      has moved on.\n|\n|      If prefix is supplied, only terms which start with that prefix will be\n|      returned.\n|\n|  str = Databasestr(...)\n|      Return a string describing this object.\n|\n|      virtual std::string Xapian::Database::getdescription() const\n|\n|  adddatabase = Databaseadddatabase(...)\n|      Add an existing database (or group of databases) to those accessed by\n|      this object.\n|\n|      void Xapian::Database::adddatabase(const Database &database)\n|\n|      Parameters:\n|      -----------\n|\n|      database:  the database(s) to add.\n|\n|  allterms = databasegenalltermsiter(self, prefix=None)\n|      Get an iterator over all the terms in the database.\n|\n|      The iterator will return TermListItem objects, but these will not support\n|      access to wdf, or position information.\n|\n|      Access to term frequency information is only available until the iterator\n|      has moved on.\n|\n|      If prefix is supplied, only terms which start with that prefix will be\n|      returned.\n|\n|  close = Databaseclose(...)\n|      Close the database.\n|\n|      virtual void Xapian::Database::close()\n|\n|      This closes the database and closes all its file handles.\n|\n|      For a WritableDatabase, if a transaction is active it will be aborted,\n|      while if no transaction is active commit() will be implicitly called.\n|      Also the write lock is released.\n|\n|      Closing a database cannot be undone - in particular, calling reopen()\n|      after close() will not reopen it, but will instead throw a\n|      Xapian::DatabaseError exception.\n|\n|      Calling close() again on a database which has already been closed has\n|      no effect (and doesn't raise an exception).\n|\n|      After close() has been called, calls to other methods of the database,\n|      and to methods of other objects associated with the database, will\n|      either:\n|\n|      behave exactly as they would have done if the database had not been\n|      closed (this can only happen if all the required data is cached)\n|\n|      raise a Xapian::DatabaseError exception indicating that the database\n|      is closed.\n|\n|      The reason for this behaviour is that otherwise we'd have to check\n|      that the database is still open on every method call on every object\n|      associated with a Database, when in many cases they are working on\n|      data which has already been loaded and so they are able to just behave\n|      correctly.\n|\n|      This method was added in Xapian 1.1.0.\n|\n|  compact = Databasecompact(...)\n|      Produce a compact version of this database.\n|\n|      void Xapian::Database::compact(int fd, unsigned flags, int blocksize,\n|      Xapian::Compactor &compactor)\n|\n|      New 1.3.4. Various methods of the Compactor class were deprecated in\n|      1.3.4.\n|\n|      The compactor functor allows handling progress output and specifying\n|      how user metadata is merged.\n|\n|      This variant writes a single-file database to the specified file\n|      descriptor. Only the glass backend supports such databases, so this\n|      form is only supported for this backend.\n|\n|      Parameters:\n|      -----------\n|\n|      fd:  File descriptor to write the compact version to. The descriptor\n|      needs to be readable and writable (open with ORDWR) and seekable. The\n|      current file offset is used, allowing compacting to a single file\n|      database embedded within another file. Xapian takes ownership of the\n|      file descriptor and will close it before returning.\n|\n|      flags:  Any of the following combined using bitwise-or (| in C++):\n|      Xapian::DBCOMPACTNORENUMBER By default the document ids will be\n|      renumbered the output - currently by applying the same offset to all\n|      the document ids in a particular source database. If this flag is\n|      specified, then this renumbering doesn't happen, but all the document\n|      ids must be unique over all source databases. Currently the ranges of\n|      document ids in each source must not overlap either, though this\n|      restriction may be removed in the future.\n|\n|      Xapian::DBCOMPACTMULTIPASS If merging more than 3 databases, merge\n|      the postlists in multiple passes, which is generally faster but\n|      requires more disk space for temporary files.\n|\n|      Xapian::DBCOMPACTSINGLEFILE Produce a single-file database (only\n|      supported for glass currently) - this flag is implied in this form and\n|      need not be specified explicitly.\n|\n|      blocksize:  This specifies the block size (in bytes) for to use for\n|      the output. For glass, the block size must be a power of 2 between\n|      2048 and 65536 (inclusive), and the default (also used if an invalid\n|      value is passed) is 8192 bytes.\n|\n|      compactor:  Functor\n|\n|  getaveragelength = Databasegetaveragelength(...)\n|      New name for getavlength().\n|\n|      double Xapian::Database::getaveragelength() const\n|\n|      Added for forward compatibility with the next release series.\n|\n|      1.4.17.\n|\n|  getavlength = Databasegetavlength(...)\n|      Get the average length of the documents in the database.\n|\n|      Xapian::doclength Xapian::Database::getavlength() const\n|\n|  getcollectionfreq = Databasegetcollectionfreq(...)\n|      Return the total number of occurrences of the given term.\n|\n|      Xapian::termcount Xapian::Database::getcollectionfreq(const\n|      std::string &tname) const\n|\n|      This is the sum of the number of occurrences of the term in each\n|      document it indexes: i.e., the sum of the within document frequencies\n|      of the term.\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The term whose collection frequency is being requested.\n|\n|  getdoccount = Databasegetdoccount(...)\n|      Get the number of documents in the database.\n|\n|      Xapian::doccount Xapian::Database::getdoccount() const\n|\n|  getdoclength = Databasegetdoclength(...)\n|      Get the length of a document.\n|\n|      Xapian::termcount Xapian::Database::getdoclength(Xapian::docid did)\n|      const\n|\n|  getdoclengthlowerbound = Databasegetdoclengthlowerbound(...)\n|      Get a lower bound on the length of a document in this DB.\n|\n|      Xapian::termcount Xapian::Database::getdoclengthlowerbound() const\n|\n|      This bound does not include any zero-length documents.\n|\n|  getdoclengthupperbound = Databasegetdoclengthupperbound(...)\n|      Get an upper bound on the length of a document in this DB.\n|\n|      Xapian::termcount Xapian::Database::getdoclengthupperbound() const\n|\n|  getdocument = Databasegetdocument(...)\n|      Get a document from the database, given its document id.\n|\n|      Xapian::Document Xapian::Database::getdocument(Xapian::docid did,\n|      unsigned flags) const\n|\n|      This method returns a Xapian::Document object which provides the\n|      information about a document.\n|\n|      Parameters:\n|      -----------\n|\n|      did:  The document id of the document to retrieve.\n|\n|      flags:  Zero or more flags bitwise-or-ed together (currently only\n|      Xapian::DOCASSUMEVALID is supported).\n|\n|      A Xapian::Document object containing the document data\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::DocNotFoundError:  The document specified could not be found\n|      in the database.\n|\n|      Xapian::InvalidArgumentError:  did was 0, which is not a valid\n|      document id.\n|\n|  getlastdocid = Databasegetlastdocid(...)\n|      Get the highest document id which has been used in the database.\n|\n|      Xapian::docid Xapian::Database::getlastdocid() const\n|\n|  getmetadata = Databasegetmetadata(...)\n|      Get the user-specified metadata associated with a given key.\n|\n|      std::string Xapian::Database::getmetadata(const std::string &key)\n|      const\n|\n|      User-specified metadata allows you to store arbitrary information in\n|      the form of (key, value) pairs. See  WritableDatabase::setmetadata()\n|      for more information.\n|\n|      When invoked on a Xapian::Database object representing multiple\n|      databases, currently only the metadata for the first is considered but\n|      this behaviour may change in the future.\n|\n|      If there is no piece of metadata associated with the specified key, an\n|      empty string is returned (this applies even for backends which don't\n|      support metadata).\n|\n|      Empty keys are not valid, and specifying one will cause an exception.\n|\n|      Parameters:\n|      -----------\n|\n|      key:  The key of the metadata item to access.\n|\n|      The retrieved metadata item's value.\n|\n|      Parameters:\n|      -----------\n|\n|      Xapian::InvalidArgumentError:  will be thrown if the key supplied is\n|      empty.\n|\n|  getrevision = Databasegetrevision(...)\n|      Get the revision of the database.\n|\n|      Xapian::rev Xapian::Database::getrevision() const\n|\n|      The revision is an unsigned integer which increases with each commit.\n|\n|      The database must have exactly one sub-database, which must be of type\n|      chert or glass. Otherwise an exception will be thrown.\n|\n|      Experimental - seehttps://xapian.org/docs/deprecation#experimental-\n|      features\n|\n|  getspellingsuggestion = Databasegetspellingsuggestion(...)\n|      Suggest a spelling correction.\n|\n|      std::string Xapian::Database::getspellingsuggestion(const\n|      std::string &word, unsigned maxeditdistance=2) const\n|\n|      Parameters:\n|      -----------\n|\n|      word:  The potentially misspelled word.\n|\n|      maxeditdistance:  Only consider words which are at most\n|      maxeditdistance edits from word. An edit is a character insertion,\n|      deletion, or the transposition of two adjacent characters (default is\n|      2).\n|\n|  gettermfreq = Databasegettermfreq(...)\n|      Get the number of documents in the database indexed by a given term.\n|\n|      Xapian::doccount Xapian::Database::gettermfreq(const std::string\n|      &tname) const\n|\n|  gettotallength = Databasegettotallength(...)\n|      Get the total length of all the documents in the database.\n|\n|      Xapian::totallength Xapian::Database::gettotallength() const\n|\n|      Added in Xapian 1.4.5.\n|\n|  getuniqueterms = Databasegetuniqueterms(...)\n|      Get the number of unique terms in document.\n|\n|      Xapian::termcount Xapian::Database::getuniqueterms(Xapian::docid\n|      did) const\n|\n|  getuuid = Databasegetuuid(...)\n|      Get a UUID for the database.\n|\n|      std::string Xapian::Database::getuuid() const\n|\n|      The UUID will persist for the lifetime of the database.\n|\n|      Replicas (eg, made with the replication protocol, or by copying all\n|      the database files) will have the same UUID. However, copies (made\n|      with copydatabase, or xapian-compact) will have different UUIDs.\n|\n|      If the backend does not support UUIDs or this database has no\n|      subdatabases, the UUID will be empty.\n|\n|      If this database has multiple sub-databases, the UUID string will\n|      contain the UUIDs of all the sub-databases.\n|\n|  getvaluefreq = Databasegetvaluefreq(...)\n|      Return the frequency of a given value slot.\n|\n|      Xapian::doccount Xapian::Database::getvaluefreq(Xapian::valueno\n|      slot) const\n|\n|      This is the number of documents which have a (non-empty) value stored\n|      in the slot.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getvaluelowerbound = Databasegetvaluelowerbound(...)\n|      Get a lower bound on the values stored in the given value slot.\n|\n|      std::string Xapian::Database::getvaluelowerbound(Xapian::valueno\n|      slot) const\n|\n|      If there are no values stored in the given value slot, this will\n|      return an empty string.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getvalueupperbound = Databasegetvalueupperbound(...)\n|      Get an upper bound on the values stored in the given value slot.\n|\n|      std::string Xapian::Database::getvalueupperbound(Xapian::valueno\n|      slot) const\n|\n|      If there are no values stored in the given value slot, this will\n|      return an empty string.\n|\n|      Parameters:\n|      -----------\n|\n|      slot:  The value slot to examine.\n|\n|  getwdfupperbound = Databasegetwdfupperbound(...)\n|      Get an upper bound on the wdf of term term.\n|\n|      Xapian::termcount Xapian::Database::getwdfupperbound(const\n|      std::string &term) const\n|\n|  haspositions = Databasehaspositions(...)\n|      Does this database have any positional information?\n|\n|      bool Xapian::Database::haspositions() const\n|\n|  keepalive = Databasekeepalive(...)\n|      Send a \"keep-alive\" to remote databases to stop them timing out.\n|\n|      void Xapian::Database::keepalive()\n|\n|      Has no effect on non-remote databases.\n|\n|  locked = Databaselocked(...)\n|      Test if this database is currently locked for writing.\n|\n|      bool Xapian::Database::locked() const\n|\n|      If the underlying object is actually a WritableDatabase, always\n|      returns true.\n|\n|      Otherwise tests if there's a writer holding the lock (or if we can't\n|      test for a lock without taking it on the current platform, throw\n|      Xapian::UnimplementedError). If there's an error while trying to test\n|      the lock, throws Xapian::DatabaseLockError.\n|\n|      For multi-databases, this tests each sub-database and returns true if\n|      any of them are locked.\n|\n|  metadatakeys = databasegenmetadatakeysiter(self, prefix='')\n|      Get an iterator which returns all the metadata keys.\n|\n|      The iterator will return string objects.\n|\n|      If `prefix` is non-empty, only metadata keys with this prefix are returned.\n|\n|  positionlist = databasegenpositionlistiter(self, docid, tname)\n|      Get an iterator over all the positions in a given document of a term.\n|\n|      The iterator will return integers, in ascending order.\n|\n|  postlist = databasegenpostlistiter(self, tname)\n|      Get an iterator over the postings which are indexed by a given term.\n|\n|      If `tname` is empty, an iterator over all the documents will be returned\n|      (this will contain one entry for each document, will always return a wdf of\n|      1, and will not allow access to a position iterator).\n|\n|  reopen = Databasereopen(...)\n|      Re-open the database.\n|\n|      bool Xapian::Database::reopen()\n|\n|      This re-opens the database(s) to the latest available version(s). It\n|      can be used either to make sure the latest results are returned, or to\n|      recover from a Xapian::DatabaseModifiedError.\n|\n|      Calling reopen() on a database which has been closed (with  close())\n|      will always raise a Xapian::DatabaseError.\n|\n|      true if the database might have been reopened (if false is returned,\n|      the database definitely hasn't been reopened, which applications may\n|      find useful when caching results, etc). In Xapian < 1.3.0, this method\n|      did not return a value.\n|\n|  size = Databasesize(...)\n|      Return number of shards in this Database object.\n|\n|      sizet Xapian::Database::size() const\n|\n|  spellings = databasegenspellingsiter(self)\n|      Get an iterator which returns all the spelling correction targets\n|\n|      The iterator will return TermListItem objects.  Only the term frequency is\n|      available; wdf and positions are not meaningful.\n|\n|  synonymkeys = databasegensynonymkeysiter(self, prefix='')\n|      Get an iterator which returns all the terms which have synonyms.\n|\n|      The iterator will return string objects.\n|\n|      If `prefix` is non-empty, only terms with this prefix are returned.\n|\n|  synonyms = databasegensynonymsiter(self, term)\n|      Get an iterator which returns all the synonyms for a given term.\n|\n|      The term to return synonyms for is specified by the `term` parameter.\n|\n|      The iterator will return string objects.\n|\n|  termexists = Databasetermexists(...)\n|      Check if a given term exists in the database.\n|\n|      bool Xapian::Database::termexists(const std::string &tname) const\n|\n|      Parameters:\n|      -----------\n|\n|      tname:  The term to test the existence of.\n|\n|      true if and only if the term exists in the database. This is the same\n|      as (gettermfreq(tname) != 0), but will often be more efficient.\n|\n|  termlist = databasegentermlistiter(self, docid)\n|      Get an iterator over all the terms which index a given document ID.\n|\n|      The iterator will return TermListItem objects.\n|\n|      Access to term frequency and position information is only available until\n|      the iterator has moved on.\n|\n|  valuestream(self, slot)\n|      Get an iterator over all the values stored in a slot in the database.\n|\n|      The iterator will return ValueStreamItem objects, in ascending order of\n|      document id.\n|\n|  ----------------------------------------------------------------------\n|  Static methods inherited from Database:\n|\n|  check = Databasecheck(...)\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Database:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n"
                }
            ]
        },
        "FUNCTIONS": {
            "content": "Databasecheck(...)\n\nadd(...)\n\neq(...)\nReturn self==value.\n\nge(...)\nReturn self>=value.\n\ngt(...)\nReturn self>value.\n\nle(...)\nReturn self<=value.\n\nlt(...)\nReturn self<value.\n\nne(...)\nReturn self!=value.\n",
            "subsections": [
                {
                    "name": "major_version",
                    "content": ""
                },
                {
                    "name": "metres_to_miles",
                    "content": ""
                },
                {
                    "name": "miles_to_metres",
                    "content": ""
                },
                {
                    "name": "minor_version",
                    "content": ""
                },
                {
                    "name": "remote_open",
                    "content": "Construct a Database object for read-only access to a remote database\naccessed via a program.\n\nDatabase Xapian::Remote::open(const std::string &program, const\nstd::string &args, usecondst timeout=10000)\n\nAccess to the remote database is done by running an external program\nand communicating with it on stdin/stdout.\n\nParameters:\n-----------\n\nprogram:  the external program to run.\n\nargs:  space-separated list of arguments to pass to program.\n\ntimeout:  timeout in milliseconds. If this timeout is exceeded for any\nindividual operation on the remote database then\nXapian::NetworkTimeoutError is thrown. A timeout of 0 means don't\ntimeout. (Default is 10000ms, which is 10 seconds).\n"
                },
                {
                    "name": "remote_open_writable",
                    "content": "Construct a WritableDatabase object for update access to a remote\ndatabase accessed via a program.\n\nWritableDatabase Xapian::Remote::openwritable(const std::string\n&program, const std::string &args, usecondst timeout=0, int flags=0)\n\nAccess to the remote database is done by running an external program\nand communicating with it on stdin/stdout.\n\nParameters:\n-----------\n\nprogram:  the external program to run.\n\nargs:  space-separated list of arguments to pass to program.\n\ntimeout:  timeout in milliseconds. If this timeout is exceeded for any\nindividual operation on the remote database then\nXapian::NetworkTimeoutError is thrown. (Default is 0, which means\ndon't timeout).\n\nflags:   Xapian::DBRETRYLOCK or 0.\n"
                },
                {
                    "name": "revision",
                    "content": ""
                },
                {
                    "name": "sortable_serialise",
                    "content": ""
                },
                {
                    "name": "sortable_unserialise",
                    "content": ""
                },
                {
                    "name": "version_string",
                    "content": "weakrefproxy = proxy(...)\nproxy(object[, callback]) -- create a proxy object that weakly\nreferences 'object'.  'callback', if given, is called with a\nreference to the proxy when 'object' is about to be finalized.\n"
                }
            ]
        },
        "DATA": {
            "content": "BADVALUENO = 4294967295\nDBCHECKFIX = 16\nDBCHECKFULLTREE = 2\nDBCHECKSHORTTREE = 1\nDBCHECKSHOWFREELIST = 4\nDBCHECKSHOWSTATS = 8\nDBCOMPACTMULTIPASS = 8\nDBCOMPACTNORENUMBER = 4\nDBCOMPACTSINGLEFILE = 16\nDBBACKENDCHERT = 512\nDBBACKENDGLASS = 256\nDBBACKENDINMEMORY = 1024\nDBBACKENDSTUB = 768\nDBCREATE = 2\nDBCREATEOROPEN = 0\nDBCREATEOROVERWRITE = 1\nDBDANGEROUS = 16\nDBFULLSYNC = 8\nDBNOSYNC = 4\nDBNOTERMLIST = 32\nDBOPEN = 3\nDBRETRYLOCK = 64\nDOCASSUMEVALID = 1\nRPDATEPREFERMDY = 4\nRPREPEATED = 2\nRPSUFFIX = 1\nall = ('AssertionError', 'BADVALUENO', 'BB2Weight', 'BM25PlusWeig...\ndocformat = 'restructuredtext en'\n",
            "subsections": []
        },
        "VERSION": {
            "content": "1.4.18\n",
            "subsections": []
        },
        "FILE": {
            "content": "/usr/lib/python3/dist-packages/xapian/init.py\n\n",
            "subsections": []
        }
    },
    "summary": "xapian",
    "flags": [],
    "examples": [],
    "see_also": []
}