mq-db 0.1.13

Markdown-specialized embedded database with interval-indexed block storage and hierarchical query support
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

//! mq query engine integration for mq-db.
//!
//! Provides [`MqEngine`] which runs [`mq-lang`] programs against Markdown
//! files on disk or against file-backed documents in a [`DocumentStore`].
//!
//! # Example
//!
//! ```rust,no_run
//! use mq_db::mq_engine::MqEngine;
//! use std::path::Path;
//!
//! // Run an mq program against a file
//! let results = MqEngine::eval_files(".h1", &[Path::new("README.md")]).unwrap();
//! for r in &results {
//!     println!("{}", r);
//! }
//! ```

use std::path::Path;

use mq_lang::{DefaultEngine, parse_markdown_input};

use crate::{DocumentStore, MqdbError};

/// Thin wrapper around [`mq_lang::DefaultEngine`] for evaluating mq programs
/// over Markdown content.
pub struct MqEngine;

impl MqEngine {
    /// Run an mq program against one or more files on disk.
    ///
    /// Each file is parsed independently; results from all files are
    /// concatenated in order.
    ///
    /// # Errors
    ///
    /// Returns [`MqdbError::Io`] if a file cannot be read,
    /// [`MqdbError::Mq`] if parsing or evaluation fails.
    pub fn eval_files(code: &str, paths: &[&Path]) -> Result<Vec<String>, MqdbError> {
        let mut engine = DefaultEngine::default();
        engine.load_builtin_module();

        let mut results = Vec::new();
        for path in paths {
            let content = std::fs::read_to_string(path)?;
            let input = parse_markdown_input(&content).map_err(|e| MqdbError::Mq(e.to_string()))?;
            let output = engine
                .eval(code, input.into_iter())
                .map_err(|e| MqdbError::Mq(e.to_string()))?;
            for v in output.compact() {
                results.push(v.to_string());
            }
        }
        Ok(results)
    }

    /// Run an mq program against all file-backed documents in a store.
    ///
    /// Documents that were added via [`DocumentStore::add_str`] (no path)
    /// are silently skipped.
    pub fn eval_store(code: &str, store: &DocumentStore) -> Result<Vec<String>, MqdbError> {
        let paths: Vec<&Path> = store
            .documents()
            .iter()
            .filter_map(|d| d.path.as_deref())
            .collect();
        Self::eval_files(code, &paths)
    }
}