schema-sync 1.0.0

Production-grade schema synchronization for multi-tenant databases
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

//! Developer: s4gor
//! Github: https://github.com/s4gor
//!
//! Migration execution
//!
//! The executor orchestrates the execution of migration plans.
//! It handles:
//! - Lock acquisition
//! - Transaction management
//! - Step-by-step execution
//! - Rollback on failure
//! - Progress tracking
//!
//! ## Design Rationale
//!
//! Separating execution from planning allows:
//! - Different execution strategies (transactional, non-transactional)
//! - Progress reporting
//! - Retry logic
//! - Testing with mock executors

use async_trait::async_trait;

use crate::adapters::MigrationRunner;
use crate::errors::Result;
use crate::planner::MigrationPlan;

/// Result of executing a migration plan
#[derive(Debug, Clone)]
pub struct ExecutionResult {
    /// Number of steps executed successfully
    pub steps_executed: usize,

    /// Total number of steps in the plan
    pub total_steps: usize,

    /// Whether execution completed successfully
    pub success: bool,

    /// Error message if execution failed
    pub error: Option<String>,

    /// Duration of execution
    pub duration_secs: f64,
}

/// Trait for executing migration plans
///
/// The executor coordinates between the planner, migration runner,
/// and other components to safely execute migrations.
#[async_trait]
pub trait Executor: Send + Sync {
    /// Execute a migration plan for a tenant
    ///
    /// # Arguments
    ///
    /// * `tenant` - The tenant context
    /// * `plan` - The migration plan to execute
    /// * `runner` - The migration runner to use
    ///
    /// # Returns
    ///
    /// Execution result with success status and details.
    async fn execute(
        &self,
        tenant: &crate::cli::TenantContext,
        plan: &MigrationPlan,
        runner: &dyn MigrationRunner,
    ) -> Result<ExecutionResult>;

    /// Execute a migration plan in dry-run mode
    ///
    /// This validates the plan and returns what would happen,
    /// but doesn't actually execute any changes.
    async fn dry_run(
        &self,
        tenant: &crate::cli::TenantContext,
        plan: &MigrationPlan,
        runner: &dyn MigrationRunner,
    ) -> Result<ExecutionResult>;
}