lance-index 6.0.1

Lance indices implementation
Documentation 
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
47
48
49
50
51
52
53
54

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Lance Authors

use async_trait::async_trait;
use lance_core::Result;
use std::sync::Arc;

/// Progress callback for index building and distributed index finalization.
///
/// Called at stage boundaries during index construction. For a single logical stream, stages are
/// sequential: `stage_complete` is always called before the next `stage_start`, so only one stage
/// is active at a time. Callers that orchestrate independent sub-builds in parallel may prefix
/// stage names (for example `segment_plan[0]/merge_partitions`) to represent separate logical
/// streams. Stage names are index-type-specific (e.g. "train_ivf", "shuffle", "merge_partitions"
/// for vector indices; "load_data", "build_pages" for scalar indices; merge/finalization stages
/// for distributed index construction).
///
/// Methods take `&self` to allow concurrent calls from within a single stage. Implementations
/// must be thread-safe.
#[async_trait]
pub trait IndexBuildProgress: std::fmt::Debug + Sync + Send {
    /// A named stage has started.
    ///
    /// `total` is the number of work units if known, and `unit` describes
    /// what is being counted (e.g. "partitions", "batches", "rows").
    async fn stage_start(&self, stage: &str, total: Option<u64>, unit: &str) -> Result<()>;

    /// Progress within the current stage.
    async fn stage_progress(&self, stage: &str, completed: u64) -> Result<()>;

    /// A named stage has completed.
    async fn stage_complete(&self, stage: &str) -> Result<()>;
}

#[derive(Debug, Clone, Default)]
pub struct NoopIndexBuildProgress;

#[async_trait]
impl IndexBuildProgress for NoopIndexBuildProgress {
    async fn stage_start(&self, _: &str, _: Option<u64>, _: &str) -> Result<()> {
        Ok(())
    }
    async fn stage_progress(&self, _: &str, _: u64) -> Result<()> {
        Ok(())
    }
    async fn stage_complete(&self, _: &str) -> Result<()> {
        Ok(())
    }
}

/// Helper to create a default noop progress instance.
pub fn noop_progress() -> Arc<dyn IndexBuildProgress> {
    Arc::new(NoopIndexBuildProgress)
}