incubator-graphar

(★ 371)

An open source, standard data file format for graph data storage and retrieval.

File Explorer

Download Latest Version (.zip)

- devcontainer.json
- Dockerfile
- Makefile
- - bug_report.yml
  - config.yml
  - feature_request.yml
- - update_version.py
- - ci-nightly.yml
  - ci.yml
  - docs.yml
  - go.yaml
  - java-info.yml
  - java.yml
  - license.yml
  - pr-title.yml
  - pre-commit.yml
  - publish-docker.yml
  - pyspark.yml
  - python-wheel-workflow.yml
  - python.yml
  - rust.yaml
  - spark.yaml
- .licenserc.yaml
- PULL_REQUEST_TEMPLATE.md
- - arrow_chunk_reader_benchmark.cc
  - benchmark_util.h
  - CMakeLists.txt
  - graph_info_benchmark.cc
  - label_filter_benchmark.cc
- - apache-arrow.cmake
- - bfs_father_example.cc
  - bfs_pull_example.cc
  - bfs_push_example.cc
  - bfs_stream_example.cc
  - bgl_example.cc
  - cc_push_example.cc
  - cc_stream_example.cc
  - CMakeLists.txt
  - config.h
  - construct_info_example.cc
  - filtering_example.cc
  - high_level_reader_example.cc
  - high_level_writer_example.cc
  - low_level_reader_example.cc
  - mid_level_reader_example.cc
  - mid_level_writer_example.cc
  - pagerank_example.cc
  - snap_dataset_to_graphar.cc
- - cpplint.py
- - CMakeLists.txt
- - CMakeLists.txt
  - test_arrow_chunk_reader.cc
  - test_arrow_chunk_writer.cc
  - test_builder.cc
  - test_chunk_info_reader.cc
  - test_graph.cc
  - test_info.cc
  - test_multi_label.cc
  - test_multi_property.cc
  - util.h
- .gitignore
- Brewfile
- CMakeLists.txt
- CMakePresets.json
- disclaimer_footer.html
- Doxyfile
- graphar-config-version.in.cmake
- graphar-config.in.cmake
- README.md
- - conda_env_cpp.txt
  - conda_env_scala.txt
  - release.py
  - setup-ubuntu.sh
  - verify.py
- download_test_data.sh
- - benchmark_IO_time.png
  - benchmark_label_complex_filter.png
  - benchmark_label_simple_filter.png
  - benchmark_label_storage.png
  - benchmark_neighbor_retrieval.png
  - benchmark_storage.png
  - edge_logical_table.png
  - edge_physical_table1.png
  - edge_physical_table2.png
  - graphar-logo-notext.png
  - graphar-logo.png
  - graphar-logo.svg
  - graphar.ico
  - overview.png
  - property_graph.png
  - qrcode.png
  - vertex_logical_table.png
  - vertex_physical_table.png
- - _category_.yml
- - concepts.md
  - motivation.md
  - overview.md
- - _category_.yml
  - format.md
  - implementation-status.md
- .markdownlint.yaml
- index.md
- README.md
- - .gitignore
  - .golangci.yml
  - doc.go
  - go.mod
  - go.sum
  - Makefile
- README.md
- LICENSE-cpplint.txt
- LICENSE-mini-yaml.txt
- LICENSE-result.txt
- LICENSE-simple-uri-parser
- - pom.xml
  - README.md
- - .gitignore
  - build.xml
  - CMakeLists.txt
  - pom.xml
  - README.md
- - .gitignore
  - .scalafix.conf
  - .scalafmt.conf
  - pom.xml
  - README.md
- - pom.xml
- pom.xml
- - __init__.py
  - enums.py
  - errors.py
  - graph.py
  - info.py
  - reader.py
  - util.py
  - writer.py
- - module.html.jinja2
- - __init__.py
  - conftest.py
  - test_enums.py
  - test_info.py
  - test_reader.py
  - test_transform.py
  - test_writer.py
- .gitignore
- Makefile
- poetry.lock
- pyproject.toml
- README.md
- - graph_info_example.py
  - high_level_example.py
- - conftest.py
  - test_graph_info.py
  - test_graphar_cli.py
  - test_high_level_api.py
- .gitignore
- CMakeLists.txt
- Makefile
- poetry.lock
- pyproject.toml
- README.md
- - graphar_rs.h
- - error.rs
  - ffi.rs
  - graphar_rs.cc
  - lib.rs
  - property.rs
  - types.rs
- build.rs
- Cargo.lock
- Cargo.toml
- deny.toml
- Dockerfile
- rust-toolchain.toml
- taplo.toml
.asf.yaml
.clang-format
.clang-tidy
.gitignore
.gitmodules
.pre-commit-config.yaml
CHANGELOG.md
cmake-format.py
cmake.log
CODE_OF_CONDUCT.md
codecov.yml
CONTRIBUTING.md
DISCLAIMER
LICENSE
licenserc.toml
make.log
NOTICE
README-zh-cn.md
README.md
testing

# Installation Guide

1. Get the code

git clone https://github.com/apache/incubator-graphar

Downloads the entire project code from GitHub to your computer.

cd incubator-graphar

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f rust/Dockerfile -t incubator-graphar .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 incubator-graphar

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. CMake

Medium

Prerequisites

Git Needed to download the project code from GitHub.
CMake The tool used to generate build configuration.
C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.

cd cpp

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

4. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

cd maven-projects/info

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

5. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install .

Installs the package published on PyPI directly — no need to clone the source.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

6. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd go/graphar

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

7. Rust

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cd rust

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

8. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

cd go/graphar

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.