graphfusion 0.1.1

GraphFusion graph database.
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
use datafusion::parquet::arrow::ArrowWriter;
use graphfusion::arrow::{
    array::{ArrayRef, StringArray, UInt64Array},
    datatypes::{DataType, Field, Schema},
    record_batch::RecordBatch,
};
use std::{
    fs,
    path::{Path, PathBuf},
    process::{Command, Output},
    sync::Arc,
};

struct Fixture(PathBuf);
impl Fixture {
    fn new() -> Self {
        static NEXT: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
        let path = std::env::temp_dir().join(format!(
            "graphfusion-cli {} % # [data] * ? [ {}-{}",
            std::process::id(),
            std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_nanos(),
            NEXT.fetch_add(1, std::sync::atomic::Ordering::Relaxed)
        ));
        fs::create_dir(&path).unwrap();
        let nodes = Self::batch(
            &["__gf_id", "name"],
            vec![
                Arc::new(UInt64Array::from(vec![1, 2, 3])),
                Arc::new(StringArray::from(vec!["Alice", "Bob", "Cara"])),
            ],
        );
        let edges = Self::batch(
            &["__gf_id", "__gf_source", "__gf_destination"],
            vec![
                Arc::new(UInt64Array::from(vec![10, 11])),
                Arc::new(UInt64Array::from(vec![1, 2])),
                Arc::new(UInt64Array::from(vec![2, 3])),
            ],
        );
        for (name, batch) in [("nodes.parquet", nodes), ("edges.parquet", edges)] {
            let mut writer = ArrowWriter::try_new(
                fs::File::create(path.join(name)).unwrap(),
                batch.schema(),
                None,
            )
            .unwrap();
            writer.write(&batch).unwrap();
            writer.close().unwrap();
        }
        fs::write(path.join("import.json"), r#"{"nodes":[{"labels":["Person","Named"],"file":"nodes.parquet"}],"edges":[{"labels":["Knows"],"directed":true,"file":"edges.parquet"}]}"#).unwrap();
        Self(path)
    }
    fn batch(names: &[&str], arrays: Vec<ArrayRef>) -> RecordBatch {
        let schema = Arc::new(Schema::new(
            names
                .iter()
                .zip(&arrays)
                .map(|(name, a)| Field::new(*name, a.data_type().clone(), false))
                .collect::<Vec<_>>(),
        ));
        RecordBatch::try_new(schema, arrays).unwrap()
    }
    fn invoke(&self, command: &str, args: &[&str]) -> Output {
        Command::new(env!("CARGO_BIN_EXE_graphfusion"))
            .arg(command)
            .arg("--database")
            .arg(self.0.join("db"))
            .args(args)
            .current_dir(&self.0)
            .output()
            .unwrap()
    }
    fn run(&self, command: &str, args: &[&str]) -> String {
        let output = self.invoke(command, args);
        assert!(
            output.status.success(),
            "{}",
            String::from_utf8_lossy(&output.stderr)
        );
        String::from_utf8(output.stdout).unwrap()
    }
}
impl Drop for Fixture {
    fn drop(&mut self) {
        let _ = fs::remove_dir_all(&self.0);
    }
}

#[test]
fn cli_recursive_paths_use_parquet_after_independent_process_reopen() {
    let fixture = Fixture::new();
    fixture.run(
        "run",
        &["--create", "--query", include_str!("fixtures/paths.gql")],
    );
    fixture.run("checkpoint", &[]);
    let query = "USE GRAPH routes MATCH p = ALL SHORTEST (a {name:'A'})-[:Link]->{1,4}(b {name:'D'}) RETURN COUNT(*) AS ties, MIN(PATH_LENGTH(p)) AS hops";
    let output = fixture.run("run", &["--query", query, "--explain"]);
    assert!(output.contains("RecursiveQueryExec"), "{output}");
    assert!(output.contains("WorkTableExec"), "{output}");
    assert!(output.contains("file_type=parquet"), "{output}");
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(compact.contains("|2|2|"), "{output}");
    let output = fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH routes MATCH p = (a {name:'A'})-[:Link]->{0,2}(b) RETURN COUNT(*) AS paths",
        ],
    );
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(compact.contains("|5|"), "{output}");
}

