Change all graphflow to kuzu

Author: mewim

.clang-format

@@ -55,7 +55,7 @@ BreakConstructorInitializers: BeforeColon
 BreakInheritanceList: BeforeColon
 BreakStringLiterals: true
 ColumnLimit:     100
-CommentPragmas:  '^GF pragma:'
+CommentPragmas:  '^KU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: false
 ConstructorInitializerIndentWidth: 4

.github/workflows/linux-precompiled-bin-workflow.yml

@@ -23,11 +23,11 @@ jobs:
 
       - uses: actions/upload-artifact@v3
         with:
-          name: graphflowdb-${{ github.event.inputs.packageVersion }}-linux-x86_64
+          name: kuzu-${{ github.event.inputs.packageVersion }}-linux-x86_64
           path: |
-            ./scripts/pre-compiled-bins/graphflowdb
+            ./scripts/pre-compiled-bins/kuzu
             ./scripts/pre-compiled-bins/include
-            ./scripts/pre-compiled-bins/libgraphflowdb.so
+            ./scripts/pre-compiled-bins/libkuzu.so
 
       - name: cleanup
-        run: rm -rf ./scripts/pre-compiled-bins/graphflowdb ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libgraphflowdb.so
+        run: rm -rf ./scripts/pre-compiled-bins/kuzu ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libkuzu.so

.github/workflows/mac-precompiled-bin-workflow.yml

@@ -26,14 +26,14 @@ jobs:
 
       - uses: actions/upload-artifact@v3
         with:
-          name: graphflowdb-${{ github.event.inputs.packageVersion }}-osx-arm64
+          name: kuzu-${{ github.event.inputs.packageVersion }}-osx-arm64
           path: |
-            ./scripts/pre-compiled-bins/graphflowdb
+            ./scripts/pre-compiled-bins/kuzu
             ./scripts/pre-compiled-bins/include
-            ./scripts/pre-compiled-bins/libgraphflowdb.dylib
+            ./scripts/pre-compiled-bins/libkuzu.dylib
 
       - name: cleanup
-        run: rm -rf ./scripts/pre-compiled-bins/graphflowdb ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libgraphflowdb.dylib
+        run: rm -rf ./scripts/pre-compiled-bins/kuzu ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libkuzu.dylib
 
       - name: build-x86_64
         run: python3 pre_compile.py
@@ -44,11 +44,11 @@ jobs:
 
       - uses: actions/upload-artifact@v3
         with:
-          name: graphflowdb-${{ github.event.inputs.packageVersion }}-osx-x86_64
+          name: kuzu-${{ github.event.inputs.packageVersion }}-osx-x86_64
           path: |
-            ./scripts/pre-compiled-bins/graphflowdb
+            ./scripts/pre-compiled-bins/kuzu
             ./scripts/pre-compiled-bins/include
-            ./scripts/pre-compiled-bins/libgraphflowdb.dylib
+            ./scripts/pre-compiled-bins/libkuzu.dylib
 
       - name: cleanup
-        run: rm -rf ./scripts/pre-compiled-bins/graphflowdb ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libgraphflowdb.dylib
+        run: rm -rf ./scripts/pre-compiled-bins/kuzu ./scripts/pre-compiled-bins/include ./scripts/pre-compiled-bins/libkuzu.dylib

.github/workflows/mac-wheel-workflow.yml

@@ -19,7 +19,7 @@ jobs:
       - name: create-source-distribution
         working-directory: ./scripts/pip-package/
         run: |
-          rm -rf wheelhouse graphflowdb.tar.gz
+          rm -rf wheelhouse kuzu.tar.gz
           mkdir wheelhouse
           bash package_tar.sh
 
@@ -31,7 +31,7 @@ jobs:
           CIBW_BUILD_VERBOSITY: 3
           MACOSX_DEPLOYMENT_TARGET: 11.0
         with:
-          package-dir: ./scripts/pip-package/graphflowdb.tar.gz
+          package-dir: ./scripts/pip-package/kuzu.tar.gz
           output-dir: ./scripts/pip-package/wheelhouse
 
       - name: build-x86-wheel
@@ -42,7 +42,7 @@ jobs:
           CIBW_BUILD_VERBOSITY: 3
           MACOSX_DEPLOYMENT_TARGET: 10.15
         with:
