Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename doc dir #1032

Merged
merged 1 commit into from
Jan 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Nebula Graph is an open-source, distributed, easily scalable, and native graph d

A graph database, such as Nebula Graph, is a database that specializes in storing vast graph networks and retrieving information from them. It efficiently stores data as vertices (nodes) and edges (relationships) in labeled property graphs. Properties can be attached to both vertices and edges. Each vertex can have one or multiple tags (labels).

![What is a graph database](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/what-is-a-graph-database.png "What is a graph database")
![What is a graph database](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/what-is-a-graph-database.png "What is a graph database")

Graph databases are well suited for storing most kinds of data models abstracted from reality. Things are connected in almost all fields in the world. Modeling systems like relational databases extract the relationships between entities and squeeze them into table columns alone, with their types and properties stored in other columns or even other tables. This makes the data management time-consuming and cost-ineffective.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Each service has its executable binaries and processes launched from the binarie

The following figure shows the architecture of a typical Nebula Graph cluster.

![Nebula Graph architecture](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/nebula-graph-architecture-1.png "Nebula Graph architecture")
![Nebula Graph architecture](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/nebula-graph-architecture-1.png "Nebula Graph architecture")

## The Meta Service

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This topic introduces the architecture and functions of the Meta Service.

The architecture of the Meta Service is as follows:

![The architecture of the Meta Service](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/meta-architecture1.png)
![The architecture of the Meta Service](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/meta-architecture1.png)

The Meta Service is run by nebula-metad processes. Users can deploy nebula-metad processes according to the scenario:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Graph Service is used to process the query. It has four submodules: Parser,

## The architecture of the Graph Service

![The architecture of the Graph Service](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/query-engine-architecture.png)
![The architecture of the Graph Service](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/query-engine-architecture.png)

After a query is sent to the Graph Service, it will be processed by the following four submodules:

Expand All @@ -22,7 +22,7 @@ After receiving a request, the statements will be parsed by Parser composed of F

For example, the structure of the AST of `GO FROM "Tim" OVER like WHERE properties(edge).likeness > 8.0 YIELD dst(edge)` is shown in the following figure.

![AST](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/parser-ast-tree.png)
![AST](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/parser-ast-tree.png)

## Validator

Expand Down Expand Up @@ -66,7 +66,7 @@ In the `nebula-graphd.conf` file, when `enable_optimizer` is set to be `false`,

In the `nebula-graphd.conf` file, when `enable_optimizer` is set to be `true`, Planner will optimize the execution plans generated by Validator. The structure is as follows.

![Optimizer](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/optimizer.png)
![Optimizer](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/optimizer.png)

- Before optimization

Expand All @@ -92,7 +92,7 @@ In the `nebula-graphd.conf` file, when `enable_optimizer` is set to be `true`, P

The Executor module consists of Scheduler and Executor. The Scheduler generates the corresponding execution operators against the execution plan, starting from the leaf nodes and ending at the root node. The structure is as follows.

![Executor](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/executor.png)
![Executor](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/executor.png)

Each node of the execution plan has one execution operator node, whose input and output have been determined in the execution plan. Each operator only needs to get the values for the input variables, compute them, and finally put the results into the corresponding output variables. Therefore, it is only necessary to execute step by step from `Start`, and the result of the last operator is returned to the user as the final result.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Nebula Graph {{ nebula.base20 }} has changed a lot over its releases. The follow

- Vertex format

![The vertex format of storage service](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/storage-vertex-format.png)
![The vertex format of storage service](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/storage-vertex-format.png)

|Field|Description|
|:---|:---|
Expand All @@ -89,7 +89,7 @@ Nebula Graph {{ nebula.base20 }} has changed a lot over its releases. The follow

- Edge Format

![The edge format of storage service](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/storage-edge-format.png)
![The edge format of storage service](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/storage-edge-format.png)

|Field|Description|
|:---|:---|
Expand Down Expand Up @@ -126,7 +126,7 @@ Since in an ultra-large-scale relational network, vertices can be as many as ten

In Nebula Graph, an edge corresponds to two key-value pairs on the hard disk. When there are lots of edges and each has many properties, storage amplification will be obvious. The storage format of edges is shown in the figure below.

![edge storage](https://docs-cdn.nebula-graph.com.cn/docs-2.0/1.introduction/2.nebula-graph-architecture/two-edge-format.png)
![edge storage](https://docs-cdn.nebula-graph.com.cn/docs/1.introduction/2.nebula-graph-architecture/two-edge-format.png)

In this example, ScrVertex connects DstVertex via EdgeA, forming the path of `(SrcVertex)-[EdgeA]->(DstVertex)`. ScrVertex, DstVertex, and EdgeA will all be stored in Partition x and Partition y as four key-value pairs in the storage layer. Details are as follows:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Step 1: Install Nebula Graph

{% include "/source_install-nebula-graph-by-rpm-or-deb.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Step 3: Connect to Nebula Graph

{% include "/source_connect-to-nebula-graph.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For more information, see [nGQL guide](../3.ngql-guide/1.nGQL-overview/1.overvie

A Nebula Graph instance consists of one or more graph spaces. Graph spaces are physically isolated from each other. You can use different graph spaces in the same instance to store different datasets.

![Nebula Graph and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs-2.0/2.quick-start/nebula-graph-instance-and-graph-spaces.png)
![Nebula Graph and graph spaces](https://docs-cdn.nebula-graph.com.cn/docs/2.quick-start/nebula-graph-instance-and-graph-spaces.png)

To insert data into a graph space, define a schema for the graph database. Nebula Graph schema is based on the following components.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Step 2: Manage Nebula Graph Service

{% include "/source_manage-service.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,4 @@ Execution Plan

The Graphviz graph transformed from the above DOT statement is as follows.

![Graphviz graph of EXPLAIN SHOW TAGS](https://docs-cdn.nebula-graph.com.cn/docs-2.0/3.ngql-guide/16.query-tuning-statements/explain-show-tags.png)
![Graphviz graph of EXPLAIN SHOW TAGS](https://docs-cdn.nebula-graph.com.cn/docs/3.ngql-guide/16.query-tuning-statements/explain-show-tags.png)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Install Nebula Graph with RPM or DEB package

{% include "/source_install-nebula-graph-by-rpm-or-deb.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Connect to Nebula Graph

{% include "/source_connect-to-nebula-graph.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Manage Nebula Graph Service

{% include "/source_manage-service.md" %}
<!-- The line above is for content reusing. The source file is in the docs-2.0/reuse directory. -->
<!-- The line above is for content reusing. The source file is in the docs/reuse directory. -->
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
Loading