You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2023/05/07 15:48:08 UTC

[skywalking-banyandb] branch main updated: Fix docs crud examples error (#271)

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-banyandb.git


The following commit(s) were added to refs/heads/main by this push:
     new 6aa32753 Fix docs crud examples error (#271)
6aa32753 is described below

commit 6aa32753c2acb8caf1e4914de292222050197461
Author: hailin0 <ha...@gmail.com>
AuthorDate: Sun May 7 23:48:02 2023 +0800

    Fix docs crud examples error (#271)
---
 CHANGES.md                      | 1 +
 docs/crud/index_rule_binding.md | 2 +-
 docs/crud/measure/schema.md     | 2 +-
 docs/crud/property.md           | 4 ++--
 docs/crud/stream/query.md       | 6 +-----
 docs/crud/stream/schema.md      | 2 +-
 6 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/CHANGES.md b/CHANGES.md
index 92c28de5..e4510ffb 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -25,6 +25,7 @@ Release Notes.
 
 - Bump go to 1.20.
 - Set KV's minimum memtable size to 8MB
+- [docs] Fix docs crud examples error
 
 ## 0.3.1
 
diff --git a/docs/crud/index_rule_binding.md b/docs/crud/index_rule_binding.md
index 1c76595c..eae09d5c 100644
--- a/docs/crud/index_rule_binding.md
+++ b/docs/crud/index_rule_binding.md
@@ -89,7 +89,7 @@ Update operation update an index rule binding's schema.
 ### Examples updating
 
 ```shell
-$ bydbctl indexRuleBinding create -f - <<EOF
+$ bydbctl indexRuleBinding update -f - <<EOF
 metadata:
   name: stream_binding
   group: sw_stream
diff --git a/docs/crud/measure/schema.md b/docs/crud/measure/schema.md
index f13aa7d0..abefddf0 100644
--- a/docs/crud/measure/schema.md
+++ b/docs/crud/measure/schema.md
@@ -86,7 +86,7 @@ Update operation changes a measure's schema.
 ### Examples of updating
 
 ```shell
-$ bydbctl measure create -f - <<EOF
+$ bydbctl measure update -f - <<EOF
 metadata:
   name: service_cpm_minute
   group: sw_metric
diff --git a/docs/crud/property.md b/docs/crud/property.md
index 2eb72b6a..05378438 100644
--- a/docs/crud/property.md
+++ b/docs/crud/property.md
@@ -84,13 +84,13 @@ Delete operation delete a property.
 ### Examples of deleting
 
 ```shell
-$ bydbctl property delete -g sw -n ui_template --id General-Service.
+$ bydbctl property delete -g sw -n ui_template --id General-Service
 ```
 
 The delete operation could remove specific tags instead of the whole property.
 
 ```shell
-$ bydbctl property delete -g sw -n ui_template --id General-Service --tags state.
+$ bydbctl property delete -g sw -n ui_template --id General-Service --tags state
 ```
 
 ## List operation
diff --git a/docs/crud/stream/query.md b/docs/crud/stream/query.md
index 620f5729..febbca78 100644
--- a/docs/crud/stream/query.md
+++ b/docs/crud/stream/query.md
@@ -27,7 +27,7 @@ e.g. "start = 2022-11-09T12:04:00Z", so "end = start + 30 minutes = 2022-11-09T1
 
 ## Examples
 
-To retrieve elements in a stream named `sw` between `2022-10-15T22:32:48Z` and `2022-10-15T23:32:48Z` could use the below command. These elements also choose a tag `trace_id` which lives in a family named `searchable` and another tag `data_binary` belongs to family `data`.
+To retrieve elements in a stream named `sw` between `2022-10-15T22:32:48Z` and `2022-10-15T23:32:48Z` could use the below command. These elements also choose a tag `trace_id` which lives in a family named `searchable`.
 
 ```shell
 $ bydbctl stream query -f - <<EOF
@@ -38,8 +38,6 @@ projection:
   tagFamilies:
   - name: "searchable"
     tags: ["trace_id"]
-  - name: "data"
-    tags: ["data_binary"]
 timeRange:
   begin: 2022-10-15T22:32:48+08:00
   end: 2022-10-15T23:32:48+08:00
@@ -57,8 +55,6 @@ projection:
   tagFamilies:
   - name: "searchable"
     tags: ["trace_id"]
-  - name: "data"
-    tags: ["data_binary"]
 EOF
 ```
 
diff --git a/docs/crud/stream/schema.md b/docs/crud/stream/schema.md
index 8a066f6a..62cd9c6f 100644
--- a/docs/crud/stream/schema.md
+++ b/docs/crud/stream/schema.md
@@ -74,7 +74,7 @@ Update operation update a stream's schema.
 
 `bydbctl` is the command line tool to update a stream in this example.
 ```shell
-$ bydbctl stream create -f - <<EOF
+$ bydbctl stream update -f - <<EOF
 metadata:
   name: sw
   group: default