datasynth-graph 2.5.0

Graph/network export for synthetic accounting data - supports PyTorch Geometric, Neo4j, and DGL formats
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
//! Neo4j exporter.
//!
//! Exports graph data in formats compatible with Neo4j import:
//! - CSV files for nodes and edges (neo4j-admin import format)
//! - Cypher script for direct loading

use std::collections::HashMap;
use std::fs::{self, File};
use std::io::{BufWriter, Write};
use std::path::Path;

use serde::{Deserialize, Serialize};

use crate::models::Graph;

/// Configuration for Neo4j export.
#[derive(Debug, Clone)]
pub struct Neo4jExportConfig {
    /// Export node properties.
    pub export_node_properties: bool,
    /// Export edge properties.
    pub export_edge_properties: bool,
    /// Export features as properties.
    pub export_features: bool,
    /// Generate Cypher import script.
    pub generate_cypher: bool,
    /// Generate neo4j-admin import script.
    pub generate_admin_import: bool,
    /// Database name for Cypher.
    pub database_name: String,
    /// Batch size for Cypher imports.
    pub cypher_batch_size: usize,
}

impl Default for Neo4jExportConfig {
    fn default() -> Self {
        Self {
            export_node_properties: true,
            export_edge_properties: true,
            export_features: true,
            generate_cypher: true,
            generate_admin_import: true,
            database_name: "synth".to_string(),
            cypher_batch_size: 1000,
        }
    }
}

/// Metadata about the exported Neo4j data.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Neo4jMetadata {
    /// Graph name.
    pub name: String,
    /// Number of nodes.
    pub num_nodes: usize,
    /// Number of edges.
    pub num_edges: usize,
    /// Node labels (types).
    pub node_labels: Vec<String>,
    /// Relationship types.
    pub relationship_types: Vec<String>,
    /// Files included in export.
    pub files: Vec<String>,
}

/// Neo4j exporter.
pub struct Neo4jExporter {
    config: Neo4jExportConfig,
}

impl Neo4jExporter {
    /// Creates a new Neo4j exporter.
    pub fn new(config: Neo4jExportConfig) -> Self {
        Self { config }
    }

    /// Exports a graph to Neo4j format.
    pub fn export(&self, graph: &Graph, output_dir: &Path) -> std::io::Result<Neo4jMetadata> {
        fs::create_dir_all(output_dir)?;

        let mut files = Vec::new();

        // Export nodes by type
        let node_labels = self.export_nodes(graph, output_dir, &mut files)?;

        // Export edges by type
        let relationship_types = self.export_edges(graph, output_dir, &mut files)?;

        // Generate Cypher script
        if self.config.generate_cypher {
            self.generate_cypher_script(graph, output_dir, &node_labels, &relationship_types)?;
            files.push("import.cypher".to_string());
        }

        // Generate neo4j-admin import script
        if self.config.generate_admin_import {
            self.generate_admin_import_script(output_dir, &node_labels, &relationship_types)?;
            files.push("admin_import.sh".to_string());
        }

        // Create metadata
        let metadata = Neo4jMetadata {
            name: graph.name.clone(),
            num_nodes: graph.node_count(),
            num_edges: graph.edge_count(),
            node_labels,
            relationship_types,
            files,
        };

        // Write metadata
        let metadata_path = output_dir.join("metadata.json");
        let file = File::create(metadata_path)?;
        serde_json::to_writer_pretty(file, &metadata)?;

        Ok(metadata)
    }

