linkrs-api 0.1.0

Transport-independent core API for Linkrs
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use crate::api_core::{CoreError, CoreResult};
use crate::embedded::database::GraphDatabase;
use crate::migration_online::execute_online_migration;
use linkrs_migration::{MigrationConfig, MigrationPlan, MigrationReport};
use linkrs_storage::GraphStorage;

impl GraphDatabase<GraphStorage> {
    pub fn generate_vertex_migration_plan(
        &self,
        space: &str,
        tag: &str,
        from_version: u64,
        to_version: u64,
    ) -> CoreResult<MigrationPlan> {
        let storage = self.storage();
        linkrs_migration::generate_vertex_plan(&*storage, space, tag, from_version, to_version)
            .map_err(|e| CoreError::Internal(e.to_string()))
    }

    pub fn generate_vertex_migration_plan_with_expand(
        &self,
        space: &str,
        tag: &str,
        from_version: u64,
        to_version: u64,
        expand_contract: bool,
    ) -> CoreResult<MigrationPlan> {
        let storage = self.storage();
        linkrs_migration::generate_vertex_plan_with_expand(
            &*storage,
            space,
            tag,
            from_version,
            to_version,
            expand_contract,
        )
        .map_err(|e| CoreError::Internal(e.to_string()))
    }

    pub fn generate_edge_migration_plan(
        &self,
        space: &str,
        edge_type: &str,
        from_version: u64,
        to_version: u64,
    ) -> CoreResult<MigrationPlan> {
        let storage = self.storage();
        linkrs_migration::generate_edge_plan(&*storage, space, edge_type, from_version, to_version)
            .map_err(|e| CoreError::Internal(e.to_string()))
    }

    pub fn generate_edge_migration_plan_with_expand(
        &self,
        space: &str,
        edge_type: &str,
        from_version: u64,
        to_version: u64,
        expand_contract: bool,
    ) -> CoreResult<MigrationPlan> {
        let storage = self.storage();
        linkrs_migration::generate_edge_plan_with_expand(
            &*storage,
            space,
            edge_type,
            from_version,
            to_version,
            expand_contract,
        )
        .map_err(|e| CoreError::Internal(e.to_string()))
    }

    pub fn execute_migration_plan(&self, plan: &MigrationPlan) -> CoreResult<MigrationReport> {
        let mut storage = self.storage_mut();
        let start = std::time::Instant::now();
        self.stats_manager().record_migration_start();
        let res = linkrs_migration::execute_migration_plan(&mut *storage, plan)
            .map_err(|e| CoreError::Internal(e.to_string()));
        let elapsed = start.elapsed().as_millis() as u64;
        match &res {
            Ok(report) if report.success => {
                self.stats_manager()
                    .record_migration_success(report.rows_migrated, elapsed);
            }
            Ok(_) | Err(_) => {
                self.stats_manager().record_migration_failure(elapsed);
            }
        }
        res
    }

    /// Execute with the online drain protocol: writes stall only across
    /// schema-modifying steps while the data backfill stays online, and the
    /// switch is audited on success. Data-only plans skip the fence entirely.
    pub fn execute_migration_plan_online(
        &self,
        plan: &MigrationPlan,
        config: &MigrationConfig,
    ) -> CoreResult<MigrationReport> {
        let gate = self.txn_manager().checkpoint_gate().clone();
        let mut storage = self.storage_mut();
        let start = std::time::Instant::now();
        self.stats_manager().record_migration_start();
        let res = execute_online_migration(&mut *storage, plan, config, &gate, None)
            .map_err(|e| CoreError::Internal(e.to_string()));
        let elapsed = start.elapsed().as_millis() as u64;
        match &res {
            Ok(report) if report.success => {
                self.stats_manager()
                    .record_migration_success(report.rows_migrated, elapsed);
            }
            Ok(_) | Err(_) => {
                self.stats_manager().record_migration_failure(elapsed);
            }
        }
        res
    }

    pub fn rollback_migration(&self, plan: &MigrationPlan) -> CoreResult<MigrationReport> {
        let mut storage = self.storage_mut();
        linkrs_migration::rollback_migration(&mut *storage, plan)
            .map_err(|e| CoreError::Internal(e.to_string()))
    }
}