This is an automated email from the ASF dual-hosted git repository.
baojinri pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/horaedb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 09c72af chore: polish sdk dev (#160)
09c72af is described below
commit 09c72af31ce274fae4090127f306c5e8a90f8639
Author: Jiacai Liu <[email protected]>
AuthorDate: Tue Nov 26 16:02:31 2024 +0800
chore: polish sdk dev (#160)
---
content/cn/docs/getting-started.md | 4 ++--
content/en/docs/dev/sdk_develop.md | 36 ++++++++++++++++++++++--------------
content/en/docs/getting-started.md | 4 ++--
static/config_kafka_oss.toml | 2 +-
static/config_local_oss.toml | 2 +-
static/config_obkv_oss.toml | 2 +-
6 files changed, 29 insertions(+), 21 deletions(-)
diff --git a/content/cn/docs/getting-started.md
b/content/cn/docs/getting-started.md
index 397d4f7..411bf0b 100644
--- a/content/cn/docs/getting-started.md
+++ b/content/cn/docs/getting-started.md
@@ -18,7 +18,7 @@ docker run -d --name horaedb-server \
-p 8831:8831 \
-p 3307:3307 \
-p 5440:5440 \
- ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
+ apache/horaedb-server
```
启动后 HoraeDB 会监听如下端口：
@@ -44,7 +44,7 @@ docker run -d --name horaedb-server \
-p 5440:5440 \
-v ./horaedb.toml:/etc/horaedb/horaedb.toml \
-v ./data:/data \
- ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
+ apache/horaedb-server
```
## 写入和查询数据
diff --git a/content/en/docs/dev/sdk_develop.md
b/content/en/docs/dev/sdk_develop.md
index 3554b92..1f33fd2 100644
--- a/content/en/docs/dev/sdk_develop.md
+++ b/content/en/docs/dev/sdk_develop.md
@@ -2,17 +2,27 @@
title: "SDK Development"
---
-# Rust
+## Rust
+
+https://github.com/apache/horaedb-client-rs
+
+First install cargo with
```bash
-git clone https://github.com/apache/horaedb-client-rs
+curl https://sh.rustup.rs -sSf | sh
+```
+Then build with
+
+```bash
cargo build
```
-# Python
+## Python
+
+https://github.com/apache/horaedb-client-py
-## Requirements
+### Requirements
- python 3.7+
@@ -22,31 +32,29 @@ The Python SDK rely on Rust SDK, so
[cargo](https://doc.rust-lang.org/stable/car
pip install maturin
```
-Then we can build Python SDK:
+Then build Python SDK with this:
```bash
-git clone https://github.com/apache/horaedb-client-py
-
maturin build
```
-# Go
+## Go
-```bash
-git clone https://github.com/apache/horaedb-client-go
+https://github.com/apache/horaedb-client-go
+```bash
go build ./...
```
-# Java
+## Java
-## Requirements
+https://github.com/apache/horaedb-client-java
+
+### Requirements
- java 1.8
- maven 3.6.3+
```bash
-git clone https://github.com/apache/horaedb-client-java
-
mvn clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
```
diff --git a/content/en/docs/getting-started.md
b/content/en/docs/getting-started.md
index b2ba979..071a330 100644
--- a/content/en/docs/getting-started.md
+++ b/content/en/docs/getting-started.md
@@ -18,7 +18,7 @@ docker run -d --name horaedb-server \
-p 8831:8831 \
-p 3307:3307 \
-p 5440:5440 \
- ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
+ apache/horaedb-server
```
HoraeDB will listen three ports when start:
@@ -44,7 +44,7 @@ docker run -d --name horaedb-server \
-p 5440:5440 \
-v ./horaedb.toml:/etc/horaedb/horaedb.toml \
-v ./data:/data \
- ghcr.io/apache/horaedb-server:nightly-20231222-f57b3827
+ apache/horaedb-server
```
## Write and read data
diff --git a/static/config_kafka_oss.toml b/static/config_kafka_oss.toml
index 796b72c..6545089 100644
--- a/static/config_kafka_oss.toml
+++ b/static/config_kafka_oss.toml
@@ -7,7 +7,7 @@
# ```
# docker run -d --name horaedb-server \
# -v /etc/horaedb/horaedb.toml:{path_to_this_config} \
-# horaedb/horaedb-server
+# apache/horaedb-server
# ```
[server]
diff --git a/static/config_local_oss.toml b/static/config_local_oss.toml
index d4283af..695511a 100644
--- a/static/config_local_oss.toml
+++ b/static/config_local_oss.toml
@@ -6,7 +6,7 @@
# ```
# docker run -d --name horaedb-server \
# -v /etc/horaedb/horaedb.toml:{path_to_this_config} \
-# horaedb/horaedb-server
+# apache/horaedb-server
# ```
[server]
diff --git a/static/config_obkv_oss.toml b/static/config_obkv_oss.toml
index 965b0d9..dacf32f 100644
--- a/static/config_obkv_oss.toml
+++ b/static/config_obkv_oss.toml
@@ -7,7 +7,7 @@
# ```
# docker run -d --name horaedb-server \
# -v /etc/horaedb/horaedb.toml:{path_to_this_config} \
-# horaedb/horaedb-server
+# apache/horaedb-server
# ```
[server]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
