Skip to content

Commit 0d7ca63

Browse files
committed
Update README.md
1 parent 797c280 commit 0d7ca63

File tree

1 file changed

+44
-21
lines changed

1 file changed

+44
-21
lines changed

README.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ graph TB
2020
SERVER[("Graph Database")]
2121
end
2222
23+
subgraph distributed ["Distributed Mode (Optional)"]
24+
PD["hugegraph-pd<br/>(Placement Driver)"]
25+
STORE["hugegraph-store<br/>(Storage Nodes)"]
26+
end
27+
2328
subgraph clients ["Client SDKs"]
2429
CLIENT["hugegraph-client<br/>(Java)"]
25-
CLIENT_GO["hugegraph-client-go<br/>(Go)"]
2630
end
2731
2832
subgraph data ["Data Tools"]
@@ -36,37 +40,49 @@ graph TB
3640
end
3741
3842
SERVER <-->|REST API| CLIENT
39-
SERVER <-->|REST API| CLIENT_GO
43+
PD -.->|coordinates| STORE
44+
SERVER -.->|distributed backend| PD
4045
4146
CLIENT --> LOADER
4247
CLIENT --> HUBBLE
4348
CLIENT --> TOOLS
4449
CLIENT --> SPARK
50+
HUBBLE -.->|WIP: pd-client| PD
4551
4652
LOADER -.->|Sources| SRC["CSV | JSON | HDFS<br/>MySQL | Kafka"]
4753
SPARK -.->|I/O| SPK["Spark DataFrames"]
54+
55+
style distributed stroke-dasharray: 5 5
4856
```
4957

5058
<details>
5159
<summary>ASCII diagram (for terminals/editors)</summary>
5260

5361
```
54-
┌─────────────────────────┐
55-
│ HugeGraph Server │
56-
│ (Graph Database) │
57-
└───────────┬─────────────┘
58-
│ REST API
59-
┌─────────────────────┼─────────────────────┐
60-
│ │ │
61-
▼ ▼ ▼
62-
┌────────────────┐ ┌────────────────┐ ┌────────────────┐
63-
│ hugegraph- │ │ hugegraph- │ │ Other REST │
64-
│ client (Java) │ │ client-go │ │ Clients │
65-
└───────┬────────┘ └────────────────┘ └────────────────┘
66-
│ depends on
67-
┌───────────┼───────────┬───────────────────┐
68-
│ │ │ │
69-
▼ ▼ ▼ ▼
62+
┌─────────────────────────┐
63+
│ HugeGraph Server │
64+
│ (Graph Database) │
65+
└───────────┬─────────────┘
66+
│ REST API
67+
┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┼ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐
68+
Distributed (Optional)│
69+
│ ┌───────────┐ │ ┌───────────┐ │
70+
│hugegraph- │◄──────┴──────►│hugegraph- │
71+
│ │ pd │ │ store │ │
72+
└───────────┘ └───────────┘
73+
└ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘
74+
75+
┌─────────────────────┼─────────────────────┐
76+
│ │ │
77+
▼ ▼ ▼
78+
┌────────────────┐ ┌────────────────┐ ┌────────────────┐
79+
│ hugegraph- │ │ Other Client │ │ Other REST │
80+
│ client (Java) │ │ SDKs (Go/Py) │ │ Clients │
81+
└───────┬────────┘ └────────────────┘ └────────────────┘
82+
│ depends on
83+
┌───────┼───────────┬───────────────────┐
84+
│ │ │ │
85+
▼ ▼ ▼ ▼
7086
┌────────┐ ┌────────┐ ┌──────────┐ ┌───────────────────┐
7187
│ loader │ │ hubble │ │ tools │ │ spark-connector │
7288
│ (ETL) │ │ (Web) │ │ (CLI) │ │ (Spark I/O) │
@@ -83,7 +99,7 @@ graph TB
8399
| JDK | 11+ | LTS recommended |
84100
| Maven | 3.6+ | For building from source |
85101
| HugeGraph Server | 1.5.0+ | Required for client/loader |
86-
| Docker | 20.10+ | Optional, for quick start |
102+
| Docker | - | Optional, for quick start |
87103

88104
### Choose Your Path
89105

@@ -139,9 +155,12 @@ Vertex vertex = client.graph().addVertex(T.label, "person", "name", "Alice");
139155

140156
---
141157

142-
### hugegraph-client-go
158+
### Other Client SDKs
159+
160+
<details>
161+
<summary><b>hugegraph-client-go</b> (Go SDK - WIP)</summary>
143162

144-
**Purpose**: Official Go SDK for HugeGraph Server (WIP)
163+
**Purpose**: Official Go SDK for HugeGraph Server
145164

146165
**Key Features**:
147166
- RESTful API client for HugeGraph
@@ -161,6 +180,10 @@ client := hugegraph.NewClient("http://localhost:8080", "hugegraph")
161180

162181
📁 [Source](./hugegraph-client-go)
163182

183+
</details>
184+
185+
> **Looking for other languages?** See [hugegraph-python-client](https://github.com/apache/incubator-hugegraph-ai/tree/main/hugegraph-python-client) in the hugegraph-ai repository.
186+
164187
---
165188

166189
### hugegraph-loader

0 commit comments

Comments
 (0)