Skip to content

Commit f9378f4

Browse files
committed
readme oracle side、sink doc
1 parent 4fe99de commit f9378f4

File tree

3 files changed

+142
-0
lines changed

3 files changed

+142
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ sh submit.sh -sql D:\sideSql.txt -name xctest -remoteSqlPluginPath /opt/dtstack
173173
* [elasticsearch 结果表插件](docs/elasticsearchSink.md)
174174
* [hbase 结果表插件](docs/hbaseSink.md)
175175
* [mysql 结果表插件](docs/mysqlSink.md)
176+
* [oracle 结果表插件](docs/oracleSink.md)
176177
* [mongo 结果表插件](docs/mongoSink.md)
177178
* [redis 结果表插件](docs/redisSink.md)
178179
* [cassandra 结果表插件](docs/cassandraSink.md)
@@ -183,6 +184,7 @@ sh submit.sh -sql D:\sideSql.txt -name xctest -remoteSqlPluginPath /opt/dtstack
183184
### 2.3 维表插件
184185
* [hbase 维表插件](docs/hbaseSide.md)
185186
* [mysql 维表插件](docs/mysqlSide.md)
187+
* [oracle 维表插件](docs/oracleSide.md)
186188
* [mongo 维表插件](docs/mongoSide.md)
187189
* [redis 维表插件](docs/redisSide.md)
188190
* [cassandra 维表插件](docs/cassandraSide.md)

docs/oracleSide.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
## 1.格式:
3+
```
4+
CREATE TABLE tableName(
5+
colName cloType,
6+
...
7+
PRIMARY KEY(keyInfo),
8+
PERIOD FOR SYSTEM_TIME
9+
)WITH(
10+
type='oracle',
11+
url='jdbcUrl',
12+
userName='dbUserName',
13+
password='dbPwd',
14+
tableName='tableName',
15+
cache ='LRU',
16+
schema = 'MQTEST',
17+
parallelism ='1',
18+
partitionedJoin='false'
19+
);
20+
```
21+
22+
# 2.支持版本
23+
10g 11g
24+
25+
## 3.表结构定义
26+
27+
|参数名称|含义|
28+
|----|---|
29+
| tableName | oracle表名称|
30+
| colName | 列名称|
31+
| colType | 列类型 [colType支持的类型](colType.md)|
32+
| PERIOD FOR SYSTEM_TIME | 关键字表明该定义的表为维表信息|
33+
| PRIMARY KEY(keyInfo) | 维表主键定义;多个列之间用逗号隔开|
34+
35+
## 4.参数
36+
37+
|参数名称|含义|是否必填|默认值|
38+
|----|---|---|----|
39+
| type | 表明维表的类型 oracle |||
40+
| url | 连接oracle数据库 jdbcUrl |||
41+
| userName | oracle连接用户名 |||
42+
| password | oracle连接密码|||
43+
| tableName | oracle表名称|||
44+
| schema | oracle 的schema||当前登录用户|
45+
| cache | 维表缓存策略(NONE/LRU)||NONE|
46+
| partitionedJoin | 是否在維表join之前先根据 設定的key 做一次keyby操作(可以減少维表的数据缓存量)||false|
47+
48+
----------
49+
> 缓存策略
50+
* NONE: 不做内存缓存
51+
* LRU:
52+
* cacheSize: 缓存的条目数量
53+
* cacheTTLMs:缓存的过期时间(ms)
54+
* cacheMode: (unordered|ordered)异步加载是有序还是无序,默认有序。
55+
* asyncCapacity:异步请求容量,默认1000
56+
* asyncTimeout:异步请求超时时间,默认10000毫秒
57+
58+
## 5.样例
59+
```
60+
create table sideTable(
61+
channel varchar,
62+
xccount int,
63+
PRIMARY KEY(channel),
64+
PERIOD FOR SYSTEM_TIME
65+
)WITH(
66+
type='oracle',
67+
url='jdbc:oracle:thin:@xx.xx.xx.xx:1521:orcl',
68+
userName='xx',
69+
password='xx',
70+
tableName='sidetest',
71+
cache ='LRU',
72+
cacheSize ='10000',
73+
cacheTTLMs ='60000',
74+
cacheMode='unordered',
75+
asyncCapacity='1000',
76+
asyncTimeout='10000'
77+
parallelism ='1',
78+
partitionedJoin='false',
79+
schema = 'MQTEST'
80+
);
81+
82+
83+
```
84+
85+

docs/oracleSink.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## 1.格式:
2+
```
3+
CREATE TABLE tableName(
4+
colName colType,
5+
...
6+
colNameX colType
7+
)WITH(
8+
type ='oracle',
9+
url ='jdbcUrl',
10+
userName ='userName',
11+
password ='pwd',
12+
tableName ='tableName',
13+
parallelism ='parllNum'
14+
);
15+
16+
```
17+
18+
## 2.支持版本
19+
10g 11g
20+
21+
## 3.表结构定义
22+
23+
|参数名称|含义|
24+
|----|---|
25+
| tableName| oracle表名称|
26+
| colName | 列名称|
27+
| colType | 列类型 [colType支持的类型](colType.md)|
28+
29+
## 4.参数:
30+
31+
|参数名称|含义|是否必填|默认值|
32+
|----|----|----|----|
33+
|type |表名 输出表类型[mysq|hbase|elasticsearch|oracle]|||
34+
|url | 连接oracle数据库 jdbcUrl |||
35+
|userName | oracle连接用户名 |||
36+
| password | oracle连接密码|||
37+
| tableName | oracle表名称|||
38+
| schema | oracle 的schema||当前登录用户|
39+
| parallelism | 并行度设置||1|
40+
41+
## 5.样例:
42+
```
43+
CREATE TABLE MyResult(
44+
channel VARCHAR,
45+
pv VARCHAR
46+
)WITH(
47+
type ='oracle',
48+
url ='jdbc:oracle:thin:@xx.xx.xx.xx:1521:orcl',
49+
userName ='dtstack',
50+
password ='abc123',
51+
tableName ='pv2',
52+
schema = 'MQTEST',
53+
parallelism ='1'
54+
)
55+
```

0 commit comments

Comments
 (0)