selene-db-gql 1.3.0

ISO/IEC 39075:2024 GQL parser, planner, optimizer, and executor for selene-db.
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

//! Metadata builders shared by the native `algo.*` procedure definitions.
//!
//! These mirror the historical pack's `parameter` / `output` helpers plus its
//! `external_parameter` / `external_output_column` conversion: a nullable
//! parameter carries the `"NULL (use procedure default)"` default-doc and every
//! parameter / column carries the same boilerplate description the pack emitted.
//! Current catalog rendering is owned by the engine-level `SHOW PROCEDURES`
//! renderer.

use selene_core::db_string;

use crate::{GqlType, ProcedureOutputColumn, ProcedureParameter};

/// Build a procedure parameter, attaching the pack-era default-doc for nullable
/// (optional) parameters.
///
/// # Panics
///
/// Panics only if a static parameter name exceeds the per-string byte cap
/// (IL013). Procedure metadata is a fixed, short, source-owned name set.
pub(super) fn parameter(name: &'static str, ty: GqlType, nullable: bool) -> ProcedureParameter {
    let parameter = ProcedureParameter::new(static_db_string(name), ty, nullable)
        .with_description("Procedure parameter.");
    if nullable {
        parameter.with_default_doc("NULL (use procedure default)")
    } else {
        parameter
    }
}

/// Build a procedure output column with the pack-era boilerplate description.
pub(super) fn output(name: &'static str, ty: GqlType) -> ProcedureOutputColumn {
    ProcedureOutputColumn::new(static_db_string(name), ty)
        .with_description("Procedure output column.")
}

fn static_db_string(value: &'static str) -> selene_core::DbString {
    db_string(value).expect("static procedure metadata name fits DB string cap")
}