Skip to content

Commit 00758df

Browse files
committed
[Doc] update readme
1. use partition table in example 2. add link for deploying config server 3. add Chinese doc link Link: https://code.alibaba-inc.com/oceanbase/obkv-table-client-java/codereview/12457946 * [Doc] update readme 1. use partition table in example 2. add link for deploying config server 3. add Chinese doc link * [Doc] update readme 1. use partition table in example 2. add link for deploying config server 3. add Chinese doc link * [Doc] update readme 1. use partition table in example 2. add link for deploying config server 3. add Chinese doc link
1 parent 24c4617 commit 00758df

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ CREATE TABLE IF NOT EXISTS `test_varchar_table` (
1010
`c1` varchar(20) NOT NULL,
1111
`c2` varchar(20) DEFAULT NULL,
1212
PRIMARY KEY (`c1`)
13-
);
13+
) PARTITION BY KEY(`c1`) PARTITIONS 10;
1414
```
1515

1616
Import the dependency for your maven project:
1717
``` xml
1818
<dependency>
1919
<groupId>com.oceanbase</groupId>
2020
<artifactId>obkv-table-client</artifactId>
21-
<version>0.1.0</version>
21+
<version>1.1.1</version>
2222
</dependency>
2323
```
2424

@@ -32,7 +32,10 @@ The code demo:
3232
obTableClient.setSysUserName("sys_user_name");
3333
obTableClient.setSysPassword("sys_user_passwd");
3434
obTableClient.init();
35-
35+
36+
// set primary key for partition table
37+
obTableClient.addRowKeyElement("test_varchar_table", new String[]{"c1"});
38+
3639
// 2. single execute
3740
// return affectedRows
3841
obTableClient.insert("test_varchar_table", "foo", new String[] { "c2" }, new String[] { "bar" });
@@ -51,16 +54,18 @@ The code demo:
5154
// the results include 3 item: 1. affectedRows; 2. Map; 3. affectedRows.
5255
```
5356
**NOTE:**
54-
1. param_url is generated by ConfigServer (link TODO).
57+
1. param_url is generated by [ConfigServer](https://ask.oceanbase.com/t/topic/35601923).
5558
2. More example [Demo](https://github.com/oceanbase/obkv-table-client-java/tree/master/example)
59+
4. full_user_name: the user for accessing obkv, which format is `user_name@tenant_name#cluster_name`
60+
5. sys_user_name: `root@sys` or `proxy@sys`, which have privileges to access routing system view
5661

5762
## Release Notes
5863
Latest release notes could be found in [Release notes](https://github.com/oceanbase/obkv-table-client-java/wiki#release-notes)
5964

6065
## Documentation
6166

6267
- English [Coming soon]
63-
- Simplified Chinese (简体中文) [Coming soon]
68+
- [Simplified Chinese (简体中文)](https://github.com/oceanbase/obkv-table-client-java/wiki/OBKV-Java%E5%AE%A2%E6%88%B7%E7%AB%AF-%E8%AF%B4%E6%98%8E%E6%96%87%E6%A1%A3)
6469

6570
## Licencing
6671

0 commit comments

Comments
 (0)