    /// Exports nodes grouped by type.
    fn export_nodes(
        &self,
        graph: &Graph,
        output_dir: &Path,
        files: &mut Vec<String>,
    ) -> std::io::Result<Vec<String>> {
        let mut labels = Vec::new();

        for (node_type, node_ids) in &graph.nodes_by_type {
            let label = node_type.as_str();
            labels.push(label.to_string());

            let filename = format!("nodes_{}.csv", label.to_lowercase());
            let path = output_dir.join(&filename);
            files.push(filename);

            let file = File::create(path)?;
            let mut writer = BufWriter::with_capacity(256 * 1024, file);

            // Determine properties from first node
            let sample_node = node_ids.first().and_then(|id| graph.nodes.get(id));

            // Write header
            let mut header = vec![
                "nodeId:ID".to_string(),
                "code".to_string(),
                "name".to_string(),
            ];

            if self.config.export_node_properties {
                if let Some(node) = sample_node {
                    for key in node.properties.keys() {
                        header.push(key.clone());
                    }
                }
            }

            if self.config.export_features {
                if let Some(node) = sample_node {
                    for i in 0..node.features.len() {
                        header.push(format!("feature_{i}"));
                    }
                }
            }

            header.push("isAnomaly:boolean".to_string());
            header.push(":LABEL".to_string());

            writeln!(writer, "{}", header.join(","))?;

            // Write nodes
            for &node_id in node_ids {
                if let Some(node) = graph.nodes.get(&node_id) {
                    let mut row = vec![
                        node_id.to_string(),
                        escape_csv(&node.external_id),
                        escape_csv(&node.label),
                    ];

                    if self.config.export_node_properties {
                        for key in &header[3..] {
                            if key.starts_with("feature_")
                                || key == "isAnomaly:boolean"
                                || key == ":LABEL"
                            {
                                break;
                            }
                            let value = node
                                .properties
                                .get(key)
                                .map(|p| p.to_string_value())
                                .unwrap_or_default();
                            row.push(escape_csv(&value));
                        }
                    }

                    if self.config.export_features {
                        for &feat in &node.features {
                            row.push(format!("{feat:.6}"));
                        }
                    }

                    row.push(node.is_anomaly.to_string());
                    row.push(label.to_string());

                    writeln!(writer, "{}", row.join(","))?;
                }
            }
        }

        Ok(labels)
    }

    /// Exports edges grouped by type.
    fn export_edges(
        &self,
        graph: &Graph,
        output_dir: &Path,
        files: &mut Vec<String>,
    ) -> std::io::Result<Vec<String>> {
        let mut rel_types = Vec::new();

        for (edge_type, edge_ids) in &graph.edges_by_type {
            let rel_type = edge_type.as_str();
            rel_types.push(rel_type.to_string());

            let filename = format!("edges_{}.csv", rel_type.to_lowercase());
            let path = output_dir.join(&filename);
            files.push(filename);

            let file = File::create(path)?;
            let mut writer = BufWriter::with_capacity(256 * 1024, file);

            // Determine properties from first edge
            let sample_edge = edge_ids.first().and_then(|id| graph.edges.get(id));

            // Write header
            let mut header = vec![
                ":START_ID".to_string(),
                ":END_ID".to_string(),
                "weight:double".to_string(),
            ];

            if self.config.export_edge_properties {
                if let Some(edge) = sample_edge {
                    for key in edge.properties.keys() {
                        header.push(format!("{key}:string"));
                    }
                }
            }

            if self.config.export_features {
                if let Some(edge) = sample_edge {
                    for i in 0..edge.features.len() {
                        header.push(format!("feature_{i}:double"));
                    }
                }
            }

            header.push("isAnomaly:boolean".to_string());
            header.push(":TYPE".to_string());

            writeln!(writer, "{}", header.join(","))?;

            // Write edges
            for &edge_id in edge_ids {
                if let Some(edge) = graph.edges.get(&edge_id) {
                    let mut row = vec![
                        edge.source.to_string(),
                        edge.target.to_string(),
                        format!("{:.6}", edge.weight),
                    ];

                    if self.config.export_edge_properties {
                        for (key, value) in &edge.properties {
                            if !header.iter().any(|h| h.starts_with(key)) {
                                continue;
                            }
                            row.push(escape_csv(&value.to_string_value()));
                        }
                    }

                    if self.config.export_features {
                        for &feat in &edge.features {
                            row.push(format!("{feat:.6}"));
                        }
                    }

                    row.push(edge.is_anomaly.to_string());
                    row.push(rel_type.to_string());

                    writeln!(writer, "{}", row.join(","))?;
                }
            }
        }

        Ok(rel_types)
    }