#[test]
fn cli_reference_lookups_and_mutations_survive_parquet_restart() {
    let fixture = Fixture::new();
    fixture.run(
        "run",
        &[
            "--create",
            "--query",
            include_str!("fixtures/element-references.gql"),
        ],
    );
    fixture.run("checkpoint", &[]);
    let query="USE GRAPH routes MATCH p=(a {name:'A'})-[:Link]->{2}(c) FOR item IN ELEMENTS(p) WITH ORDINALITY i RETURN i,item.name AS name,item IS LABELED Station AS station ORDER BY i";
    let output = fixture.run("run", &["--query", query, "--explain"]);
    assert!(output.contains("file_type=parquet"), "{output}");
    assert!(output.contains("HashJoinExec"), "{output}");
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    for row in [
        "|1|A|true|",
        "|2|AB|false|",
        "|3|B|true|",
        "|4|BC|false|",
        "|5|C|true|",
    ] {
        assert!(compact.contains(row), "{output}");
    }
    let output=fixture.run("run", &["--query","USE GRAPH routes MATCH (n) LET r=n RETURN r.name AS name,r.visits AS visits ORDER BY name"]);
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    for row in ["|A|0|", "|B|1|", "|C|1|"] {
        assert!(compact.contains(row), "{output}");
    }
}

#[test]
fn cli_complex_patterns_and_unbounded_shortest_survive_parquet_restart() {
    let fixture = Fixture::new();
    fixture.run(
        "run",
        &[
            "--create",
            "--query",
            include_str!("fixtures/path-patterns.gql"),
        ],
    );
    fixture.run("checkpoint", &[]);
    let query = "USE GRAPH routes MATCH p = (a {name:'A'})((x)-[edges:Link]->(y)){0,2}(b) RETURN COUNT(*) AS paths, MAX(PATH_LENGTH(p)) AS longest";
    let output = fixture.run("run", &["--query", query, "--explain"]);
    assert!(output.contains("file_type=parquet"), "{output}");
    assert!(output.contains("RecursiveQueryExec"), "{output}");
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(compact.contains("|5|2|"), "{output}");
    let query = "USE GRAPH routes MATCH REPEATABLE ELEMENTS p = ALL SHORTEST (a {name:'A'})-[:Link]->+(b {name:'D'}) RETURN COUNT(*) AS ties, MAX(PATH_LENGTH(p)) AS hops";
    let output = fixture.run("run", &["--query", query]);
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(compact.contains("|2|2|"), "{output}");
    let query = "USE GRAPH routes MATCH p = (a {name:'A'})(-[e:Link]->(b))? RETURN COUNT(*) AS paths, COUNT(e) AS present";
    let output = fixture.run("run", &["--query", query]);
    let compact: String = output.chars().filter(|c| !c.is_whitespace()).collect();
    assert!(compact.contains("|3|2|"), "{output}");
}

#[test]
fn cli_import_query_and_checkpoint_survive_independent_processes() {
    let fixture = Fixture::new();
    fs::write(fixture.0.join("setup.gql"), "CREATE GRAPH social ANY GRAPH; SESSION SET GRAPH social; RETURN 'text;--still text' AS value;").unwrap();
    assert!(fixture
        .run("run", &["--create", "--file", "setup.gql"])
        .contains("text;--still text"));
    assert!(fixture
        .run(
            "import",
            &["--graph", "social", "--manifest", "import.json"]
        )
        .contains("nodes=3 edges=2"));
    let query = "USE GRAPH social MATCH (a:Person {name: 'Alice'})-[:Knows]->(b)-[:Knows]->(c) RETURN c.name AS friend";
    let output = fixture.run("run", &["--query", query, "--explain"]);
    assert!(output.contains("Cara"), "{output}");
    assert!(output.contains("file_type=parquet"), "{output}");
    assert!(output.contains("HashJoinExec"), "{output}");
    fixture.run("checkpoint", &[]);
    assert!(fixture.run("run", &["--query", query]).contains("Cara"));
    // Imported files are copied into managed storage; source deletion cannot break the graph.
    fs::remove_file(fixture.0.join("nodes.parquet")).unwrap();
    fs::remove_file(fixture.0.join("edges.parquet")).unwrap();
    assert!(fixture.run("run", &["--query", query]).contains("Cara"));
    let empty = fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH social MATCH (n:Missing) RETURN n.name AS empty",
        ],
    );
    assert!(empty.contains("empty"));
}

