olai-store 0.0.6

Generic, TAO-inspired object and association store with field-role enforcement
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

use serde::{Deserialize, Serialize};
use uuid::Uuid;

use crate::label::Label;
use crate::name::ResourceName;

/// A generic resource object stored in the graph.
///
/// This is the untyped interchange format between the store backend and typed
/// resource wrappers. The `label` discriminant identifies the resource type,
/// and `properties` holds the serialized resource fields as JSON.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
pub struct Object<L: Label> {
    /// The globally unique identifier of the object.
    pub id: Uuid,

    /// The label / type of the object.
    pub label: L,

    /// The namespaced name of the object.
    pub name: ResourceName,

    /// The properties of the object (serialized resource fields).
    pub properties: Option<serde_json::Value>,

    /// Monotonic version, bumped on every mutating operation.
    ///
    /// Serves as an opaque optimistic-concurrency token (an etag): pass the
    /// version observed on a read back in a [`Precondition::Version`] to perform
    /// a compare-and-swap. A fresh object starts at version `0`; each successful
    /// [`update`](crate::ObjectStore::update) or [`rename`](crate::ObjectStore::rename)
    /// increments it.
    ///
    /// [`Precondition::Version`]: crate::Precondition::Version
    pub version: u64,

    /// The time when the object was created.
    pub created_at: chrono::DateTime<chrono::Utc>,

    /// The time when the object was last updated.
    pub updated_at: Option<chrono::DateTime<chrono::Utc>>,
}

/// An association (edge) between two objects in the graph.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Association<L: Label> {
    /// Unique identifier for this association.
    pub id: Uuid,

    /// The source object identifier.
    pub from_id: Uuid,

    /// The label of this association edge.
    pub label: String,

    /// The target object identifier.
    pub to_id: Uuid,

    /// The label of the target object (denormalized for efficient queries).
    pub to_label: L,

    /// Optional properties on the association.
    pub properties: Option<serde_json::Value>,

    /// The time when the association was created.
    pub created_at: chrono::DateTime<chrono::Utc>,

    /// The time when the association was last updated.
    pub updated_at: Option<chrono::DateTime<chrono::Utc>>,
}