Skip to content
KoreDBPublic

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

KoreDB

KoreDB is an embedded graph database built for query speed and scalability. KoreDB is optimized for handling complex analytical workloads on very large databases and provides a set of retrieval features, such as a full text search and vector indices. Our core feature set includes:

  • Flexible Property Graph Data Model and Cypher query language
  • Embeddable, serverless integration into applications
  • Native full text search and vector index
  • Columnar disk-based storage
  • Columnar 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
  • Wasm (WebAssembly) bindings for fast, secure execution in the browser

KoreDB is derived from Kuzu, which was initially developed by Kùzu Inc. and released under the MIT License. Documentation links below still point at the upstream Kuzu resources, which describe the same engine.

Docs and Blog

To learn more about KoreDB, see our Documentation and Blog page.

Getting Started

Refer to our Getting Started page for your first example.

Extensions

KoreDB has an extension framework that users can dynamically load the functionality you need at runtime. We've developed a list of official extensions that you can use to extend KoreDB's functionality.

KoreDB requires you to install the extension before loading and using it. Note that KoreDB no longer provides the official extension server, where you can directly install any official extensions.

If you've upgraded to the latest version v0.11.3, KoreDB has pre-installed four commonly used extensions (algo, fts, json, vector) for you. You do not need to manually INSTALL these extensions.

For KoreDB versions before v0.11.3, or to install extensions that haven't been pre-installed, you have to set up a local extension server. The instructions of setting up a local extension server can be found below.

Host your own extension server

The extension server is based on NGINX and is hosted on GitHub. You can pull the Docker image and run it in your environment:

docker pull ghcr.io/kuzudb/extension-repo:latest
docker run -d -p 8080:80 ghcr.io/kuzudb/extension-repo:latest

In this example, the extension server will be available at http://localhost:8080. You can then install extensions from your server by appending the FROM clause to the INSTALL command:

INSTALL <EXTENSION_NAME> FROM 'http://localhost:8080/';

Build from Source

The test fixtures live in a separate repository, KoreDB/dataset, mounted as a git submodule at dataset/. Clone recursively so the test suite has data to run against:

git clone --recurse-submodules https://github.com/KoreDB/koredb.git

For an existing clone, run git submodule update --init dataset. Building the library itself does not need the submodule — only the tests do.

You can build from source using the instructions provided in the developer guide.

License

KoreDB is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages