OBKV Table Client
OBKV Table Client is Java Library that can be used to access table data from OceanBase storage layer. Its access method is different from JDBC, it skips the SQL parsing layer, so it has significant performance advantage.
Quick start
Create table in the OceanBase database:
CREATE TABLE IF NOT EXISTS `test_varchar_table` (
`c1` varchar(20) NOT NULL,
`c2` varchar(20) DEFAULT NULL,
PRIMARY KEY (`c1`)
);
Import the dependency for your maven project:
<dependency>
<groupId>com.oceanbase</groupId>
<artifactId>obkv-table-client</artifactId>
<version>0.1.0</version>
</dependency>
The code demo:
// 1. initail ObTableClient
ObTableClient obTableClient = new ObTableClient();
obTableClient.setFullUserName("full_user_name");
obTableClient.setParamURL("param_url");
obTableClient.setPassword("password");
obTableClient.setSysUserName("sys_user_name");
obTableClient.setSysPassword("sys_user_passwd");
obTableClient.init();
// 2. single execute
// return affectedRows
obTableClient.insert("test_varchar_table", "foo", new String[] { "c2" }, new String[] { "bar" });
// return Map<String, Object>
obTableClient.get("test_varchar_table", "foo", new String[] { "c2" });
// return affectedRows
obTableClient.delete("test_varchar_table", "foo");
// 3. batch execute
TableBatchOps batchOps = obTableClient.batch("test_varchar_table");
batchOps.insert("foo", new String[] { "c2" }, new String[] { "bar" });
batchOps.get("foo", new String[] { "c2" });
batchOps.delete("foo");
List<Object> results = batchOps.execute();
// the results include 3 item: 1. affectedRows; 2. Map; 3. affectedRows.
NOTE:
- param_url is generated by ConfigServer (link TODO).
- More example Demo
Documentation
- English [Coming soon]
- Simplified Chinese (简体中文) [Coming soon]
Licencing
OBKV Table Client is under MulanPSL - 2.0 licence. You can freely copy and use the source code. When you modify or distribute the source code, please obey the MulanPSL - 2.0 licence.
Contributing
Contributions are warmly welcomed and greatly appreciated. Here are a few ways you can contribute:
- Raise us an Issue
- Submit Pull Requests. For details, see How to contribute.
Support
In case you have any problems when using OceanBase Database, welcome reach out for help:
- GitHub Issue GitHub Issue
- Official forum Official website
- Knowledge base [Coming soon]
3 Apr 28, 2022
36 Jan 3, 2023
71 Jan 8, 2023
9 Dec 2, 2022
10 Dec 25, 2022
1 Sep 12, 2022
78 Dec 26, 2022
11 Jan 3, 2023
7 Aug 9, 2022
35 Nov 8, 2022
24 Dec 15, 2022
62 Jan 3, 2023
2 Aug 4, 2022
16 Oct 19, 2022
3 Sep 17, 2022
16 Dec 13, 2022
2 Apr 23, 2022
21 Dec 28, 2022
7 Dec 15, 2022