index/fulltext_index/
create.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Copyright 2023 Greptime Team
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

mod bloom_filter;
mod tantivy;

use async_trait::async_trait;
use puffin::puffin_manager::{PuffinWriter, PutOptions};

pub use crate::fulltext_index::create::bloom_filter::BloomFilterFulltextIndexCreator;
pub use crate::fulltext_index::create::tantivy::{
    TantivyFulltextIndexCreator, ROWID_FIELD_NAME, TEXT_FIELD_NAME,
};
use crate::fulltext_index::error::Result;

/// `FulltextIndexCreator` is for creating a fulltext index.
#[async_trait]
pub trait FulltextIndexCreator: Send {
    /// Pushes a text to the index.
    async fn push_text(&mut self, text: &str) -> Result<()>;

    /// Finalizes the creation of the index.
    async fn finish(
        &mut self,
        puffin_writer: &mut (impl PuffinWriter + Send),
        blob_key: &str,
        put_options: PutOptions,
    ) -> Result<u64>;

    /// Aborts the creation of the index.
    async fn abort(&mut self) -> Result<()>;

    /// Returns the memory usage in bytes during the creation of the index.
    fn memory_usage(&self) -> usize;
}