This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch polish-client-doc in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git
commit ad839f98a40989f1c90ea7f8056008254ee69532 Author: Wu Sheng <[email protected]> AuthorDate: Sun Dec 21 10:27:07 2025 +0800 Polish docs, and remove Java client doc. --- CHANGES.md | 1 + docs/interacting/client.md | 11 +++++++++++ docs/interacting/data-lifecycle.md | 4 ++-- docs/interacting/java-client.md | 3 --- docs/menu.yml | 4 ++-- 5 files changed, 16 insertions(+), 7 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 40d10c48..969aca2a 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -27,6 +27,7 @@ Release Notes. - Add read write benchmark document for 0.9.0 release. - Add design of KTM. - Add FODC overview doc. +- Remove Java client doc, and recreate client APIs docs. ## 0.9.0 diff --git a/docs/interacting/client.md b/docs/interacting/client.md new file mode 100644 index 00000000..af40db7f --- /dev/null +++ b/docs/interacting/client.md @@ -0,0 +1,11 @@ +## Client APIs + +Clients can connect to the BanyanDB server — or to a **liaison** node in a cluster deployment — via **gRPC** or **HTTP**. +The **liaison** acts as a gateway node that routes client requests and coordinates interactions within the cluster. +Through this connection, clients can **query** existing data or **perform bulk data writes**. + +All Protocol Buffer (`.proto`) definitions used by the client are maintained in the +[BanyanDB Client Proto Definitions Repository](https://github.com/apache/skywalking-banyandb-client-proto). + +Since version **0.10.0**, BanyanDB introduces **schema-based validation** for all write operations. +Each write request must strictly follow the schema definitions defined in the database to ensure data consistency and integrity. \ No newline at end of file diff --git a/docs/interacting/data-lifecycle.md b/docs/interacting/data-lifecycle.md index 37c120a9..7ffa4496 100644 --- a/docs/interacting/data-lifecycle.md +++ b/docs/interacting/data-lifecycle.md @@ -46,7 +46,7 @@ EOF More ttl units can be found in the [IntervalRule.Unit](../api-reference.md#intervalruleunit). -You can also manage the Group by other clients such as [Web-UI](./web-ui/schema/group.md) or [Java-Client](java-client.md). +You can also manage the Group by other clients such as [Web-UI](./web-ui/schema/group.md) or [Client APIs](client.md). For more details about how they works, please refer to the [data rotation](../concept/rotation.md). @@ -96,7 +96,7 @@ bydbctl property keepalive --lease_id 7587880824757265022 "General-Service" lives another 1 hour. -You can also manage the Property by other clients such as [Web-UI](./web-ui/property.md) or [Java-Client](java-client.md). +You can also manage the Property by other clients such as [Web-UI](./web-ui/property.md) or [Client APIs](client.md). ## The API reference - [Group Registration Operations](../api-reference.md#groupregistryservice) diff --git a/docs/interacting/java-client.md b/docs/interacting/java-client.md deleted file mode 100644 index 338fa48a..00000000 --- a/docs/interacting/java-client.md +++ /dev/null @@ -1,3 +0,0 @@ -# Java Client - -The java native client is hosted at [skywalking-banyandb-java-client](https://github.com/apache/skywalking-banyandb-java-client). \ No newline at end of file diff --git a/docs/menu.yml b/docs/menu.yml index ee95f8ea..65e33aad 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -99,8 +99,8 @@ catalog: path: "/interacting/web-ui/query/stream" - name: "CRUD Property" path: "/interacting/web-ui/property" - - name: "Java Client" - path: "/interacting/java-client" + - name: "Client APIs" + path: "/interacting/client" - name: "Data Lifecycle" path: "/interacting/data-lifecycle" - name: "BydbQL"
