This is a work in progress and is not yet suitable for production usage.
It can connect to TypeDB, run read and write queries, and return answers. Concept API methods are not available yet.
To learn about the mechanism that a TypeDB Client uses to set up communication with databases running on the TypeDB Server, refer to TypeDB > Client API > Overview.
The TypeDB Client for Rust provides a fully async API that supports the tokio
multi-threaded runtime.
- Import
typedb-client
through Cargo:
typedb-client = "0.1.2"
- Make sure the TypeDB Server is running.
- See
tests/integration
for examples of usage.
Note: You don't need to compile TypeDB Client from source if you just want to use it in your code. See the "Quickstart" section above.
-
Make sure you have Bazel installed on your machine.
-
Build the library:
a) to build the native/raw rlib:
bazel build //:typedb_client
The rlib will be produced at:
bazel-bin/libtypedb_client-{hash}.rlib
.b) to build the crate for a Cargo project:
bazel build //:assemble_crate
The Cargo crate will be produced at:
bazel-bin/assemble_crate.crate
You can then unzip this crate to retrieve
Cargo.toml
. Please note: this process has not yet been thoroughly tested. The generatedCargo.toml
may not be fully correct. See theCargo.toml
of thetypedb-client
crate for reference.