kuzudb/kuzu-swift

Official Swift language binding for [Kuzu](https://github.com/kuzudb/kuzu). Kuzu an embeddable property graph database management system built for query speed and scalability. For more information, please visit the [Kuzu GitHub repository](https://github.com/kuzudb/kuzu) or the [

Get started

To add kuzu-swift to your Swift project, you can use the Swift Package Manager:

Add .package(url: "https://github.com/kuzudb/kuzu-swift/", branch: "main"), to your Package.swift dependencies.

You can change the branch to a tag to use a specific version, e.g., .package(url: "https://github.com/kuzudb/kuzu-swift/", branch: "0.11.0"), to use version 0.11.0.

Add Kuzu to your target dependencies.

``swift dependencies: [ .product(name: "Kuzu", package: "kuzu-swift"), ] ``

Alternatively, you can add the package through Xcode:

Open your Xcode project.
Go to File > Add Packages Dependencies....
Enter the URL of the kuzu-swift repository: https://github.com/kuzudb/kuzu-swift.
Select the version you want to use (e.g., main branch or a specific tag).

Docs

The API documentation for kuzu-swift is available here.

Examples

A simple CLI example is provided in the Example directory.

A demo iOS application is provided here.

System requirements

kuzu-swift requires Swift 5.9 or later. It supports the following platforms:

macOS v11 or later
iOS v14 or later
Linux platforms (see the official documentation for the supported distros)

Windows platform is not supported and there is no future plan to support it.

The CI pipeline tests the package on macOS v15, Ubuntu 24.04, and iOS 18.6 Simulator.

Build

swift build

Tests

To run the tests, you can use the following command:

swift test

Contributing

We welcome contributions to kuzu-swift. By contributing to kuzu-swift, you agree that your contributions will be licensed under the MIT License. Please read the contributing guide for more information.

Package Metadata

Repository: kuzudb/kuzu-swift

Default branch: main

README: README.md