graphar 0.1.1

Apache GraphAr format reader/writer
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

use serde::{Deserialize, Serialize};
use std::path::PathBuf;

use crate::{
    error::{GraphArError, Result},
    metadata::property::PropertyGroup,
};

pub const DEFAULT_VERTEX_CHUNK_SIZE: u64 = 262_144; // 2^18
pub const GAR_VERSION: &str = "gar/v1";

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VertexInfo {
    /// Vertex type label.
    #[serde(rename = "type")]
    pub vertex_type: String,
    #[serde(default = "default_vertex_chunk_size")]
    pub chunk_size: u64,
    /// Relative path prefix for data files.
    pub prefix: String,
    #[serde(default)]
    pub property_groups: Vec<PropertyGroup>,
    #[serde(default = "default_version")]
    pub version: String,
}

fn default_vertex_chunk_size() -> u64 {
    DEFAULT_VERTEX_CHUNK_SIZE
}

pub fn default_version() -> String {
    GAR_VERSION.to_string()
}

impl VertexInfo {
    pub fn new(vertex_type: impl Into<String>, chunk_size: u64) -> Self {
        let vertex_type = vertex_type.into();
        let prefix = format!("vertex/{}/", vertex_type);
        Self {
            vertex_type,
            chunk_size,
            prefix,
            property_groups: Vec::new(),
            version: GAR_VERSION.to_string(),
        }
    }

    pub fn with_property_group(mut self, group: PropertyGroup) -> Self {
        self.property_groups.push(group);
        self
    }

    /// Number of chunks needed for `vertex_count` vertices.
    pub fn chunk_count(&self, vertex_count: u64) -> u64 {
        vertex_count.div_ceil(self.chunk_size)
    }

    /// Path to a specific vertex property chunk file (no leading slash).
    pub fn chunk_path(&self, group: &PropertyGroup, chunk_index: u64) -> PathBuf {
        PathBuf::from(&self.prefix)
            .join(group.dir_name())
            .join(format!(
                "chunk{}.{}",
                chunk_index,
                group.file_type.extension()
            ))
    }

    pub fn find_property_group(&self, property_name: &str) -> Option<&PropertyGroup> {
        self.property_groups
            .iter()
            .find(|g| g.has_property(property_name))
    }

    pub fn primary_key_group(&self) -> Option<&PropertyGroup> {
        self.property_groups
            .iter()
            .find(|g| g.primary_key().is_some())
    }

    pub fn load(path: impl AsRef<std::path::Path>) -> Result<Self> {
        let content = std::fs::read_to_string(path)?;
        Ok(serde_yaml::from_str(&content)?)
    }

    pub fn save(&self, path: impl AsRef<std::path::Path>) -> Result<()> {
        let content = serde_yaml::to_string(self)?;
        std::fs::write(path, content)?;
        Ok(())
    }

    pub fn validate(&self) -> Result<()> {
        if self.vertex_type.is_empty() {
            return Err(GraphArError::Other("vertex type must not be empty".into()));
        }
        if self.chunk_size == 0 {
            return Err(GraphArError::Other("chunk_size must be > 0".into()));
        }
        if self.version != GAR_VERSION {
            return Err(GraphArError::InvalidVersion(self.version.clone()));
        }
        Ok(())
    }
}