Lupyne’s documentation

Lupyne is:

Quickstart

>>> from lupyne import engine                       # don't forget to call lucene.initVM
>>> indexer = engine.Indexer()                      # create an in-memory index (no filename supplied)
>>> indexer.set('name', stored=True)                # create stored 'name' field
>>> indexer.set('text')                             # create indexed 'text' field (the default)
>>> indexer.add(name='sample', text='hello world')  # add a document to the index
>>> indexer.commit()                                # commit changes; document is now searchable
>>> hits = indexer.search('text:hello')             # run search and return sequence of documents
>>> len(hits), hits.count                           # 1 hit retrieved (out of a total of 1)
(1, 1)
>>> hit, = hits
>>> hit['name']                                     # hits support mapping interface for their stored fields
u'sample'
>>> hit.id, hit.score                               # plus internal doc number and score
(0, 0.19178301095962524)
>>> hit.dict()                                      # dict representation of the hit document
{'__score__': 0.19178301095962524, u'name': u'sample', '__id__': 0}

See more examples

Indices and tables

Table Of Contents

Next topic

engine

This Page