class documentation

class Clause: (source)

View In Hierarchy

A single clause in a `lunr.Query` contains a term and details on how to match that term against a `lunr.Index` Args: term (str, optional): The term for the clause. field (iterable, optional): The fields for the term to be searched against. edit_distance (int, optional): The character distance to use, defaults to 0. use_pipeline (bool, optional): Whether the clause should be pre processed by the index's pipeline, default to True. boost (int, optional): Boost to apply to the clause, defaults to 1. wildcard (Query.WILDCARD_*, optional): Any of the Query.WILDCARD constants defining if a wildcard is to be used and how, defaults to Query.WILDCARD_NONE. presence (QueryPresence, optional): Behaviour for a terms presence in a document.

Method __init__ Undocumented
Method __repr__ Undocumented
Instance Variable boost Undocumented
Instance Variable edit_distance Undocumented
Instance Variable fields Undocumented
Instance Variable presence Undocumented
Instance Variable term Undocumented
Instance Variable use_pipeline Undocumented
Instance Variable wildcard Undocumented
def __init__(self, term=None, fields=None, edit_distance=0, use_pipeline=True, boost=1, wildcard=Query.WILDCARD_NONE, presence=QueryPresence.OPTIONAL): (source)

Undocumented

def __repr__(self): (source)

Undocumented

boost = (source)

Undocumented

edit_distance = (source)

Undocumented

fields = (source)

Undocumented

presence = (source)

Undocumented

term = (source)

Undocumented

use_pipeline = (source)

Undocumented

wildcard = (source)

Undocumented