    /// Generates Cypher import script.
    fn generate_cypher_script(
        &self,
        graph: &Graph,
        output_dir: &Path,
        node_labels: &[String],
        relationship_types: &[String],
    ) -> std::io::Result<()> {
        let path = output_dir.join("import.cypher");
        let file = File::create(path)?;
        let mut writer = BufWriter::with_capacity(256 * 1024, file);

        writeln!(writer, "// Neo4j Import Script for {}", graph.name)?;
        writeln!(writer, "// Generated by synth-graph")?;
        writeln!(writer)?;

        // Create constraints
        writeln!(writer, "// Create constraints and indexes")?;
        for label in node_labels {
            writeln!(
                writer,
                "CREATE CONSTRAINT IF NOT EXISTS FOR (n:{label}) REQUIRE n.nodeId IS UNIQUE;"
            )?;
        }
        writeln!(writer)?;

        // Import nodes using LOAD CSV
        writeln!(writer, "// Import nodes")?;
        for label in node_labels {
            let filename = format!("nodes_{}.csv", label.to_lowercase());
            writeln!(writer, "LOAD CSV WITH HEADERS FROM 'file:///{filename}'")?;
            writeln!(writer, "AS row")?;
            writeln!(
                writer,
                "CREATE (n:{label} {{nodeId: toInteger(row.`nodeId:ID`), code: row.code, name: row.name, isAnomaly: toBoolean(row.`isAnomaly:boolean`)}});"
            )?;
            writeln!(writer)?;
        }

        // Import edges using LOAD CSV
        writeln!(writer, "// Import relationships")?;
        for rel_type in relationship_types {
            let filename = format!("edges_{}.csv", rel_type.to_lowercase());
            writeln!(writer, "LOAD CSV WITH HEADERS FROM 'file:///{filename}'")?;
            writeln!(writer, "AS row")?;
            writeln!(
                writer,
                "MATCH (source) WHERE source.nodeId = toInteger(row.`:START_ID`)"
            )?;
            writeln!(
                writer,
                "MATCH (target) WHERE target.nodeId = toInteger(row.`:END_ID`)"
            )?;
            writeln!(
                writer,
                "CREATE (source)-[:{}{{weight: toFloat(row.`weight:double`), isAnomaly: toBoolean(row.`isAnomaly:boolean`)}}]->(target);",
                rel_type.to_uppercase().replace("-", "_")
            )?;
            writeln!(writer)?;
        }

        // Summary query
        writeln!(writer, "// Verification query")?;
        writeln!(writer, "CALL db.labels() YIELD label")?;
        writeln!(
            writer,
            "CALL apoc.cypher.run('MATCH (n:`' + label + '`) RETURN count(n) as count', {{}})"
        )?;
        writeln!(writer, "YIELD value")?;
        writeln!(writer, "RETURN label, value.count as nodeCount;")?;

        Ok(())
    }

    /// Generates neo4j-admin import script.
    fn generate_admin_import_script(
        &self,
        output_dir: &Path,
        node_labels: &[String],
        relationship_types: &[String],
    ) -> std::io::Result<()> {
        let path = output_dir.join("admin_import.sh");
        let file = File::create(path)?;
        let mut writer = BufWriter::with_capacity(256 * 1024, file);

        writeln!(writer, "#!/bin/bash")?;
        writeln!(writer, "# Neo4j Admin Import Script")?;
        writeln!(writer, "# Generated by synth-graph")?;
        writeln!(writer)?;
        writeln!(writer, "# Set Neo4j home directory")?;
        writeln!(writer, "NEO4J_HOME=${{NEO4J_HOME:-/var/lib/neo4j}}")?;
        writeln!(writer, "DATA_DIR=${{DATA_DIR:-$(dirname $0)}}")?;
        writeln!(writer)?;
        writeln!(writer, "# Stop Neo4j if running")?;
        writeln!(writer, "# systemctl stop neo4j")?;
        writeln!(writer)?;
        writeln!(writer, "# Run import")?;
        writeln!(writer, "neo4j-admin database import full \\")?;
        writeln!(writer, "  --overwrite-destination=true \\")?;
        writeln!(writer, "  --database={} \\", self.config.database_name)?;

        // Add node files
        for label in node_labels {
            let filename = format!("nodes_{}.csv", label.to_lowercase());
            writeln!(writer, "  --nodes={label}=$DATA_DIR/{filename} \\")?;
        }

        // Add relationship files
        for rel_type in relationship_types {
            let filename = format!("edges_{}.csv", rel_type.to_lowercase());
            writeln!(
                writer,
                "  --relationships={}=$DATA_DIR/{} \\",
                rel_type.to_uppercase().replace("-", "_"),
                filename
            )?;
        }

        writeln!(writer, "  --skip-bad-relationships=true")?;
        writeln!(writer)?;
        writeln!(writer, "echo \"Import complete\"")?;
        writeln!(writer)?;
        writeln!(writer, "# Start Neo4j")?;
        writeln!(writer, "# systemctl start neo4j")?;

        Ok(())
    }
}

