alibaba / alibaba/GraphScope

[Docs/GIE] GIE documentations refine and extend

Open
#2,598 0 comments 0 reactions 3 assignees Claimed by @BingqingLyu View on GitHub
component:doc component:gie
Dominant language
C++
Stars
3.6k
Forks
468
Avg merge
29m
Merged PRs (30d)
1

Description

# Overview
Provide an overview and introduction of the gie-db.
Must briefly introduce the property graph model,
give some insightful examples etc.

# Installation
Introduce everything related to how to install the gie-db

## System requirements
Hardware/Software requirements, versions & limitations

## Linux installation (might fork the following for a Mac machine)
Instruct how to install on a Linux machine

### Tarball executable
Download pre-compiled tarball from the website.

### Pip install
A wheel package to allow users installing from pip, a consistent experience as [Graph](https://github.com/alibaba/GraphScope/projects/31#)[Scope](https://github.com/alibaba/GraphScope/projects/31#)

### Compile from source codes
Download from source code and due local compilation, potentially via:
```
gs dev make db
gs dev make install db ?
```

# Configuration

Describe each configurable items of the gs_db.yaml

# Benchmark
Provide our current ldbc benchmark results, potentially audited

# Development

## Stored procedure
Introduce the apis for helping users developing a stored procedure for gie_db

# Tools

## The db admin tool

The admin tool is maintain in the `bin` directory, co-designed with the `gs` cli tool.

```
gs db admin
```

We current provide the following to entry for the admin tool:
- server: manage the server-related operations
- start: Starts the server as a daemon.
- stop: Stops the server daemon.
- status: Gets the status of the server.
- restart: Restarts the server daemon.
- database: manage the database-related operations
- import: imports a collection of CSV files, must provide the data_import.yaml
- compile: to compiler a c++/cypher file into a stored procedure

```
gs db admin --help

gs db admin import -f[--folder] -c[--conf] data_import.yaml

gs db admin compiler -o [other configurations]
```

## Cypher-shell
Just briefly introduce that we use Neo4j's official Cypher-shell.

The following does not belong to the current production stage, but need to further consider:

Gremlin SDK
- [ ] Gremlin Compatibility (a table with supported tick yes, unsupported tick no) @shirly121
- [ ] Gremlin Supported Steps (with extended description for syntactic sugar) @longbinlai
- [ ] Python @longbinlai
- [ ] Gremlin 查询可配置参数:超时等等 @shirly121

Cypher SDK
- [ ] Cypher Compatibility: TODO @shirly121 , Refer to https://help.aliyun.com/document_detail/173132.html?spm=a2c4g.188107.0.0.13dc4982SZG7wB
- [ ] Cypher SDK: TODO ? How do we seamlessly support existing Cypher engines? @shirly121

Found several nice case in https://help.aliyun.com/document_detail/112465.html?spm=a2c4g.112470.0.0.4be243cflDDABM @BingqingLyu
- [ ] Bank and Finances
- [ ] Social Network
- [ ] Anti-Fraud
- [ ] Recommendation

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.