Skip to content

Commit d66d2e2

Browse files
Cheun99Cheun99
authored
[Doc][Improve] translate neo4j starrocks related chinese document (#8549)
1 parent 04db40d commit d66d2e2

File tree

3 files changed

+427
-0
lines changed

3 files changed

+427
-0
lines changed

Diff for: ‎docs/zh/connector-v2/sink/Neo4j.md

+144
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
# Neo4j
2+
3+
> Neo4j 写连接器
4+
5+
## 描述
6+
7+
写数据到 `Neo4j`。
8+
9+
`neo4j-java-driver` version 4.4.9
10+
11+
## 主要功能
12+
13+
- [ ] [精确一次](../../concept/connector-v2-features.md)
14+
15+
## 配置选项
16+
17+
| 名称 | 类型 | 是否必须 | 默认值 |
18+
|----------------------------|---------|------|----------|
19+
| uri | String | 是 | - |
20+
| username | String | 否 | - |
21+
| password | String | 否 | - |
22+
| max_batch_size | Integer | 否 | - |
23+
| write_mode | String | 否 | OneByOne |
24+
| bearer_token | String | 否 | - |
25+
| kerberos_ticket | String | 否 | - |
26+
| database | String | 是 | - |
27+
| query | String | 是 | - |
28+
| queryParamPosition | Object | 是 | - |
29+
| max_transaction_retry_time | Long | 否 | 30 |
30+
| max_connection_timeout | Long | 否 | 30 |
31+
| common-options | config | 否 | - |
32+
33+
### uri [string]
34+
35+
`Neo4j`数据库的URI，参考配置： `neo4j://localhost:7687`。
36+
37+
### username [string]
38+
39+
`Neo4j`用户名。
40+
41+
### password [string]
42+
43+
`Neo4j`密码。如果提供了“用户名”，则需要。
44+
45+
### max_batch_size[Integer]
46+
47+
`max_batch_size` 是指写入数据时，单个事务中可以写入的最大数据条目数。
48+
49+
### write_mode
50+
51+
默认值为 `oneByOne` ，如果您想批量写入，请将其设置为`Batch`
52+
53+
```cypher
54+
unwind $ttt as row create (n:Label) set n.name = row.name,n.age = rw.age
55+
```
56+
57+
`ttt`代表一批数据。，`ttt`可以是任意字符串，只要它与配置的`batch_data_variable` 匹配。
58+
59+
### bearer_token [string]
60+
61+
`Neo4j`的`base64`编码`bearer token`用于鉴权。
62+
63+
### kerberos_ticket [string]
64+
65+
`Neo4j`的`base64`编码`kerberos ticket`用于鉴权。
66+
67+
### database [string]
68+
69+
数据库名称。
70+
71+
### query [string]
72+
73+
查询语句。包含在运行时用相应值替换的参数占位符。
74+
75+
### queryParamPosition [object]
76+
77+
查询参数的位置映射信息。
78+
79+
键名是参数占位符名称。
80+
81+
关联值是字段在输入数据行中的位置。
82+
83+
### max_transaction_retry_time [long]
84+
85+
最大事务重试时间（秒）。如果超过，则交易失败。
86+
87+
### max_connection_timeout [long]
88+
89+
等待TCP连接建立的最长时间（秒）。
90+
91+
### common options
92+
93+
Sink插件常用参数， 详细信息请参考 [Sink公共配置](../sink-common-options.md)
94+
95+
## OneByOne模式写示例
96+
97+
```
98+
sink {
99+
Neo4j {
100+
uri = "neo4j://localhost:7687"
101+
username = "neo4j"
102+
password = "1234"
103+
database = "neo4j"
104+
max_transaction_retry_time = 10
105+
max_connection_timeout = 10
106+
query = "CREATE (a:Person {name: $name, age: $age})"
107+
queryParamPosition = {
108+
name = 0
109+
age = 1
110+
}
111+
}
112+
}
113+
```
114+
115+
## Batch模式写示例
116+
> cypher提供的`unwind`关键字支持批量写入，
117+
> 批量数据的默认变量是batch。如果你写一个批处理写语句，
118+
> 那么你应该声明 cypher `unwind $batch` 作为行
119+
```
120+
sink {
121+
Neo4j {
122+
uri = "bolt://localhost:7687"
123+
username = "neo4j"
124+
password = "neo4j"
125+
database = "neo4j"
126+
max_batch_size = 1000
127+
write_mode = "BATCH"
128+
max_transaction_retry_time = 3
129+
max_connection_timeout = 10
130+
query = "unwind $batch as row create(n:MyLabel) set n.name = row.name,n.age = row.age"
131+
}
132+
}
133+
```
134+
135+
## Changelog
136+
137+
### 2.2.0-beta 2022-09-26
138+
139+
- 添加 Neo4j 写连接器
140+
141+
### issue ##4835
142+
143+
- 写连接器支持批量写入
144+

Diff for: ‎docs/zh/connector-v2/source/Neo4j.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Neo4j
2+
3+
> Neo4j 源连接器器
4+
5+
## 描述
6+
7+
从 `Neo4j` 读取数据
8+
9+
`neo4j-java-driver` 版本 4.4.9
10+
11+
## 主要功能
12+
13+
- [x] [批处理](../../concept/connector-v2-features.md)
14+
- [ ] [流处理](../../concept/connector-v2-features.md)
15+
- [ ] [精确一次](../../concept/connector-v2-features.md)
16+
- [x] [列投影](../../concept/connector-v2-features.md)
17+
- [ ] [并行度](../../concept/connector-v2-features.md)
18+
- [ ] [支持用户定义拆分](../../concept/connector-v2-features.md)
19+
20+
## 配置选项
21+
22+
| 名称 | 类型 | 是否必须 | 默认值 |
23+
|----------------------------|--------|------|-----|
24+
| uri | String | 是 | - |
25+
| username | String | 否 | - |
26+
| password | String | 否 | - |
27+
| bearer_token | String | 否 | - |
28+
| kerberos_ticket | String | 否 | - |
29+
| database | String | 是 | - |
30+
| query | String | 是 | - |
31+
| schema | Object | 是 | - |
32+
| max_transaction_retry_time | Long | 否 | 30 |
33+
| max_connection_timeout | Long | 否 | 30 |
34+
35+
### uri [string]
36+
37+
`Neo4j`数据库的URI，参考配置： `neo4j://localhost:7687`。
38+
39+
### username [string]
40+
41+
`Neo4j`用户名。
42+
43+
### password [string]
44+
45+
`Neo4j`密码。如果提供了“用户名”，则需要。
46+
47+
### bearer_token [string]
48+
49+
`Neo4j`的`base64`编码`bearer token`用于鉴权。
50+
51+
### kerberos_ticket [string]
52+
53+
`Neo4j`的`base64`编码`kerberos ticket`用于鉴权。
54+
55+
### database [string]
56+
57+
数据库名。
58+
59+
### query [string]
60+
61+
查询语句。
62+
63+
### schema.fields [string]
64+
65+
返回`query` 的字段。
66+
67+
查看 [列投影](../../concept/connector-v2-features.md)
68+
69+
### max_transaction_retry_time [long]
70+
71+
最大事务重试时间（秒）。如果超过，则事务失败。
72+
73+
### max_connection_timeout [long]
74+
75+
等待TCP连接建立的最长时间（秒）。
76+
77+
## 示例
78+
79+
```
80+
source {
81+
Neo4j {
82+
uri = "neo4j://localhost:7687"
83+
username = "neo4j"
84+
password = "1234"
85+
database = "neo4j"
86+
max_transaction_retry_time = 1
87+
max_connection_timeout = 1
88+
query = "MATCH (a:Person) RETURN a.name, a.age"
89+
schema {
90+
fields {
91+
a.age=INT
92+
a.name=STRING
93+
}
94+
}
95+
}
96+
}
97+
```
98+
99+
100+

0 commit comments

Comments
 (0)