/// Escapes a value for CSV format.
fn escape_csv(value: &str) -> String {
    if value.contains(',') || value.contains('"') || value.contains('\n') {
        format!("\"{}\"", value.replace('"', "\"\""))
    } else {
        value.to_string()
    }
}

/// Builder for Cypher queries.
pub struct CypherQueryBuilder {
    queries: Vec<String>,
}

impl CypherQueryBuilder {
    /// Creates a new query builder.
    pub fn new() -> Self {
        Self {
            queries: Vec::new(),
        }
    }

    /// Adds a node creation query.
    pub fn create_node(&mut self, label: &str, properties: &HashMap<String, String>) -> &mut Self {
        let props: Vec<String> = properties
            .iter()
            .map(|(k, v)| format!("{}: '{}'", k, v.replace('\'', "\\'")))
            .collect();

        self.queries
            .push(format!("CREATE (:{} {{{}}})", label, props.join(", ")));
        self
    }

    /// Adds a relationship creation query.
    pub fn create_relationship(
        &mut self,
        from_label: &str,
        from_id: &str,
        to_label: &str,
        to_id: &str,
        rel_type: &str,
        properties: &HashMap<String, String>,
    ) -> &mut Self {
        let props: Vec<String> = properties
            .iter()
            .map(|(k, v)| format!("{}: '{}'", k, v.replace('\'', "\\'")))
            .collect();

        let props_str = if props.is_empty() {
            String::new()
        } else {
            format!(" {{{}}}", props.join(", "))
        };

        self.queries.push(format!(
            "MATCH (a:{from_label} {{nodeId: '{from_id}'}}), (b:{to_label} {{nodeId: '{to_id}'}}) CREATE (a)-[:{rel_type}{props_str}]->(b)"
        ));
        self
    }

    /// Builds the final Cypher script.
    pub fn build(&self) -> String {
        self.queries.join(";\n") + ";"
    }
}

impl Default for CypherQueryBuilder {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use super::*;
    use crate::test_helpers::create_test_graph;
    use tempfile::tempdir;

    #[test]
    fn test_neo4j_export() {
        let graph = create_test_graph();
        let dir = tempdir().unwrap();

        let exporter = Neo4jExporter::new(Neo4jExportConfig::default());
        let metadata = exporter.export(&graph, dir.path()).unwrap();

        assert_eq!(metadata.num_nodes, 2);
        assert_eq!(metadata.num_edges, 1);
        assert!(dir.path().join("nodes_account.csv").exists());
        assert!(dir.path().join("edges_transaction.csv").exists());
        assert!(dir.path().join("import.cypher").exists());
        assert!(dir.path().join("admin_import.sh").exists());
    }

    #[test]
    fn test_csv_escape() {
        assert_eq!(escape_csv("simple"), "simple");
        assert_eq!(escape_csv("with,comma"), "\"with,comma\"");
        assert_eq!(escape_csv("with\"quote"), "\"with\"\"quote\"");
    }

    #[test]
    fn test_cypher_builder() {
        let mut builder = CypherQueryBuilder::new();
        let mut props = HashMap::new();
        props.insert("name".to_string(), "Test".to_string());

        builder.create_node("Account", &props);
        let cypher = builder.build();

        assert!(cypher.contains("CREATE (:Account"));
        assert!(cypher.contains("name: 'Test'"));
    }
}