Skip to main content

drizzle_cli/commands/
export.rs

1//! Export command implementation
2//!
3//! Exports the schema as SQL statements.
4
5use std::path::PathBuf;
6
7use crate::commands::overrides;
8use crate::config::Config;
9use crate::config::Dialect;
10use crate::error::CliError;
11use crate::output;
12use drizzle_migrations::schema::Snapshot;
13
14#[derive(clap::Args, Debug, Clone)]
15pub struct ExportOptions {
16    /// Output SQL to a file (default: stdout)
17    #[arg(long = "sql")]
18    pub output_path: Option<PathBuf>,
19
20    /// Override dialect from config
21    #[arg(long)]
22    pub dialect: Option<Dialect>,
23
24    /// Override schema path(s)
25    #[arg(long, value_delimiter = ',')]
26    pub schema: Option<Vec<String>>,
27}
28
29/// Run the export command.
30///
31/// # Errors
32///
33/// Returns [`CliError`] if the requested database cannot be resolved, the
34/// schema files cannot be read/parsed, the resolved snapshot cannot be
35/// generated, or if writing the output SQL file fails.
36pub fn run(config: &Config, db_name: Option<&str>, opts: ExportOptions) -> Result<(), CliError> {
37    use drizzle_migrations::parser::SchemaParser;
38
39    let db = config.database(db_name)?;
40    let effective_dialect = overrides::resolve_dialect(db, opts.dialect);
41
42    crate::commands::harness::print_db_header(config, db_name);
43
44    println!("{}", output::heading("Exporting schema as SQL..."));
45    println!();
46
47    println!(
48        "  {}: {}",
49        output::label("Dialect"),
50        effective_dialect.as_str()
51    );
52
53    // Parse schema files
54    let schema_files = overrides::resolve_schema_files(db, opts.schema.as_deref())?;
55    if schema_files.is_empty() {
56        return Err(CliError::NoSchemaFiles(overrides::resolve_schema_display(
57            db,
58            opts.schema.as_deref(),
59        )));
60    }
61
62    println!(
63        "  {} {} schema file(s)",
64        output::label("Parsing"),
65        schema_files.len()
66    );
67
68    let mut combined_code = String::new();
69    for path in &schema_files {
70        let code = std::fs::read_to_string(path)
71            .map_err(|e| CliError::IoError(format!("Failed to read {}: {}", path.display(), e)))?;
72        combined_code.push_str(&code);
73        combined_code.push('\n');
74    }
75
76    let parse_result = SchemaParser::parse(&combined_code);
77    crate::snapshot::surface_parse_diagnostics(&parse_result)?;
78
79    println!(
80        "  {} {} table(s), {} index(es), {} enum(s), {} view(s)",
81        output::label("Found"),
82        parse_result.tables.len(),
83        parse_result.indexes.len(),
84        parse_result.enums.len(),
85        parse_result.views.len(),
86    );
87
88    // Build snapshot from parsed schema (use config dialect)
89    let dialect = effective_dialect.to_base();
90    let snapshot = Snapshot::from_parse_result(&parse_result, dialect, db.casing);
91    if snapshot.is_empty() {
92        println!("{}", output::warning("No schema entities found."));
93        return Ok(());
94    }
95
96    // Use the public planner so export has the same validation, dependency
97    // ordering, and SQL rendering call stack as generated migrations.
98    let plan = generate_create_plan(&snapshot)?;
99    let sql_statements = &plan.statements;
100
101    if sql_statements.is_empty() {
102        println!("{}", output::warning("No SQL statements generated."));
103        return Ok(());
104    }
105
106    let sql_content = if db.breakpoints {
107        plan.to_sql()
108    } else {
109        sql_statements.join("\n\n")
110    };
111
112    // Output to file or stdout
113    if let Some(path) = opts.output_path {
114        std::fs::write(&path, &sql_content)
115            .map_err(|e| CliError::IoError(format!("Failed to write {}: {}", path.display(), e)))?;
116        println!();
117        println!(
118            "{}",
119            output::success(&format!(
120                "Exported {} SQL statement(s) to {}",
121                sql_statements.len(),
122                path.display()
123            ))
124        );
125    } else {
126        println!();
127        println!("{}", output::muted("-- Generated SQL --"));
128        println!();
129        println!("{sql_content}");
130        println!();
131        println!("{}", output::muted("-- End of SQL --"));
132    }
133
134    Ok(())
135}
136
137/// Plan CREATE SQL from an empty snapshot through the shared dialect entrypoint.
138fn generate_create_plan(
139    snapshot: &drizzle_migrations::schema::Snapshot,
140) -> Result<drizzle_migrations::Plan, CliError> {
141    let empty = Snapshot::empty(snapshot.dialect());
142    drizzle_migrations::diff(&empty, snapshot)
143        .map_err(|error| CliError::MigrationError(error.to_string()))
144}