odcs 0.8.0

Reference implementation of the Open Data Contract Standard (ODCS)
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

//! Schema object and property types.

use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::quality::DataQualityChecks;
use super::relationships::{RelationshipPropertyLevel, RelationshipSchemaLevel};
use super::shared::SchemaElement;

/// A schema object describing a dataset within a data contract.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct SchemaObject {
    #[serde(flatten)]
    pub element: SchemaElement,
    /// Logical type for schema objects is always `object`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logical_type: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub physical_name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub data_granularity_description: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub properties: Vec<SchemaProperty>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub relationships: Vec<RelationshipSchemaLevel>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub quality: Option<DataQualityChecks>,
}

/// A field definition within a schema object.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct SchemaProperty {
    #[serde(flatten)]
    pub element: SchemaElement,
    #[serde(default, skip_serializing_if = "is_false")]
    pub primary_key: bool,
    #[serde(
        default = "default_negative_one",
        skip_serializing_if = "is_default_position"
    )]
    pub primary_key_position: i32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logical_type: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub logical_type_options: Option<Value>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub physical_name: Option<String>,
    #[serde(default, skip_serializing_if = "is_false")]
    pub required: bool,
    #[serde(default, skip_serializing_if = "is_false")]
    pub unique: bool,
    #[serde(default, skip_serializing_if = "is_false")]
    pub partitioned: bool,
    #[serde(
        default = "default_negative_one",
        skip_serializing_if = "is_default_position"
    )]
    pub partition_key_position: i32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub classification: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub encrypted_name: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub transform_source_objects: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub transform_logic: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub transform_description: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub examples: Vec<Value>,
    #[serde(default, skip_serializing_if = "is_false")]
    pub critical_data_element: bool,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub relationships: Vec<RelationshipPropertyLevel>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub quality: Option<DataQualityChecks>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub properties: Vec<SchemaProperty>,
    /// Item schema for `logicalType: array` properties.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub items: Option<Box<SchemaProperty>>,
}

const fn default_negative_one() -> i32 {
    -1
}

fn is_false(value: &bool) -> bool {
    !*value
}

fn is_default_position(value: &i32) -> bool {
    *value == -1
}

impl SchemaObject {
    /// Returns the schema object name.
    #[must_use]
    pub fn name(&self) -> Option<&str> {
        self.element.name.as_deref()
    }
}

impl SchemaProperty {
    /// Returns the property name.
    #[must_use]
    pub fn name(&self) -> Option<&str> {
        self.element.name.as_deref()
    }
}

// Backward-compatible alias used by earlier phases.
pub type Field = SchemaProperty;