doc: key concepts

Signed-off-by: Sijie Shen <[email protected]>
GraphScope · May 15, 2024 · 583562b · 583562b
1 parent a2be8b1
commit 583562b
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 87 deletions.
diff --git a/docs/docs.rst b/docs/docs.rst
@@ -85,7 +85,8 @@ Read the Paper
    :hidden:
 
    documentation/design/architecture
-   documentation/design/key-concepts
+   documentation/design/rgmapping
+   documentation/design/graph-storage
 
 .. toctree::
    :maxdepth: 1

diff --git a/...ion/design/key-concepts/graph-storage.rst → docs/documentation/design/graph-storage.rst b/...ion/design/key-concepts/graph-storage.rst → docs/documentation/design/graph-storage.rst
diff --git a/docs/documentation/design/key-concepts.rst b/docs/documentation/design/key-concepts.rst
diff --git a/docs/documentation/design/key-concepts/graph-server.rst b/docs/documentation/design/key-concepts/graph-server.rst
diff --git a/...ntation/design/key-concepts/rgmapping.rst → docs/documentation/design/rgmapping.rst b/...ntation/design/key-concepts/rgmapping.rst → docs/documentation/design/rgmapping.rst
@@ -64,34 +64,34 @@ YAML
     method: append
     enableRowStore: false
     vertexMappings:
-    vertex_types:
-    - type_name: person
-        dataSourceName: PERSON
-        idFieldName: p_id
-        mappings:
-        - property: p_id
-        dataField:
-            name: P_ID
-        - property: p_name
-        dataField:
-            name: NAME
+        vertex_types:
+            - type_name: person
+              dataSourceName: PERSON
+              idFieldName: p_id
+              mappings:
+                - property: p_id
+                  dataField:
+                      name: P_ID
+                - property: p_name
+                  dataField:
+                      name: NAME
     edgeMappings:
-    edge_types:
-    - type_pair:
-        edge: transfer
-        source_vertex: person
-        destination_vertex: person
-        dataSourceName: TRANSFER
-        sourceVertexMappings:
-        - dataField:
-            name: P_ID1
-        destinationVertexMappings:
-        - dataField:
-            name: P_ID2
-        dataFieldMappings:
-        - property: t_date
-        dataField:
-            name: T_DATA
+        edge_types:
+            - type_pair:
+                edge: transfer
+                source_vertex: person
+                destination_vertex: person
+              dataSourceName: TRANSFER
+              sourceVertexMappings:
+                - dataField:
+                      name: P_ID1
+              destinationVertexMappings:
+                - dataField:
+                      name: P_ID2
+              dataFieldMappings:
+                - property: t_date
+                  dataField:
+                      name: T_DATA
 
 The RGMapping rule can also be written in `YAML`_. It defines the graph schema for the graph named ``ldbc``. It specifies the mapping between the vertices, edges and their properties in the graph and the columns in the table.