axion-db 0.0.2

Database functionality for the axion framework
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
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

// axion-db/src/metadata.rs
use serde::{Deserialize, Serialize};
use std::collections::HashMap; // Added this

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct ColumnMetadata {
    pub name: String,
    pub ordinal_position: i32,
    pub sql_type_name: String, // Raw SQL type name (e.g., "VARCHAR", "INTEGER", "character varying")
    pub udt_name: Option<String>, // User-defined type name from `information_schema.columns.udt_name`
    // This is often more specific for enums, domains, composites in Postgres.
    pub internal_axion_type: String, // Axion's standardized internal type name
    pub rust_type_string: String,    // Suggested Rust type as a string
    pub is_nullable: bool,
    pub is_primary_key: bool,
    pub is_unique: bool,
    pub default_value: Option<String>,
    pub foreign_key_reference: Option<ForeignKeyReference>,
    pub character_maximum_length: Option<i32>,
    pub numeric_precision: Option<i32>,
    pub numeric_scale: Option<i32>,
    pub comment: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ForeignKeyReference {
    pub foreign_table_schema: String,
    pub foreign_table_name: String,
    pub foreign_column_name: String,
    // Could add local_column_name if needed, but often implied by ColumnMetadata
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct TableMetadata {
    pub schema: String,
    pub name: String,
    pub columns: Vec<ColumnMetadata>,
    pub primary_key_columns: Vec<String>,
    pub comment: Option<String>,
    // pub foreign_keys: Vec<ForeignKeyConstraintMeta>, // More detailed later
    // pub unique_constraints: Vec<UniqueConstraintMeta>,
    // pub indexes: Vec<IndexMeta>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct ViewMetadata {
    pub schema: String,
    pub name: String,
    pub definition: Option<String>,
    pub columns: Vec<ColumnMetadata>,
    pub comment: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum ParameterMode {
    In,
    Out,
    InOut,
    Variadic,
}

impl Default for ParameterMode {
    fn default() -> Self {
        ParameterMode::In
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct ParameterMetadata {
    pub name: String,
    pub sql_type_name: String,
    pub udt_name: Option<String>,
    pub internal_axion_type: String,
    pub rust_type_string: String,
    pub mode: ParameterMode,
    pub ordinal_position: i32,
    pub has_default: bool,
    pub default_value: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum FunctionKind {
    Scalar,
    Table,
    Aggregate,
    Window,
    Procedure, // Added to distinguish
    Trigger,   // Added to distinguish
}

impl Default for FunctionKind {
    fn default() -> Self {
        FunctionKind::Scalar
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct FunctionMetadata {
    pub schema: String,
    pub name: String,
    pub parameters: Vec<ParameterMetadata>,
    pub return_sql_type_name: String,
    pub return_udt_name: Option<String>,
    pub return_internal_axion_type: String,
    pub return_rust_type_string: String,
    pub kind: FunctionKind,
    pub definition: Option<String>,
    pub comment: Option<String>,
    pub is_strict: Option<bool>,    // Specific to Postgres
    pub volatility: Option<String>, // Specific to Postgres (VOLATILE, STABLE, IMMUTABLE)
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct EnumValueMetadata {
    pub value: String,
    pub sort_order: Option<i32>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
pub struct EnumMetadata {
    pub schema: String,
    pub name: String,
    pub values: Vec<EnumValueMetadata>,
    pub comment: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct SchemaMetadata {
    pub name: String,
    pub tables: HashMap<String, TableMetadata>,
    pub views: HashMap<String, ViewMetadata>,
    pub functions: HashMap<String, FunctionMetadata>, // Includes procedures and triggers for now
    pub enums: HashMap<String, EnumMetadata>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct DatabaseMetadata {
    pub schemas: HashMap<String, SchemaMetadata>,
}