Rust API

.github/workflows/ci-workflow.yml

@@ -34,6 +34,9 @@ jobs:
       - name: Node.js test
         run: CC=gcc CXX=g++ make nodejstest NUM_THREADS=32
 
+      - name: Rust test
+        run: CC=gcc CXX=g++ make rusttest NUM_THREADS=32
+
       - name: Generate coverage report
         run: |
           lcov -c -d ./ --no-external -o cover.info &&\
@@ -131,6 +134,16 @@ jobs:
       - name: Check test format
         run: python3 scripts/run-clang-format.py --clang-format-executable /usr/bin/clang-format-11 -r test/
 
+  rustfmt-check:
+    name: rustfmt check
+    runs-on: kuzu-self-hosted-testing
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Check api format
+        working-directory: tools/rust_api
+        run: cargo fmt --check
+
   benchmark:
     name: benchmark
     needs: [gcc-build-test, clang-build-test]

Makefile

@@ -107,6 +107,16 @@ nodejstest: arrow
 	cd $(ROOT_DIR)/tools/nodejs_api/ && \
 	npm test
 
+rusttest:
+ifeq ($(OS),Windows_NT)
+	cd $(ROOT_DIR)/tools/rust_api && \
+	set KUZU_TESTING=1 && \
+	cargo test -- --test-threads=1
+else
+	cd $(ROOT_DIR)/tools/rust_api && \
+	KUZU_TESTING=1 cargo test -- --test-threads=1
+endif
+
 clean-python-api:
 ifeq ($(OS),Windows_NT)
 	if exist tools\python_api\build rmdir /s /q tools\python_api\build

examples/rust/.gitignore

@@ -0,0 +1 @@
+/target

examples/rust/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "kuzu-rust-example"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+kuzu = {path="../../tools/rust_api"}

examples/rust/src/main.rs

@@ -0,0 +1,24 @@
+use kuzu::{Connection, Database, Error};
+
+fn main() -> Result<(), Error> {
+    let db = Database::new(
+        std::env::args()
+            .nth(1)
+            .expect("The first CLI argument should be the database path"),
+        0,
+    )?;
+    let connection = Connection::new(&db)?;
+
+    // Create schema.
+    connection.query("CREATE NODE TABLE Person(name STRING, age INT64, PRIMARY KEY(name));")?;
+    // Create nodes.
+    connection.query("CREATE (:Person {name: 'Alice', age: 25});")?;
+    connection.query("CREATE (:Person {name: 'Bob', age: 30});")?;
+
+    // Execute a simple query.
+    let mut result = connection.query("MATCH (a:Person) RETURN a.name AS NAME, a.age AS AGE;")?;
+
+    // Print query result.
+    println!("{}", result.display());
+    Ok(())
+}

src/common/types/value.cpp

@@ -548,7 +548,7 @@ nodeID_t RelVal::getDstNodeID() const {
     return dstNodeIDVal->getValue<nodeID_t>();
 }
 
-std::string RelVal::getLabelName() {
+std::string RelVal::getLabelName() const {
     return labelVal->getValue<std::string>();
 }
 

src/include/c_api/kuzu.h

@@ -882,12 +882,12 @@ KUZU_C_API char* kuzu_rel_val_to_string(kuzu_rel_val* rel_val);
  */
 KUZU_C_API void kuzu_query_summary_destroy(kuzu_query_summary* query_summary);
 /**
- * @brief Returns the compilation time of the given query summary.
+ * @brief Returns the compilation time of the given query summary in milliseconds.
  * @param query_summary The query summary to get compilation time.
  */
 KUZU_C_API double kuzu_query_summary_get_compiling_time(kuzu_query_summary* query_summary);
 /**
- * @brief Returns the execution time of the given query summary.
+ * @brief Returns the execution time of the given query summary in milliseconds.
  * @param query_summary The query summary to get execution time.
  */
 KUZU_C_API double kuzu_query_summary_get_execution_time(kuzu_query_summary* query_summary);

src/include/common/types/value.h

@@ -329,7 +329,7 @@ class RelVal {
     /**
      * @return the name of the RelVal.
      */
-    KUZU_API std::string getLabelName();
+    KUZU_API std::string getLabelName() const;
     /**
      * @return the value of the RelVal in string format.
      */

src/include/main/connection.h

@@ -129,7 +129,7 @@ class Connection {
     KUZU_API std::string getRelPropertyNames(const std::string& relTableName);
 
     /**
-     * @brief interrupts all queries currently executed within this connection.
+     * @brief interrupts all queries currently executing within this connection.
      */
     KUZU_API void interrupt();