commonmeta 0.8.8

Library for conversions to/from the Commonmeta scholarly metadata format
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

use clap::{Arg, ArgMatches, Command};
use std::path::Path;
use std::time::Instant;

use crate::cmd::resolve_db_path;

pub fn command() -> Command {
    Command::new("migrate")
        .about("Apply any pending database schema migrations")
        .long_about(
            "Open the local commonmeta database and apply any pending schema \
             migrations, then exit. Safe to run on databases built with older \
             releases: migrations are idempotent and only alter the schema \
             (no existing records are modified or removed).\n\n\
             Each step is printed to stderr with elapsed time. On large databases \
             (hundreds of millions of records) index creation can take 30–90 minutes; \
             the command will not hang silently.\n\n\
             Examples:\n\n\
             commonmeta migrate\n\
             commonmeta migrate --file /var/lib/commonmeta/commonmeta.sqlite3",
        )
        .arg(
            Arg::new("file")
                .long("file")
                .help("Path to the SQLite database (overrides COMMONMETA_DB and platform default)"),
        )
}

pub fn execute(matches: &ArgMatches) -> Result<(), String> {
    let db_path_str = resolve_db_path(matches.get_one::<String>("file"));
    let db_path = Path::new(&db_path_str);

    if !db_path.exists() {
        return Err(format!(
            "database not found at '{}'; run 'commonmeta import' first",
            db_path_str
        ));
    }

    eprintln!("migrate: {}", db_path_str);
    let total_start = Instant::now();

    let (applied, version) =
        commonmeta::run_migrations(db_path).map_err(|e| e.to_string())?;

    if applied == 0 {
        eprintln!("migrate: already at schema version {version}, nothing to do");
    } else {
        eprintln!(
            "migrate: applied {} step(s), schema version {} ({:.1?})",
            applied,
            version,
            total_start.elapsed()
        );
    }

    println!("migrated {} (schema version {})", db_path_str, version);
    Ok(())
}