#[test]
fn cli_errors_do_not_replace_graphs_or_hide_partial_commit_semantics() {
    let fixture = Fixture::new();
    let bad = fixture.invoke("run", &["--create", "--query", "CREATE GRAPH"]);
    assert!(!bad.status.success());
    assert!(!fixture.0.join("db").exists());
    fixture.run(
        "run",
        &["--create", "--query", "CREATE GRAPH social ANY GRAPH"],
    );
    fixture.run(
        "import",
        &["--graph", "social", "--manifest", "import.json"],
    );
    assert!(!fixture
        .invoke(
            "import",
            &[
                "--graph",
                "social; DROP GRAPH social",
                "--manifest",
                "import.json"
            ]
        )
        .status
        .success());
    let schema = Arc::new(Schema::new(vec![Field::new(
        "wrong",
        DataType::UInt64,
        false,
    )]));
    let batch =
        RecordBatch::try_new(schema.clone(), vec![Arc::new(UInt64Array::from(vec![4]))]).unwrap();
    let mut writer = ArrowWriter::try_new(
        fs::File::create(fixture.0.join("nodes.parquet")).unwrap(),
        schema,
        None,
    )
    .unwrap();
    writer.write(&batch).unwrap();
    writer.close().unwrap();
    assert!(!fixture
        .invoke(
            "import",
            &["--graph", "social", "--manifest", "import.json"]
        )
        .status
        .success());
    let rows = fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH social MATCH (n:Person) RETURN n.name AS name",
        ],
    );
    for name in ["Alice", "Bob", "Cara"] {
        assert!(rows.contains(name));
    }
    assert!(!fixture
        .invoke(
            "run",
            &[
                "--query",
                "CREATE GRAPH committed ANY GRAPH; RETURN missing"
            ]
        )
        .status
        .success());
    fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH committed MATCH (n) RETURN ELEMENT_ID(n) AS id",
        ],
    );
    assert!(!fixture
        .invoke(
            "run",
            &[
                "--query",
                "START TRANSACTION; CREATE GRAPH rejected ANY GRAPH"
            ]
        )
        .status
        .success());
    assert!(!fixture
        .invoke(
            "run",
            &[
                "--query",
                "USE GRAPH rejected MATCH (n) RETURN ELEMENT_ID(n) AS id"
            ]
        )
        .status
        .success());
}

#[test]
fn cli_usage_and_in_memory_program() {
    let output = Command::new(env!("CARGO_BIN_EXE_graphfusion"))
        .arg("--help")
        .output()
        .unwrap();
    assert!(output.status.success());
    let output = Command::new(env!("CARGO_BIN_EXE_graphfusion"))
        .args([
            "run",
            "--query",
            "SESSION SET VALUE $x INTEGER = 40; RETURN $x + 2 AS result",
        ])
        .output()
        .unwrap();
    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    assert!(String::from_utf8_lossy(&output.stdout).contains("42"));
    let fixture = Fixture::new();
    assert!(!fixture
        .invoke(
            "run",
            &["--create", "--file", "missing", "--query", "RETURN 1 AS n"]
        )
        .status
        .success());
    assert!(!Path::new(&fixture.0.join("db")).exists());
}

