octofhir-sof 0.2.1

SQL on FHIR v2: ViewDefinition parser, PostgreSQL generator and database-free in-memory evaluator
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

//! SQL on FHIR implementation for OctoFHIR.
//!
//! This crate provides support for the SQL on FHIR specification, which enables
//! transformation of FHIR resources into tabular data using ViewDefinition resources.
//!
//! # Overview
//!
//! SQL on FHIR allows you to define views over FHIR resources that can be materialized
//! as relational tables. This is useful for analytics, reporting, and integration with
//! SQL-based tools.
//!
//! # Components
//!
//! - [`ViewDefinition`] - Parsed representation of a FHIR ViewDefinition resource
//! - [`SqlGenerator`] - Generates SQL from ViewDefinitions
//! - [`CompiledView`] / [`execute`] - Database-free in-memory evaluation
//! - [`SqlExecutor`] / [`run_with`] - Run generated SQL through any database layer
//! - `ViewRunner` - Executes views against PostgreSQL (feature `postgres`)
//!
//! # Cargo features
//!
//! The default build has no database or network dependency (parsing, SQL
//! generation for every dialect, in-memory evaluation). Optional backends are
//! opt-in:
//!
//! - `postgres` — the bundled sqlx `ViewRunner`
//! - `parquet` — the Parquet writer
//! - `tx-remote` — `terminology::HttpTerminologyProvider` for
//!   `memberOf()`/`subsumes()`/`translate()` against a remote terminology server
//!
//! # Terminology
//!
//! Terminology functions resolve through a [`TerminologyProvider`] passed in
//! [`CompileOptions`]; without one they fail with a clear error.
//!
//! # Example
//!
//! ```ignore
//! use octofhir_sof::{ViewDefinition, SqlGenerator, ViewRunner};
//!
//! // Parse a ViewDefinition
//! let view_def = ViewDefinition::from_json(&json)?;
//!
//! // Generate SQL
//! let generator = SqlGenerator::new();
//! let sql = generator.generate(&view_def)?;
//!
//! // Execute the view
//! let runner = ViewRunner::new(pool, generator);
//! let result = runner.run(&view_def).await?;
//! ```
//!
//! # SQL on FHIR Specification
//!
//! See: <https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/>

mod column;
mod eval;
pub mod output;
mod runner;
mod sql_generator;
mod view_definition;

pub use column::{ColumnInfo, ColumnType};
pub use eval::{
    CompileOptions, CompiledView, execute, execute_blocking, execute_parallel,
    execute_parallel_with, execute_with,
};
#[cfg(feature = "postgres")]
pub use runner::ViewRunner;
pub use runner::{SqlExecutor, ViewResult, run_with};
pub use sql_generator::{Dialect, GeneratedColumn, GeneratedSql, SqlGenerator, create_table};
pub use view_definition::{Column, Constant, SelectColumn, ViewDefinition, WhereClause};

pub use octofhir_fhir_model::TerminologyProvider;

/// Terminology provider types, re-exported from `octofhir-fhir-model` so hosts
/// can implement or construct one without a direct dependency.
pub mod terminology {
    pub use octofhir_fhir_model::terminology::*;
}

use thiserror::Error;

/// Errors that can occur during SQL on FHIR operations.
#[derive(Debug, Error)]
pub enum Error {
    /// The ViewDefinition JSON is invalid or missing required fields.
    #[error("Invalid ViewDefinition: {0}")]
    InvalidViewDefinition(String),

    /// A FHIRPath expression is invalid or cannot be converted to SQL.
    #[error("Invalid path: {0}")]
    InvalidPath(String),

    /// An error occurred while executing SQL through the bundled sqlx runner.
    #[cfg(feature = "postgres")]
    #[error("SQL execution error: {0}")]
    Sql(#[from] sqlx_core::error::Error),

    /// An external [`SqlExecutor`] failed to run the generated SQL.
    #[error("SQL execution error: {0}")]
    Execution(String),

    /// An error occurred during FHIRPath evaluation or compilation.
    #[error("FHIRPath error: {0}")]
    FhirPath(String),

    /// An error occurred while generating output.
    #[error("Output error: {0}")]
    Output(String),

    /// JSON serialization/deserialization error.
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),
}

/// Result type alias using the crate's Error type.
pub type Result<T> = std::result::Result<T, Error>;