2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
# Nim Kuzu
|
|
|
|
|
|
|
|
|
|
home
|
2025-06-28 15:37:14 -07:00
|
|
|
: https://code.martini.nu/mahlon/nim-kuzu
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
github_mirror
|
|
|
|
|
: https://github.com/mahlonsmith/nim-kuzu
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
2025-03-29 23:17:10 +00:00
|
|
|
This is a Nim binding for the [Kuzu](https://kuzudb.com) graph database library.
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
Kuzu is an embedded graph database built for query speed and scalability. It is
|
|
|
|
|
optimized for handling complex join-heavy analytical workloads on very large
|
|
|
|
|
graphs, with the following core feature set:
|
|
|
|
|
|
|
|
|
|
- Property Graph data model and Cypher query language
|
|
|
|
|
- Embedded (in-process) integration with applications
|
|
|
|
|
- Columnar disk-based storage
|
|
|
|
|
- Columnar, compressed sparse row-based (CSR) adjacency list/join indices
|
|
|
|
|
- Vectorized and factorized query processor
|
|
|
|
|
- Novel and very fast join algorithms
|
|
|
|
|
- Multi-core query parallelism
|
|
|
|
|
- Serializable ACID transactions
|
|
|
|
|
|
|
|
|
|
For more information about Kuzu itself, see its
|
|
|
|
|
[documentation](https://docs.kuzudb.com/).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
* A functioning Nim >= 2 installation
|
2025-03-29 23:17:10 +00:00
|
|
|
- [KuzuDB](https://kuzudb.com) to be locally installed!
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
$ nimble install kuzu
|
|
|
|
|
|
2025-05-27 18:31:59 +00:00
|
|
|
The current version of this library is built for Kuzu v0.10.0.
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
|
2025-03-31 19:35:15 +00:00
|
|
|
## Usage
|
2025-03-23 21:21:05 +00:00
|
|
|
|
2025-03-31 19:35:15 +00:00
|
|
|
See the [Usage documentation](USAGE.md).
|
2025-03-23 21:21:05 +00:00
|
|
|
|
2025-03-31 19:35:15 +00:00
|
|
|
You can also find a bunch of working examples in the tests.
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2025-06-28 15:37:14 -07:00
|
|
|
You can check out the current development source via Git/Jujutsu at its
|
|
|
|
|
[home repo](https://code.martini.nu/mahlon/nim-kuzu), or the
|
|
|
|
|
[project mirror](https://github.com/mahlonsmith/nim-kuzu).
|
2025-03-23 21:21:05 +00:00
|
|
|
|
|
|
|
|
After checking out the source, uncomment the development dependencies
|
|
|
|
|
from the `kuzu.nimble` file, and run:
|
|
|
|
|
|
|
|
|
|
$ nimble setup
|
|
|
|
|
|
|
|
|
|
This will install dependencies, and do any other necessary setup for
|
|
|
|
|
development.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Authors
|
|
|
|
|
|
|
|
|
|
- Mahlon E. Smith <mahlon@martini.nu>
|
|
|
|
|
|
|
|
|
|
A note of thanks to @mantielero on Github, who has a Kuzu binding for an early
|
|
|
|
|
KuzuDB (0.4.x) that I found after starting this project.
|
