Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.

Commit 8ea5866

Browse files
author
mrrtree
authored
Doc/update sdk (#48)
* update golang sdk to v1.1.0 * update java sdk for 1.0.0
1 parent 3a13c3c commit 8ea5866

4 files changed

Lines changed: 76 additions & 71 deletions

File tree

‎docs/src/cn/sdk/go.md‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ ceresdb.Client 是 CeresDB 的 Golang 版客户端。
77
## 安装
88

99
```
10-
go get github.com/CeresDB/ceresdb-client-go/ceresdb
10+
go get github.com/CeresDB/ceresdb-client-go@v1.1.0
1111
```
1212

1313
## 如何使用
1414

1515
### 初始化客户端
1616

1717
```go
18-
client, err := ceresdb.NewClient(endpoint, types.Direct,
18+
client, err := ceresdb.NewClient(endpoint, ceresdb.Direct,
1919
ceresdb.WithDefaultDatabase("public"), // Client所使用的database
2020
)
2121
```
@@ -38,13 +38,15 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
3838
**创建表的样例**
3939

4040
```go
41-
createTableSQL := `CREATE TABLE IF NOT EXISTS demo (
42-
name string TAG,
43-
value double,
44-
t timestamp NOT NULL,
45-
TIMESTAMP KEY(t)) ENGINE=Analytic with (enable_ttl=false)`
46-
47-
req := types.SQLQueryRequest{
41+
createTableSQL := `
42+
CREATE TABLE IF NOT EXISTS demo (
43+
name string TAG,
44+
value double,
45+
t timestamp NOT NULL,
46+
TIMESTAMP KEY(t)
47+
) ENGINE=Analytic with (enable_ttl=false)`
48+
49+
req := ceresdb.SQLQueryRequest{
4850
Tables: []string{"demo"},
4951
SQL: createTableSQL,
5052
}
@@ -55,7 +57,7 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
5557

5658
```go
5759
dropTableSQL := `DROP TABLE demo`
58-
req := types.SQLQueryRequest{
60+
req := ceresdb.SQLQueryRequest{
5961
Tables: []string{"demo"},
6062
SQL: dropTableSQL,
6163
}
@@ -65,12 +67,12 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
6567
### 构建写入数据
6668

6769
```go
68-
points := make([]types.Point, 0, 2)
70+
points := make([]ceresdb.Point, 0, 2)
6971
for i := 0; i < 2; i++ {
7072
point, err := ceresdb.NewPointBuilder("demo").
71-
SetTimestamp(utils.CurrentMS()).
72-
AddTag("name", types.NewStringValue("test_tag1")).
73-
AddField("value", types.NewDoubleValue(0.4242)).
73+
SetTimestamp(now)).
74+
AddTag("name", ceresdb.NewStringValue("test_tag1")).
75+
AddField("value", ceresdb.NewDoubleValue(0.4242)).
7476
Build()
7577
if err != nil {
7678
panic(err)
@@ -82,7 +84,7 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
8284
### 写入数据
8385

8486
```go
85-
req := types.WriteRequest{
87+
req := ceresdb.WriteRequest{
8688
Points: points,
8789
}
8890
resp, err := client.Write(context.Background(), req)
@@ -92,7 +94,7 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
9294

9395
```go
9496
querySQL := `SELECT * FROM demo`
95-
req := types.SQLQueryRequest{
97+
req := ceresdb.SQLQueryRequest{
9698
Tables: []string{"demo"},
9799
SQL: querySQL,
98100
}

‎docs/src/cn/sdk/java.md‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ CeresDB 是一个 Schema-less 的时序数据引擎，你可以不必创建 sche
5353
下面的建表语句（使用 SDK 的 SQL API）包含了 CeresDB 支持的所有字段类型：
5454

5555
```java
56-
String createTableSql = "CREATE TABLE IF NOT EXISTS machine_table(" + "ts TIMESTAMP NOT NULL," + //
56+
String createTableSql = "CREATE TABLE IF NOT EXISTS machine_table(" +
5757
"ts TIMESTAMP NOT NULL," +
5858
"city STRING TAG NOT NULL," +
5959
"ip STRING TAG NOT NULL," +
@@ -90,9 +90,12 @@ List<Point> pointList = new LinkedList<>();
9090
for (int i = 0; i < 100; i++) {
9191
// 构建单个Point
9292
final Point point = Point.newPointBuilder("machine_table")
93-
.setTimestamp(t0).addTag("city", "Singapore")
94-
.addTag("ip", "10.0.0.1").addField("cpu", Value.withDouble(0.23))
95-
.addField("mem", Value.withDouble(0.55)).build();
93+
.setTimestamp(t0)
94+
.addTag("city", "Singapore")
95+
.addTag("ip", "10.0.0.1")
96+
.addField("cpu", Value.withDouble(0.23))
97+
.addField("mem", Value.withDouble(0.55))
98+
.build();
9699
points.add(point);
97100
}
98101
```
@@ -132,11 +135,11 @@ Assert.assertEquals(1, queryOk.getRowCount());
132135

133136
// 直接获取结果数组
134137
final List<Row> rows = queryOk.getRowList();
135-
Assert.assertEquals(t0, rows.get(0).getColumnValue("ts").getTimestamp());
136-
Assert.assertEquals("Singapore", rows.get(0).getColumnValue("city").getString());
137-
Assert.assertEquals("10.0.0.1", rows.get(0).getColumnValue("ip").getString());
138-
Assert.assertEquals(0.23, rows.get(0).getColumnValue("cpu").getDouble(), 0.0000001);
139-
Assert.assertEquals(0.55, rows.get(0).getColumnValue("mem").getDouble(), 0.0000001);
138+
Assert.assertEquals(t0, rows.get(0).getColumn("ts").getValue().getTimestamp());
139+
Assert.assertEquals("Singapore", rows.get(0).getColumn("city").getValue().getString());
140+
Assert.assertEquals("10.0.0.1", rows.get(0).getColumn("ip").getValue().getString());
141+
Assert.assertEquals(0.23, rows.get(0).getColumn("cpu").getValue().getDouble(), 0.0000001);
142+
Assert.assertEquals(0.55, rows.get(0).getColumn("mem").getValue().getDouble(), 0.0000001);
140143

141144
// 获取结果流
142145
final Stream<Row> rowStream = queryOk.stream();
@@ -154,16 +157,14 @@ long start = System.currentTimeMillis();
154157
long t = start;
155158
final StreamWriteBuf<Point, WriteOk> writeBuf = client.streamWrite("machine_table");
156159
for (int i = 0; i < 1000; i++) {
157-
final List<Point> streamData = Point.newPointsBuilder("machine_table")
158-
.addPoint()
159-
.setTimestamp(t)
160-
.addTag("city", "Beijing")
161-
.addTag("ip", "10.0.0.3")
162-
.addField("cpu", Value.withDouble(0.42))
163-
.addField("mem", Value.withDouble(0.67))
164-
.build()
165-
.build();
166-
writeBuf.writeAndFlush(streamData);
160+
final Point streamData = Point.newPointBuilder("machine_table")
161+
.setTimestamp(t)
162+
.addTag("city", "Beijing")
163+
.addTag("ip", "10.0.0.3")
164+
.addField("cpu", Value.withDouble(0.42))
165+
.addField("mem", Value.withDouble(0.67))
166+
.build();
167+
writeBuf.writeAndFlush(Collections.singletonList(streamData));
167168
t = t+1;
168169
}
169170
final CompletableFuture<WriteOk> writeOk = writeBuf.completed();

‎docs/src/en/sdk/go.md‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ ceresdb.Client is a Golang client for CeresDB.
77
## Installation
88

99
```
10-
go get github.com/CeresDB/ceresdb-client-go/ceresdb
10+
go get github.com/CeresDB/ceresdb-client-go@v1.1.0
1111
```
1212

1313
## How To Use
1414

1515
### Init CeresDB Client
1616

1717
```go
18-
client, err := ceresdb.NewClient(endpoint, types.Direct,
18+
client, err := ceresdb.NewClient(endpoint, ceresdb.Direct,
1919
ceresdb.WithDefaultDatabase("public"),
2020
)
2121
```
@@ -39,13 +39,15 @@ CeresDB is a Schema-less time-series database, so creating table schema ahead of
3939
**Example for creating table**
4040

4141
```go
42-
createTableSQL := `CREATE TABLE IF NOT EXISTS demo (
43-
name string TAG,
44-
value double,
45-
t timestamp NOT NULL,
46-
TIMESTAMP KEY(t)) ENGINE=Analytic with (enable_ttl=false)`
47-
48-
req := types.SQLQueryRequest{
42+
createTableSQL := `
43+
CREATE TABLE IF NOT EXISTS demo (
44+
name string TAG,
45+
value double,
46+
t timestamp NOT NULL,
47+
TIMESTAMP KEY(t)
48+
) ENGINE=Analytic with (enable_ttl=false)`
49+
50+
req := ceresdb.SQLQueryRequest{
4951
Tables: []string{"demo"},
5052
SQL: createTableSQL,
5153
}
@@ -56,7 +58,7 @@ CeresDB is a Schema-less time-series database, so creating table schema ahead of
5658

5759
```go
5860
dropTableSQL := `DROP TABLE demo`
59-
req := types.SQLQueryRequest{
61+
req := ceresdb.SQLQueryRequest{
6062
Tables: []string{"demo"},
6163
SQL: dropTableSQL,
6264
}
@@ -66,12 +68,12 @@ CeresDB is a Schema-less time-series database, so creating table schema ahead of
6668
### How To Build Write Data
6769

6870
```go
69-
points := make([]types.Point, 0, 2)
71+
points := make([]ceresdb.Point, 0, 2)
7072
for i := 0; i < 2; i++ {
7173
point, err := ceresdb.NewPointBuilder("demo").
72-
SetTimestamp(utils.CurrentMS()).
73-
AddTag("name", types.NewStringValue("test_tag1")).
74-
AddField("value", types.NewDoubleValue(0.4242)).
74+
SetTimestamp(now).
75+
AddTag("name", ceresdb.NewStringValue("test_tag1")).
76+
AddField("value", ceresdb.NewDoubleValue(0.4242)).
7577
Build()
7678
if err != nil {
7779
panic(err)
@@ -83,7 +85,7 @@ CeresDB is a Schema-less time-series database, so creating table schema ahead of
8385
### Write Example
8486

8587
```go
86-
req := types.WriteRequest{
88+
req := ceresdb.WriteRequest{
8789
Points: points,
8890
}
8991
resp, err := client.Write(context.Background(), req)
@@ -93,7 +95,7 @@ CeresDB is a Schema-less time-series database, so creating table schema ahead of
9395

9496
```go
9597
querySQL := `SELECT * FROM demo`
96-
req := types.SQLQueryRequest{
98+
req := ceresdb.SQLQueryRequest{
9799
Tables: []string{"demo"},
98100
SQL: querySQL,
99101
}

‎docs/src/en/sdk/java.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following table creation statement（using the SQL API included in SDK ）sh
5656

5757
```java
5858
// Create table manually, creating table schema ahead of data ingestion is not required
59-
String createTableSql = "CREATE TABLE IF NOT EXISTS machine_table(" + "ts TIMESTAMP NOT NULL," + //
59+
String createTableSql = "CREATE TABLE IF NOT EXISTS machine_table(" +
6060
"ts TIMESTAMP NOT NULL," +
6161
"city STRING TAG NOT NULL," +
6262
"ip STRING TAG NOT NULL," +
@@ -93,9 +93,12 @@ List<Point> pointList = new LinkedList<>();
9393
for (int i = 0; i < 100; i++) {
9494
// build one point
9595
final Point point = Point.newPointBuilder("machine_table")
96-
.setTimestamp(t0).addTag("city", "Singapore")
97-
.addTag("ip", "10.0.0.1").addField("cpu", Value.withDouble(0.23))
98-
.addField("mem", Value.withDouble(0.55)).build();
96+
.setTimestamp(t0)
97+
.addTag("city", "Singapore")
98+
.addTag("ip", "10.0.0.1")
99+
.addField("cpu", Value.withDouble(0.23))
100+
.addField("mem", Value.withDouble(0.55))
101+
.build();
99102
points.add(point);
100103
}
101104
```
@@ -133,11 +136,11 @@ Assert.assertEquals(1, queryOk.getRowCount());
133136

134137
// get rows as list
135138
final List<Row> rows = queryOk.getRowList();
136-
Assert.assertEquals(t0, rows.get(0).getColumnValue("ts").getTimestamp());
137-
Assert.assertEquals("Singapore", rows.get(0).getColumnValue("city").getString());
138-
Assert.assertEquals("10.0.0.1", rows.get(0).getColumnValue("ip").getString());
139-
Assert.assertEquals(0.23, rows.get(0).getColumnValue("cpu").getDouble(), 0.0000001);
140-
Assert.assertEquals(0.55, rows.get(0).getColumnValue("mem").getDouble(), 0.0000001);
139+
Assert.assertEquals(t0, rows.get(0).getColumn("ts").getValue().getTimestamp());
140+
Assert.assertEquals("Singapore", rows.get(0).getColumn("city").getValue().getString());
141+
Assert.assertEquals("10.0.0.1", rows.get(0).getColumn("ip").getValue().getString());
142+
Assert.assertEquals(0.23, rows.get(0).getColumn("cpu").getValue().getDouble(), 0.0000001);
143+
Assert.assertEquals(0.55, rows.get(0).getColumn("mem").getValue().getDouble(), 0.0000001);
141144

142145
// get rows as stream
143146
final Stream<Row> rowStream = queryOk.stream();
@@ -154,18 +157,15 @@ CeresDB support streaming writing and reading，suitable for large-scale data re
154157
long start = System.currentTimeMillis();
155158
long t = start;
156159
final StreamWriteBuf<Point, WriteOk> writeBuf = client.streamWrite("machine_table");
157-
158160
for (int i = 0; i < 1000; i++) {
159-
final List<Point> streamData = Point.newPointsBuilder("machine_table")
160-
.addPoint()
161-
.setTimestamp(t)
162-
.addTag("city", "Beijing")
163-
.addTag("ip", "10.0.0.3")
164-
.addField("cpu", Value.withDouble(0.42))
165-
.addField("mem", Value.withDouble(0.67))
166-
.build()
167-
.build();
168-
writeBuf.writeAndFlush(streamData);
161+
final Point streamData = Point.newPointBuilder("machine_table")
162+
.setTimestamp(t)
163+
.addTag("city", "Beijing")
164+
.addTag("ip", "10.0.0.3")
165+
.addField("cpu", Value.withDouble(0.42))
166+
.addField("mem", Value.withDouble(0.67))
167+
.build();
168+
writeBuf.writeAndFlush(Collections.singletonList(streamData));
169169
t = t+1;
170170
}
171171
final CompletableFuture<WriteOk> writeOk = writeBuf.completed();

0 commit comments

Comments
 (0)