#[test]
fn cli_executes_persistent_gql_mutations_without_an_external_import() {
    let fixture = Fixture::new();
    fs::write(fixture.0.join("write.gql"), "CREATE GRAPH g ANY GRAPH; SESSION SET GRAPH g; INSERT (a:Person {name: 'Alice', age: 30})-[:Knows]->(b:Person {name: 'Bob', age: 40}); MATCH (a {name: 'Alice'}) SET a.age = a.age + 1;").unwrap();
    assert!(fixture
        .run("run", &["--create", "--file", "write.gql"])
        .contains("affected_elements=3"));
    let result = fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH g MATCH (a {name: 'Alice'}) RETURN a.age AS age",
            "--explain",
        ],
    );
    assert!(result.contains("31"));
    assert!(result.contains("file_type=parquet"));
    let result = fixture.invoke(
        "run",
        &["--query", "USE GRAPH g MATCH (a {name: 'Alice'}) DELETE a"],
    );
    assert!(!result.status.success());
    fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH g MATCH (a {name: 'Alice'}) DETACH DELETE a",
        ],
    );
    fixture.run("checkpoint", &[]);
    let result = fixture.run(
        "run",
        &["--query", "USE GRAPH g MATCH (n) RETURN n.name AS name"],
    );
    assert!(result.contains("Bob"));
    assert!(!result.contains("Alice"));
}

#[test]
fn cli_relational_queries_and_rollback_survive_parquet_reopen() {
    let fixture = Fixture::new();
    fs::write(
        fixture.0.join("analytics.gql"),
        include_str!("fixtures/analytics.gql"),
    )
    .unwrap();
    let result = fixture.run("run", &["--create", "--file", "analytics.gql"]);
    assert!(result.contains("median_age"));
    assert!(result.contains("| Cara  | 0"), "{result}");
    fixture.run("checkpoint", &[]);
    let result = fixture.run("run", &["--query", "USE GRAPH analytics MATCH (p:Person) OPTIONAL MATCH (p)-[:Knows]->(f) RETURN p.name AS name, COUNT(f) AS friends GROUP BY name ORDER BY name", "--explain"]);
    assert!(result.contains("| Alice | 1"), "{result}");
    assert!(result.contains("| Bob   | 0"), "{result}");
    assert!(result.contains("| Cara  | 0"), "{result}");
    assert!(result.contains("file_type=parquet"), "{result}");
    assert!(!fixture.invoke("run", &["--query", "USE GRAPH analytics INSERT (:Person {name: 'Rolled back'}) FOR x IN [9223372036854775807, 1] RETURN SUM(x) AS n"]).status.success());
    let result = fixture.run(
        "run",
        &[
            "--query",
            "USE GRAPH analytics MATCH (p:Person) RETURN COUNT(*) AS n",
        ],
    );
    assert!(result.contains("| 3 |"), "{result}");
}

#[test]
fn cli_explicit_transactions_publish_once_and_survive_reopen() {
    let fixture = Fixture::new();
    fs::write(
        fixture.0.join("transactions.gql"),
        include_str!("fixtures/transactions.gql"),
    )
    .unwrap();
    let result = fixture.run("run", &["--create", "--file", "transactions.gql"]);
    assert!(
        result.contains("transaction=committed commit=2"),
        "{result}"
    );
    assert!(result.contains("pending_snapshot=1"), "{result}");
    assert!(result.contains("transaction=rolled_back"), "{result}");
    assert!(result.contains("| Alice | 75"), "{result}");
    assert!(result.contains("| Bob   | 75"), "{result}");
    fixture.run("checkpoint", &[]);
    let result = fixture.run("run", &["--query", "START TRANSACTION READ ONLY; USE GRAPH ledger MATCH (a:Account) RETURN SUM(a.balance) AS total; COMMIT", "--explain"]);
    assert!(result.contains("150"), "{result}");
    assert!(result.contains("file_type=parquet"), "{result}");
    for sql in [
        "START TRANSACTION; USE GRAPH ledger INSERT (:Account {name: 'Failed', balance: 5}); RETURN 1 / 0 AS bad; COMMIT",
        "START TRANSACTION; USE GRAPH ledger INSERT (:Account {name: 'Unfinished', balance: 6})",
        "START TRANSACTION READ ONLY; DROP GRAPH ledger; COMMIT",
    ] { assert!(!fixture.invoke("run", &["--query", sql]).status.success(), "{sql}"); }
    let result = fixture.run("run", &["--query", "USE GRAPH ledger MATCH (a:Account) RETURN COUNT(*) AS accounts, SUM(a.balance) AS total"]);
    assert!(result.contains("| 2        | 150"), "{result}");
}