-          package-dir: ./scripts/pip-package/graphflowdb.tar.gz
+          package-dir: ./scripts/pip-package/kuzu.tar.gz
           output-dir: ./scripts/pip-package/wheelhouse
 
       - uses: actions/upload-artifact@v3

README.md

@@ -1,4 +1,4 @@
-# graphflowDB
+# kuzu
 
 ## Compilation
 
@@ -17,7 +17,7 @@
 
 ## CLI
 
-- To start CLI `bazel run //tools/shell:graphflowdb -- -i <serialized-graph-path>`
+- To start CLI `bazel run //tools/shell:kuzu -- -i <serialized-graph-path>`
 - CLI built in commands
   :help get command list
   :clear clear shell
@@ -28,7 +28,7 @@
 
 ## Benchmark runner
 
-Benchmark runner is designed to be used in graphflowdb-benchmark. Deirectly using benchmark runner is not recommended.
+Benchmark runner is designed to be used in kuzu-benchmark. Deirectly using benchmark runner is not recommended.
 
 - benchmark file should have the following format
 

WORKSPACE.bazel

@@ -1,4 +1,4 @@
-workspace(name = "graphflowdb")
+workspace(name = "kuzu")
 
 load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive", "http_jar")

benchmark/benchmark_runner.py

@@ -10,19 +10,19 @@
 datasets = {'ldbc-sf10', 'ldbc-sf100'}
 
 datasets_path = {
-    'ldbc-sf10-gf': '/home/x74feng/CI/ldbc-sf10',
-    'ldbc-sf100-gf': '/home/x74feng/CI/ldbc-sf100'
+    'ldbc-sf10-ku': '/home/x74feng/CI/ldbc-sf10',
+    'ldbc-sf100-ku': '/home/x74feng/CI/ldbc-sf100'
 }
 
 serialized_graphs_path = {
-    'ldbc-sf10-gf': '/home/x74feng/CI/ldbc-sf10-serialized',
-    'ldbc-sf100-gf': '/home/x74feng/CI/ldbc-sf100-serialized'
+    'ldbc-sf10-ku': '/home/x74feng/CI/ldbc-sf10-serialized',
+    'ldbc-sf100-ku': '/home/x74feng/CI/ldbc-sf100-serialized'
 }
 
 benchmark_server_dir = '/home/x74feng/CI/server'
 benchmark_log_dir = benchmark_server_dir + '/data/logs'
 benchmark_files = os.getenv("GITHUB_WORKSPACE") + '/benchmark/queries'
