Struct tantivy::query::TermQuery

pub struct TermQuery { /* fields omitted */ }

A Term query matches all of the documents containing a specific term.

The score associated is defined as idf * sqrt(term_freq / field norm) in which :

• idf - inverse document frequency.
• term_freq - number of occurrences of the term in the field
• field norm - number of tokens in the field.

#[macro_use]
extern crate tantivy;
use tantivy::schema::{Schema, TEXT, IndexRecordOption};
use tantivy::{Index, Result, Term};
use tantivy::collector::{Count, TopDocs};
use tantivy::query::TermQuery;

fn example() -> Result<()> {
    let mut schema_builder = Schema::builder();
    let title = schema_builder.add_text_field("title", TEXT);
    let schema = schema_builder.build();
    let index = Index::create_in_ram(schema);
    {
        let mut index_writer = index.writer(3_000_000)?;
        index_writer.add_document(doc!(
            title => "The Name of the Wind",
        ));
        index_writer.add_document(doc!(
            title => "The Diary of Muadib",
        ));
        index_writer.add_document(doc!(
            title => "A Dairy Cow",
        ));
        index_writer.add_document(doc!(
            title => "The Diary of a Young Girl",
        ));
        index_writer.commit()?;
    }
    let reader = index.reader()?;
    let searcher = reader.searcher();

    let query = TermQuery::new(
        Term::from_field_text(title, "diary"),
        IndexRecordOption::Basic,
    );
    let (top_docs, count) = searcher.search(&query, &(TopDocs::with_limit(2), Count)).unwrap();
    assert_eq!(count, 2);

    Ok(())
}

Methods

impl TermQuery

pub fn new(term: Term, segment_postings_options: IndexRecordOption) -> TermQuery

Creates a new term query.

pub fn term(&self) -> &Term

The Term this query is built out of.

pub fn specialized_weight(
    &self,
    searcher: &Searcher,
    scoring_enabled: bool
) -> TermWeight

Returns a weight object.

While .weight(...) returns a boxed trait object, this method return a specific implementation. This is useful for optimization purpose.

Trait Implementations

impl Query for TermQuery

fn weight(
    &self,
    searcher: &Searcher,
    scoring_enabled: bool
) -> Result<Box<dyn Weight>>

Create the weight associated to a query.

fn query_terms(&self, term_set: &mut BTreeSet<Term>)

Extract all of the terms associated to the query and insert them in the term set given in arguments.

fn explain(
    &self,
    searcher: &Searcher,
    doc_address: DocAddress
) -> Result<Explanation>

Returns an Explanation for the score of the document.

fn count(&self, searcher: &Searcher) -> Result<usize>

Returns the number of documents matching the query.

impl Clone for TermQuery

fn clone(&self) -> TermQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TermQuery

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.