Kuzu Godot

Godot 4.4 is currently used Version

Bindings for Kuzu in Godot

Embedded property graph database built for speed. Using Graph Query Language of Cypher.

Overview

1. Create an Instance of Kuzu
2. Set the Database Folder Path
3. Initialize the Database
4. Create a Connection to the DB with thread count

var myKuzuDB : KuzuGD = KuzuGD.new(); # Instantiate
var db_path = ProjectSettings.globalize_path("res://data/database/kuzu_db");
var success_db = myKuzuDB.kuzu_init(db_path); # Set Path
var success_connect = myKuzuDB.kuzu_connect(1); # Activate Connection

1. Execute Queries
2. Define Tables
3. Write Data
4. Read Data

# Define Tables
myKuzuDB.execute_query("CREATE NODE TABLE IF NOT EXISTS person(name STRING, age INT64, PRIMARY KEY(name));");

# Write Data
myKuzuDB.execute_query("CREATE (:person {name: 'Alice', age: 30});");

# Read Data
var queryResult : Array = myKuzuDB.execute_query("MATCH (p:person) RETURN p.*");
print(queryResult);

Setup

Building from Source

Requires the Kuzu Binaries in the bin/<platform>/kuzu folders, pythons Scons, Godot, g++ compiler.

Contributing

Any and all Contributions are subject to the CLA.md