-graphflowDB_benchmark_tool = os.getenv(
+kuzu_benchmark_tool = os.getenv(
     "GITHUB_WORKSPACE") + '/bazel-out/k8-fastbuild/bin/tools/benchmark/benchmark_tool'
 
 # benchmark configuration
@@ -134,10 +134,10 @@ def get_run_num():
         return 1
 
 
-def run_graphflowdb(serialized_graph_path):
+def run_kuzu(serialized_graph_path):
     for group, _ in benchmark_group.group_to_benchmarks.items():
         benchmark_cmd = [
-            graphflowDB_benchmark_tool,
+            kuzu_benchmark_tool,
             '--dataset=' + serialized_graph_path,
             '--benchmark=' + benchmark_files + '/' + group,
             '--warmup=' + str(num_warmup),
@@ -202,13 +202,13 @@ def upload_benchmark_result(run_num):
     if not os.path.exists(benchmark_log_dir):
         os.mkdir(benchmark_log_dir)
     benchmark_files = benchmark_files + '/' + args.dataset
-    dataset_path = datasets_path[args.dataset + '-gf']
+    dataset_path = datasets_path[args.dataset + '-ku']
 
     # load benchmark
     benchmark_group = BenchmarkGroup(benchmark_files)
     benchmark_group.load()
 
-    run_graphflowdb(serialized_graphs_path[args.dataset + '-gf'])
+    run_kuzu(serialized_graphs_path[args.dataset + '-ku'])
 
     # upload benchmark result and logs
     upload_benchmark_result(run_num)

scripts/dockerized-ci-tests-runner/README.md

@@ -1,13 +1,13 @@
 ## Build
 ```
-docker build -t graphflow-self-hosted-test-runner .
+docker build -t kuzu-self-hosted-test-runner .
 ```
 
 ## Start Container
 ```
 docker run  --name self-hosted-test-runner-X --detach --restart=always\
             -e GITHUB_ACCESS_TOKEN=YOUR_GITHUB_ACCESS_TOKEN\
-            -e MACHINE_NAME=NAME_OF_THE_PHYSICAL_MACHINE graphflow-self-hosted-test-runner
+            -e MACHINE_NAME=NAME_OF_THE_PHYSICAL_MACHINE kuzu-self-hosted-test-runner
 ```
 
 Note: `GITHUB_ACCESS_TOKEN` is the account-level access token that can be acquired at [GitHub developer settings](https://github.com/settings/tokens).

scripts/pip-package/MANIFEST.in

@@ -1 +1 @@
-include graphflowdb/*.so
+include kuzu/*.so

scripts/pip-package/README.md

@@ -2,7 +2,7 @@
 ```
 chmod +x package_tar.sh
 ./package_tar.sh
-pip install graphflowdb.tar.gz    
+pip install kuzu.tar.gz    
 ```
 
 Note: installing from source requires the full toolchain for building the project, including bazel, OpenJDK, and a compiler compatible with C++20. The package works for both Linux and macOS.
@@ -13,14 +13,14 @@ The container for manylinux builder automatically builds and upload wheels compa
 
 ## Build
 ```
-docker build -t graphflow-self-hosted-linux-builder .
+docker build -t kuzu-self-hosted-linux-builder .
 ```
 
 ## Start container
 ```
 docker run  --name self-hosted-linux-builder --detach --restart=always\
             -e GITHUB_ACCESS_TOKEN=YOUR_GITHUB_ACCESS_TOKEN\
-            -e MACHINE_NAME=NAME_OF_THE_PHYSICAL_MACHINE graphflow-self-hosted-linux-builder
+            -e MACHINE_NAME=NAME_OF_THE_PHYSICAL_MACHINE kuzu-self-hosted-linux-builder
 ```
 
 Note: `GITHUB_ACCESS_TOKEN` is the account-level access token that can be acquired at [GitHub developer settings](https://github.com/settings/tokens).

scripts/pip-package/build_all_packages.sh

@@ -3,7 +3,7 @@
 PLATFORM="manylinux2014_x86_64"
 
 chmod +x ./package_tar.sh
-rm -rf wheelhouse graphflowdb.tar.gz && ./package_tar.sh
+rm -rf wheelhouse kuzu.tar.gz && ./package_tar.sh
 mkdir wheelhouse
 
 # Build wheels, excluding pypy platforms
@@ -13,7 +13,7 @@ for PYBIN in /opt/python/*/bin; do
     fi
     echo "Building wheel for $PYBIN..."
     "${PYBIN}/pip" install -r ../../tools/python_api/requirements_dev.txt
-    "${PYBIN}/pip" wheel graphflowdb.tar.gz --no-deps -w wheelhouse/
+    "${PYBIN}/pip" wheel kuzu.tar.gz --no-deps -w wheelhouse/
 done
 
 for whl in wheelhouse/*.whl; do

scripts/pip-package/graphflowdb/__init__.py

@@ -0,0 +1 @@
+from ._kuzu import *

scripts/pip-package/kuzu/__init__.py

@@ -6,11 +6,11 @@ tar --exclude="$(pwd)" \
     --exclude="./scripts" \
     --exclude="./.?*" \
     -cf\
-    graphflowdb-source.tar\
+    kuzu-source.tar\
     -C ../../. .
-rm -rf graphflowdb-source && mkdir graphflowdb-source
-tar -xf graphflowdb-source.tar -C ./graphflowdb-source
-rm -rf graphflowdb-source.tar
+rm -rf kuzu-source && mkdir kuzu-source
+tar -xf kuzu-source.tar -C ./kuzu-source
+rm -rf kuzu-source.tar
 
 # Add all files under current directory
 touch sdist.tar
@@ -20,6 +20,6 @@ tar -xf sdist.tar -C ./sdist
 rm -rf sdist.tar
 
 # Create tar.gz for PyPI
-rm -rf graphflowdb.tar.gz
-tar -czf graphflowdb.tar.gz sdist
-rm -rf sdist graphflowdb-source
+rm -rf kuzu.tar.gz
+tar -czf kuzu.tar.gz sdist
+rm -rf sdist kuzu-source

scripts/pip-package/package_tar.sh

@@ -10,7 +10,7 @@
 
 base_dir = os.path.dirname(__file__)
 
-with open(os.path.join(base_dir, 'graphflowdb-source', 'tools', 'python_api', 'requirements_dev.txt')) as f:
+with open(os.path.join(base_dir, 'kuzu-source', 'tools', 'python_api', 'requirements_dev.txt')) as f:
     requirements = f.read().splitlines()
 
 
@@ -47,13 +47,13 @@ def build_extension(self, ext: BazelExtension) -> None:
         full_cmd = ['bazel', 'build', *args, '//tools/python_api:all']
         env_vars = os.environ.copy()
         env_vars['PYTHON_BIN_PATH'] = sys.executable
-        build_dir = os.path.join(ext.sourcedir, 'graphflowdb-source')
+        build_dir = os.path.join(ext.sourcedir, 'kuzu-source')
 
         subprocess.run(full_cmd, cwd=build_dir, check=True, env=env_vars)
         self.announce("Done building native extension.", level=3)
         self.announce("Copying native extension...", level=3)
         shutil.copyfile(os.path.join(build_dir, 'bazel-bin', 'tools', 'python_api',
-                                     '_graphflowdb.so'), os.path.join(ext.sourcedir, ext.name, '_graphflowdb.so'))
+                                     '_kuzu.so'), os.path.join(ext.sourcedir, ext.name, '_kuzu.so'))
         self.announce("Done copying native extension.", level=3)
 
 
@@ -64,15 +64,15 @@ def run(self):
         return super().run()
 
 
-setup(name='graphflowdb',
+setup(name='kuzu',
       version=os.environ['PYTHON_PACKAGE_VERSION'] if 'PYTHON_PACKAGE_VERSION' in os.environ else '0.0.1',
       install_requires=requirements,
       ext_modules=[BazelExtension(
-          name="graphflowdb", sourcedir=base_dir)],
-      description='GraphflowDB Python API',
+          name="kuzu", sourcedir=base_dir)],
+      description='KuzuDB Python API',
       long_description=open(os.path.join(base_dir, "README.md"), 'r').read(),
       long_description_content_type="text/markdown",
-      packages=["graphflowdb"],
+      packages=["kuzu"],
       zip_safe=True,
       include_package_data=True,
       cmdclass={

scripts/pip-package/setup.py

@@ -12,16 +12,20 @@
 
 MAIN_HEADER_PATH = os.path.realpath(
     os.path.join(os.path.dirname(__file__), '../../src/'))
+MAIN_DIR_NAME = os.path.basename(os.path.realpath(
+    os.path.join(os.path.dirname(__file__), '../../')))
+
+BAZEL_WORKSPACE_NAME = 'bazel-%s' % MAIN_DIR_NAME
 EXTERNAL_HEADER_PATH = os.path.realpath(
-    os.path.join(os.path.dirname(__file__), '../../bazel-graphflowdb/external'))
+    os.path.join(os.path.dirname(__file__), '../../%s/external' % BAZEL_WORKSPACE_NAME))
 
 MAIN_OBJ_PATH = os.path.realpath(
     os.path.join(os.path.dirname(__file__), '../../bazel-bin/src'))
 EXTERNAL_OBJ_PATH = os.path.realpath(
     os.path.join(os.path.dirname(__file__), '../../bazel-bin/external'))
 
 MAIN_EXE_PATH = os.path.realpath(
-    os.path.join(os.path.dirname(__file__), '../../bazel-bin/tools/shell/graphflowdb'))
+    os.path.join(os.path.dirname(__file__), '../../bazel-bin/tools/shell/kuzu'))
 
 UNUSED_HEADER_EXCLUDE_PREFIXES = [
     'src/main',
@@ -243,7 +247,7 @@ def collect_obj_files(external_lib_names):
 def collect_executable():
     logging.info("Collecting executable...")
     dest = os.path.realpath(
-        os.path.join('.', 'graphflowdb'))
+        os.path.join('.', 'kuzu'))
     logging.debug("Copying executable: " + MAIN_EXE_PATH + " -> " + dest)
     shutil.copyfile(MAIN_EXE_PATH, dest)
     logging.debug("Fixing permissions for executable: " + dest)