use scythe_backend::manifest::BackendManifest;
use scythe_backend::naming::{
enum_type_name, enum_variant_name, fn_name, row_struct_name, to_pascal_case, to_snake_case,
};
use scythe_backend::types::resolve_type;
use std::fmt::Write;
use scythe_core::analyzer::{AnalyzedQuery, CompositeInfo, EnumInfo};
use scythe_core::errors::{ErrorCode, ScytheError};
use scythe_core::parser::QueryCommand;
use crate::backend_trait::{CodegenBackend, ResolvedColumn, ResolvedParam};
use crate::singularize;
const DEFAULT_MANIFEST_TOML: &str = include_str!("../../manifests/rust-sibyl.toml");
pub struct RustSibylBackend {
manifest: BackendManifest,
}
impl RustSibylBackend {
pub fn new(engine: &str) -> Result<Self, ScytheError> {
match engine {
"oracle" => {}
_ => {
return Err(ScytheError::new(
ErrorCode::InternalError,
format!("rust-sibyl only supports Oracle, got engine '{}'", engine),
));
}
}
let manifest = super::load_or_default_manifest("backends/rust-sibyl/manifest.toml", DEFAULT_MANIFEST_TOML)?;
Ok(Self { manifest })
}
fn build_in_args(params: &[ResolvedParam]) -> String {
match params.len() {
0 => "()".to_string(),
1 => format!(
"(\"{}\", {})",
Self::named_placeholder(¶ms[0].field_name),
params[0].field_name
),
_ => {
let pairs: Vec<String> = params
.iter()
.map(|p| format!("(\"{}\", {})", Self::named_placeholder(&p.field_name), p.field_name))
.collect();
format!("({})", pairs.join(", "))
}
}
}
fn named_placeholder(field_name: &str) -> String {
format!(":{}", field_name.to_uppercase())
}
fn out_named_placeholder(field_name: &str) -> String {
format!(":OUT_{}", field_name.to_uppercase())
}
fn sql_with_named_params(sql: &str, params: &[ResolvedParam]) -> String {
let mut result = sql.to_string();
for (i, p) in params.iter().enumerate().rev() {
let positional = format!(":{}", i + 1);
let named = format!(":{}", p.field_name.to_uppercase());
result = result.replace(&positional, &named);
}
result
}
fn sql_with_returning(base_sql: &str, columns: &[ResolvedColumn]) -> String {
let out_names: Vec<String> = columns
.iter()
.map(|c| format!(":OUT_{}", c.field_name.to_uppercase()))
.collect();
let upper = base_sql.to_uppercase();
if let Some(ret_pos) = upper.find("RETURNING") {
let prefix = &base_sql[..ret_pos];
let rest = &base_sql[ret_pos + "RETURNING".len()..];
let col_list = if let Some(into_pos) = rest.to_uppercase().find(" INTO ") {
rest[..into_pos].trim()
} else {
rest.trim()
};
format!("{}RETURNING {} INTO {}", prefix, col_list, out_names.join(", "))
} else {
base_sql.to_string()
}
}
fn emit_out_var_decl_typed(col: &ResolvedColumn) -> String {
match col.neutral_type.as_str() {
"int16" | "int32" | "int64" => {
format!(" let mut out_{}: i64 = 0;", col.field_name)
}
"float32" | "float64" | "decimal" => {
format!(" let mut out_{}: f64 = 0.0;", col.field_name)
}
"date" | "datetime" | "datetime_tz" => {
format!(" let mut out_{} = Date::new(session);", col.field_name)
}
_ => {
format!(" let mut out_{} = String::new();", col.field_name)
}
}
}
fn out_var_ref_for_returning(col: &ResolvedColumn) -> String {
format!("&mut out_{}", col.field_name)
}
fn emit_out_var_conversion(col: &ResolvedColumn) -> String {
match col.neutral_type.as_str() {
"int16" => format!(" let {} = out_{} as i16;", col.field_name, col.field_name),
"int32" => format!(" let {} = out_{} as i32;", col.field_name, col.field_name),
"int64" => format!(" let {} = out_{};", col.field_name, col.field_name),
"float32" => format!(" let {} = out_{} as f32;", col.field_name, col.field_name),
"float64" | "decimal" => {
format!(" let {} = out_{};", col.field_name, col.field_name)
}
"date" | "datetime" | "datetime_tz" => {
format!(
" let {name} = {{ let (y, mo, d, h, mi, s) = out_{name}.date_and_time(); chrono::NaiveDate::from_ymd_opt(y as i32, mo as u32, d as u32).and_then(|dt| dt.and_hms_opt(h as u32, mi as u32, s as u32)).expect(\"invalid date from Oracle\") }};",
name = col.field_name
)
}
_ => {
if col.nullable {
format!(
" let {name} = if stmt.is_null(\"{placeholder}\")? {{ None }} else {{ Some(out_{name}) }};",
name = col.field_name,
placeholder = Self::out_named_placeholder(&col.field_name)
)
} else {
format!(" let {} = out_{};", col.field_name, col.field_name)
}
}
}
}
fn emit_row_get(col: &ResolvedColumn, index: usize, indent: &str) -> String {
match col.neutral_type.as_str() {
"date" | "datetime" | "datetime_tz" => {
if col.nullable {
format!(
"{indent}let {name}: {ty} = row.get::<Option<Date<'_>>, _>({i})?.map(|d| {{ let (y, mo, d2, h, mi, s) = d.date_and_time(); chrono::NaiveDate::from_ymd_opt(y as i32, mo as u32, d2 as u32).and_then(|dt| dt.and_hms_opt(h as u32, mi as u32, s as u32)).expect(\"invalid date from Oracle\") }});",
indent = indent,
name = col.field_name,
i = index,
ty = col.full_type
)
} else {
format!(
"{indent}let {name}_date: Date<'_> = row.get({i})?;\n\
{indent}let {name}: {ty} = {{ let (y, mo, d, h, mi, s) = {name}_date.date_and_time(); chrono::NaiveDate::from_ymd_opt(y as i32, mo as u32, d as u32).and_then(|dt| dt.and_hms_opt(h as u32, mi as u32, s as u32)).expect(\"invalid date from Oracle\") }};",
indent = indent,
name = col.field_name,
i = index,
ty = col.full_type
)
}
}
_ => {
format!(
"{indent}let {name}: {ty} = row.get({i})?;",
indent = indent,
name = col.field_name,
i = index,
ty = col.full_type
)
}
}
}
}
impl CodegenBackend for RustSibylBackend {
fn name(&self) -> &str {
"rust-sibyl"
}
fn manifest(&self) -> &scythe_backend::manifest::BackendManifest {
&self.manifest
}
fn supported_engines(&self) -> &[&str] {
&["oracle"]
}
fn file_header(&self) -> String {
"// Auto-generated by scythe. Do not edit.\n\
use sibyl::*;\n"
.to_string()
}
fn generate_row_struct(&self, query_name: &str, columns: &[ResolvedColumn]) -> Result<String, ScytheError> {
let struct_name = row_struct_name(query_name, &self.manifest.naming);
let mut out = String::new();
let _ = writeln!(out, "#[derive(Debug, Clone)]");
let _ = writeln!(out, "pub struct {} {{", struct_name);
for col in columns {
let _ = writeln!(out, " pub {}: {},", col.field_name, col.full_type);
}
let _ = write!(out, "}}");
Ok(out)
}
fn generate_model_struct(&self, table_name: &str, columns: &[ResolvedColumn]) -> Result<String, ScytheError> {
let singular = singularize(table_name);
let name = to_pascal_case(&singular);
self.generate_row_struct(&name, columns)
}
fn generate_query_fn(
&self,
analyzed: &AnalyzedQuery,
struct_name: &str,
columns: &[ResolvedColumn],
params: &[ResolvedParam],
) -> Result<String, ScytheError> {
let func_name = fn_name(&analyzed.name, &self.manifest.naming);
let positional_sql = super::rewrite_pg_placeholders(
&super::clean_sql_with_optional(&analyzed.sql, &analyzed.optional_params, &analyzed.params),
|n| format!(":{n}"),
);
let sql = Self::sql_with_named_params(&positional_sql, params);
let param_list = params
.iter()
.map(|p| format!("{}: {}", p.field_name, p.borrowed_type))
.collect::<Vec<_>>()
.join(", ");
let sep = if param_list.is_empty() { "" } else { ", " };
let has_returning = sql.to_uppercase().contains("RETURNING");
let mut out = String::new();
match &analyzed.command {
QueryCommand::One | QueryCommand::Opt => {
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>{}{}) -> sibyl::Result<Option<{}>> {{",
func_name, sep, param_list, struct_name
);
if has_returning {
let full_sql = Self::sql_with_returning(&sql, columns);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", full_sql);
for col in columns {
let _ = writeln!(out, "{}", Self::emit_out_var_decl_typed(col));
}
let in_pairs: Vec<String> = params
.iter()
.map(|p| format!("(\"{}\", {})", Self::named_placeholder(&p.field_name), p.field_name))
.collect();
let out_pairs: Vec<String> = columns
.iter()
.map(|col| {
format!(
"(\"{}\", {})",
Self::out_named_placeholder(&col.field_name),
Self::out_var_ref_for_returning(col)
)
})
.collect();
let all_pairs: Vec<String> = in_pairs.into_iter().chain(out_pairs).collect();
let args_expr = if all_pairs.len() == 1 {
all_pairs[0].clone()
} else {
format!("({})", all_pairs.join(", "))
};
let _ = writeln!(out, " stmt.execute({}).await?;", args_expr);
for col in columns {
let _ = writeln!(out, "{}", Self::emit_out_var_conversion(col));
}
let field_assigns: Vec<String> = columns
.iter()
.map(|c| format!("{}: {}", c.field_name, c.field_name))
.collect();
let _ = writeln!(out, " Ok(Some({} {{ {} }}))", struct_name, field_assigns.join(", "));
let _ = write!(out, "}}");
} else {
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let args_expr = Self::build_in_args(params);
let _ = writeln!(out, " let rows = stmt.query({}).await?;", args_expr);
let _ = writeln!(out, " if let Some(row) = rows.next().await? {{");
for (i, col) in columns.iter().enumerate() {
let _ = writeln!(out, "{}", Self::emit_row_get(col, i, " "));
}
let field_assigns: Vec<String> = columns
.iter()
.map(|c| format!("{}: {}", c.field_name, c.field_name))
.collect();
let _ = writeln!(
out,
" Ok(Some({} {{ {} }}))",
struct_name,
field_assigns.join(", ")
);
let _ = writeln!(out, " }} else {{");
let _ = writeln!(out, " Ok(None)");
let _ = writeln!(out, " }}");
let _ = write!(out, "}}");
}
}
QueryCommand::Many => {
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>{}{}) -> sibyl::Result<Vec<{}>> {{",
func_name, sep, param_list, struct_name
);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let args_expr = Self::build_in_args(params);
let _ = writeln!(out, " let rows = stmt.query({}).await?;", args_expr);
let _ = writeln!(out, " let mut results = Vec::new();");
let _ = writeln!(out, " while let Some(row) = rows.next().await? {{");
for (i, col) in columns.iter().enumerate() {
let _ = writeln!(out, "{}", Self::emit_row_get(col, i, " "));
}
let field_assigns: Vec<String> = columns
.iter()
.map(|c| format!("{}: {}", c.field_name, c.field_name))
.collect();
let _ = writeln!(
out,
" results.push({} {{ {} }});",
struct_name,
field_assigns.join(", ")
);
let _ = writeln!(out, " }}");
let _ = writeln!(out, " Ok(results)");
let _ = write!(out, "}}");
}
QueryCommand::Exec => {
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>{}{}) -> sibyl::Result<()> {{",
func_name, sep, param_list
);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let args_expr = Self::build_in_args(params);
let _ = writeln!(out, " stmt.execute({}).await?;", args_expr);
let _ = writeln!(out, " Ok(())");
let _ = write!(out, "}}");
}
QueryCommand::ExecResult | QueryCommand::ExecRows => {
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>{}{}) -> sibyl::Result<usize> {{",
func_name, sep, param_list
);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let args_expr = Self::build_in_args(params);
let _ = writeln!(out, " let num_rows = stmt.execute({}).await?;", args_expr);
let _ = writeln!(out, " Ok(num_rows)");
let _ = write!(out, "}}");
}
QueryCommand::Batch => {
let batch_fn_name = format!("{}_batch", func_name);
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>, items: &[({})]) -> sibyl::Result<()> {{",
batch_fn_name,
params
.iter()
.map(|p| p.full_type.clone())
.collect::<Vec<_>>()
.join(", ")
);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let _ = writeln!(out, " for item in items {{");
let item_pairs: Vec<String> = params
.iter()
.enumerate()
.map(|(i, p)| format!("(\"{}\", &item.{})", Self::named_placeholder(&p.field_name), i))
.collect();
let args_expr = if item_pairs.len() == 1 {
item_pairs[0].clone()
} else {
format!("({})", item_pairs.join(", "))
};
let _ = writeln!(out, " stmt.execute({}).await?;", args_expr);
let _ = writeln!(out, " }}");
let _ = writeln!(out, " Ok(())");
let _ = write!(out, "}}");
}
QueryCommand::Grouped => unreachable!("grouped queries are routed to generate_grouped_query_fn"),
}
Ok(out)
}
fn generate_enum_def(&self, enum_info: &EnumInfo) -> Result<String, ScytheError> {
let type_name = enum_type_name(&enum_info.sql_name, &self.manifest.naming);
let mut out = String::new();
let _ = writeln!(out, "#[derive(Debug, Clone, PartialEq)]");
let _ = writeln!(out, "pub enum {} {{", type_name);
for value in &enum_info.values {
let variant = enum_variant_name(value, &self.manifest.naming);
let _ = writeln!(out, " {},", variant);
}
let _ = writeln!(out, "}}");
let _ = writeln!(out);
let _ = writeln!(out, "impl {} {{", type_name);
let _ = writeln!(out, " pub fn as_str(&self) -> &'static str {{");
let _ = writeln!(out, " match self {{");
for value in &enum_info.values {
let variant = enum_variant_name(value, &self.manifest.naming);
let _ = writeln!(out, " {}::{} => \"{}\",", type_name, variant, value);
}
let _ = writeln!(out, " }}");
let _ = writeln!(out, " }}");
let _ = write!(out, "}}");
Ok(out)
}
fn generate_grouped_structs(
&self,
parent_struct_name: &str,
child_struct_name: &str,
parent_columns: &[crate::backend_trait::ResolvedColumn],
child_columns: &[crate::backend_trait::ResolvedColumn],
_key_column: &str,
) -> Result<String, ScytheError> {
let mut out = String::new();
let _ = writeln!(out, "#[derive(Debug, Clone)]");
let _ = writeln!(out, "pub struct {} {{", child_struct_name);
for col in child_columns {
let _ = writeln!(out, " pub {}: {},", col.field_name, col.full_type);
}
let _ = writeln!(out, "}}");
let _ = writeln!(out);
let _ = writeln!(out, "#[derive(Debug, Clone)]");
let _ = writeln!(out, "pub struct {} {{", parent_struct_name);
for col in parent_columns {
let _ = writeln!(out, " pub {}: {},", col.field_name, col.full_type);
}
let _ = writeln!(out, " pub children: Vec<{}>,", child_struct_name);
let _ = write!(out, "}}");
Ok(out)
}
fn generate_grouped_query_fn(
&self,
request: &crate::backend_trait::GroupedQueryFn<'_>,
) -> Result<String, ScytheError> {
let analyzed = request.analyzed;
let parent_struct_name = request.parent_struct_name;
let child_struct_name = request.child_struct_name;
let parent_columns = request.parent_columns;
let child_columns = request.child_columns;
let params = request.params;
let key_column = request.key_column;
let func_name = fn_name(&analyzed.name, &self.manifest.naming);
let key_field = to_snake_case(key_column);
let mut out = String::new();
let positional_sql = super::rewrite_pg_placeholders(
&super::clean_sql_with_optional(&analyzed.sql, &analyzed.optional_params, &analyzed.params),
|n| format!(":{n}"),
);
let sql = Self::sql_with_named_params(&positional_sql, params);
let param_list = params
.iter()
.map(|p| format!("{}: {}", p.field_name, p.borrowed_type))
.collect::<Vec<_>>()
.join(", ");
let sep = if param_list.is_empty() { "" } else { ", " };
let args_expr = Self::build_in_args(params);
let _ = writeln!(
out,
"pub async fn {}<'a>(session: &'a Session<'a>{}{}) -> sibyl::Result<Vec<{}>> {{",
func_name, sep, param_list, parent_struct_name
);
let _ = writeln!(out, " let stmt = session.prepare(\"{}\").await?;", sql);
let _ = writeln!(out, " let rows = stmt.query({}).await?;", args_expr);
let _ = writeln!(out, " let mut result: Vec<{}> = Vec::new();", parent_struct_name);
let _ = writeln!(out, " while let Some(row) = rows.next().await? {{");
for (i, col) in parent_columns.iter().enumerate() {
let _ = writeln!(out, "{}", Self::emit_row_get(col, i, " "));
}
let _ = writeln!(out, " let key = {key_field}.clone();");
let parent_len = parent_columns.len();
for (j, col) in child_columns.iter().enumerate() {
let _ = writeln!(out, "{}", Self::emit_row_get(col, parent_len + j, " "));
}
let _ = writeln!(out, " let child = {} {{", child_struct_name);
for col in child_columns {
let _ = writeln!(out, " {},", col.field_name);
}
let _ = writeln!(out, " }};");
let _ = writeln!(
out,
" if let Some(parent) = result.iter_mut().rev().find(|p| p.{key_field} == key) {{"
);
let _ = writeln!(out, " parent.children.push(child);");
let _ = writeln!(out, " }} else {{");
let _ = writeln!(out, " result.push({} {{", parent_struct_name);
for col in parent_columns {
let _ = writeln!(out, " {},", col.field_name);
}
let _ = writeln!(out, " children: vec![child],");
let _ = writeln!(out, " }});");
let _ = writeln!(out, " }}");
let _ = writeln!(out, " }}");
let _ = writeln!(out, " Ok(result)");
let _ = write!(out, "}}");
Ok(out)
}
fn generate_composite_def(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
let name = to_pascal_case(&composite.sql_name);
let mut out = String::new();
let _ = writeln!(out, "#[derive(Debug, Clone)]");
let _ = writeln!(out, "pub struct {} {{", name);
for field in &composite.fields {
let rust_type = resolve_type(&field.neutral_type, &self.manifest, false)
.map(|t| t.into_owned())
.map_err(|e| {
ScytheError::new(ErrorCode::InternalError, format!("composite field type error: {}", e))
})?;
let _ = writeln!(out, " pub {}: {},", to_snake_case(&field.name), rust_type);
}
let _ = write!(out, "}}");
Ok(out)
}
}
#[cfg(test)]
mod tests {
use scythe_core::analyzer::{AnalyzedColumn, AnalyzedQuery, GroupByConfig};
use scythe_core::parser::QueryCommand;
use super::RustSibylBackend;
use crate::generate_with_backend;
fn make_grouped_query() -> AnalyzedQuery {
let parent_cols = vec![
AnalyzedColumn {
name: "id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
},
AnalyzedColumn {
name: "name".to_string(),
neutral_type: "string".to_string(),
nullable: false,
},
AnalyzedColumn {
name: "email".to_string(),
neutral_type: "string".to_string(),
nullable: false,
},
];
let child_cols = vec![
AnalyzedColumn {
name: "order_id".to_string(),
neutral_type: "int32".to_string(),
nullable: false,
},
AnalyzedColumn {
name: "total".to_string(),
neutral_type: "decimal".to_string(),
nullable: true,
},
AnalyzedColumn {
name: "order_date".to_string(),
neutral_type: "datetime".to_string(),
nullable: false,
},
];
let all_cols = [parent_cols.clone(), child_cols.clone()].concat();
AnalyzedQuery {
name: "GetUsersWithOrders".to_string(),
command: QueryCommand::Grouped,
sql: "-- @name GetUsersWithOrders\n-- @returns :grouped\n-- @group_by users.id\n\
SELECT u.id, u.name, u.email, o.id AS order_id, o.total, o.created_at AS order_date\n\
FROM users u\n\
JOIN orders o ON o.user_id = u.id"
.to_string(),
columns: all_cols,
params: vec![],
deprecated: None,
source_table: None,
composites: vec![],
enums: vec![],
optional_params: vec![],
group_by: Some(GroupByConfig {
table: "users".to_string(),
key_column: "id".to_string(),
parent_columns: parent_cols,
child_columns: child_cols,
}),
custom: vec![],
}
}
#[test]
fn test_grouped_sibyl_structs() {
let backend = RustSibylBackend::new("oracle").unwrap();
let query = make_grouped_query();
let result = generate_with_backend(&query, &backend).unwrap();
let row_struct = result.row_struct.as_deref().unwrap();
assert!(
row_struct.contains("pub struct GetUsersWithOrdersChildRow"),
"missing child struct; got:\n{row_struct}"
);
assert!(
row_struct.contains("pub order_id: i32"),
"child struct missing order_id; got:\n{row_struct}"
);
assert!(
row_struct.contains("pub struct GetUsersWithOrdersRow"),
"missing parent struct; got:\n{row_struct}"
);
assert!(
row_struct.contains("pub id: i32"),
"parent struct missing id; got:\n{row_struct}"
);
assert!(
row_struct.contains("pub name: String"),
"parent struct missing name; got:\n{row_struct}"
);
assert!(
row_struct.contains("pub children: Vec<GetUsersWithOrdersChildRow>"),
"parent struct missing children field; got:\n{row_struct}"
);
let child_pos = row_struct.find("GetUsersWithOrdersChildRow").unwrap();
let parent_pos = row_struct.find("pub struct GetUsersWithOrdersRow").unwrap();
assert!(child_pos < parent_pos, "child struct must appear before parent struct");
assert!(result.model_struct.is_none(), "grouped must not produce a model_struct");
}
#[test]
fn test_grouped_sibyl_query_fn() {
let backend = RustSibylBackend::new("oracle").unwrap();
let query = make_grouped_query();
let result = generate_with_backend(&query, &backend).unwrap();
let query_fn = result.query_fn.as_deref().unwrap();
assert!(
query_fn.contains("pub async fn get_users_with_orders<'a>(session: &'a Session<'a>)"),
"missing fn; got:\n{query_fn}"
);
assert!(
query_fn.contains("-> sibyl::Result<Vec<GetUsersWithOrdersRow>>"),
"wrong return type; got:\n{query_fn}"
);
assert!(
query_fn.contains("rows.next().await?"),
"fn must iterate rows; got:\n{query_fn}"
);
assert!(
query_fn.contains("GetUsersWithOrdersChildRow {"),
"fn must construct child struct; got:\n{query_fn}"
);
assert!(
query_fn.contains("children: vec![child]"),
"fn must initialize children vec; got:\n{query_fn}"
);
assert!(
query_fn.contains("parent.children.push(child)"),
"fn must fold child into existing parent; got:\n{query_fn}"
);
assert!(
query_fn.contains("Ok(result)"),
"fn must return result; got:\n{query_fn}"
);
}
}