index/fulltext_index/search.rs
1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15mod tantivy;
16
17use std::collections::BTreeSet;
18
19use async_trait::async_trait;
20
21use crate::fulltext_index::error::Result;
22pub use crate::fulltext_index::search::tantivy::TantivyFulltextIndexSearcher;
23
24pub type RowId = u32;
25
26/// `FulltextIndexSearcher` is a trait for searching fulltext index.
27#[async_trait]
28pub trait FulltextIndexSearcher {
29 async fn search(&self, query: &str) -> Result<BTreeSet<RowId>>;
30}