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/03 14:45:57 UTC

[skywalking-banyandb] branch main updated: fix some errors in docs (#269)

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 236d72e9 fix some errors in docs (#269)
236d72e9 is described below

commit 236d72e9fcbfe67d169ca8db3f163fc1df809c53
Author: A3bz <59...@users.noreply.github.com>
AuthorDate: Wed May 3 22:45:51 2023 +0800

    fix some errors in docs (#269)
---
 docs/concept/data-model.md  |  2 +-
 docs/crud/group.md          |  4 ++--
 docs/crud/index_rule.md     |  6 +++---
 docs/crud/measure/schema.md |  7 +++++--
 docs/crud/stream/schema.md  | 10 ++++++++--
 5 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/docs/concept/data-model.md b/docs/concept/data-model.md
index 9e2634d7..f5652316 100644
--- a/docs/concept/data-model.md
+++ b/docs/concept/data-model.md
@@ -169,7 +169,7 @@ Tags in `group_by_tag_names` are used as dimensions. These tags can be searched
 
 `Property` is a standard key-value store. Users could store their metadata or items on a property and get a [sequential consistency](https://en.wikipedia.org/wiki/Consistency_model#Sequential_consistency) guarantee. BanyanDB's motivation for introducing such a particular structure is to support most APM scenarios that need to store critical data, especially for a distributed database cluster.
 
-We should create group before creating a property.
+We should create a group before creating a property.
 
 Creating group.
 
diff --git a/docs/crud/group.md b/docs/crud/group.md
index 130f11a4..237fc170 100644
--- a/docs/crud/group.md
+++ b/docs/crud/group.md
@@ -42,7 +42,7 @@ Get operation gets a group's schema.
 ### Examples of getting
 
 ```shell
-$ bydbctl get -g sw_metric
+$ bydbctl group get -g sw_metric
 ```
 
 ## Update operation
@@ -79,7 +79,7 @@ Delete operation deletes a group's schema.
 ### Examples of deleting
 
 ```shell
-$ bydbctl delete -g sw_metric
+$ bydbctl group delete -g sw_metric
 ```
 
 ## List operation
diff --git a/docs/crud/index_rule.md b/docs/crud/index_rule.md
index bc812253..5e8c2945 100644
--- a/docs/crud/index_rule.md
+++ b/docs/crud/index_rule.md
@@ -64,7 +64,7 @@ Get(Read) operation gets an index rule's schema.
 ### Examples of getting
 
 ```shell
-$ bydbctl get -g sw_stream -n trace_id
+$ bydbctl indexRule get -g sw_stream -n trace_id
 ```
 
 ## Update operation
@@ -95,7 +95,7 @@ Delete operation deletes an index rule's schema.
 ### Examples of deleting
 
 ```shell
-$ bydbctl indexRuleBind delete -g sw_stream -n trace_id
+$ bydbctl indexRule delete -g sw_stream -n trace_id
 ```
 
 ## List operation
@@ -110,4 +110,4 @@ $ bydbctl indexRule list -g sw_stream
 
 ## API Reference
 
-[indexRuleService v1](../../api-reference.md#IndexRuleRegistryService)
\ No newline at end of file
+[indexRuleService v1](../../api-reference.md#IndexRuleRegistryService)
diff --git a/docs/crud/measure/schema.md b/docs/crud/measure/schema.md
index 0bfce2c2..f13aa7d0 100644
--- a/docs/crud/measure/schema.md
+++ b/docs/crud/measure/schema.md
@@ -76,7 +76,7 @@ Get(Read) operation gets a measure's schema.
 ### Examples of getting
 
 ```shell
-$ bydbctl get -g sw_metric -n service_cpm_minute
+$ bydbctl measure get -g sw_metric -n service_cpm_minute
 ```
 
 ## Update operation
@@ -95,6 +95,9 @@ tagFamilies:
     tags: 
       - name: trace_id
         type: TAG_TYPE_STRING
+entity:
+  tag_names:
+    - entity_id
 EOF
 ```
 
@@ -105,7 +108,7 @@ Delete operation removes a measure's schema.
 ### Examples of deleting
 
 ```shell
-$ bydbctl delete -g sw_metric -n service_cpm_minute
+$ bydbctl measure delete -g sw_metric -n service_cpm_minute
 ```
 
 ## List operation
diff --git a/docs/crud/stream/schema.md b/docs/crud/stream/schema.md
index bc8a351f..8a066f6a 100644
--- a/docs/crud/stream/schema.md
+++ b/docs/crud/stream/schema.md
@@ -50,6 +50,9 @@ tagFamilies:
     tags: 
       - name: trace_id
         type: TAG_TYPE_STRING
+entity:
+  tagNames:
+    - stream_id
 EOF
 ```
 
@@ -60,7 +63,7 @@ Get(Read) operation get a stream's schema.
 ### Examples of getting
 
 ```shell
-$ bydbctl get -g default -n sw
+$ bydbctl stream get -g default -n sw
 ```
 
 ## Update operation
@@ -80,6 +83,9 @@ tagFamilies:
     tags: 
       - name: trace_id
         type: TAG_TYPE_STRING
+entity:
+  tagNames:    
+    - stream_id
 EOF
 
 ```
@@ -92,7 +98,7 @@ Delete operation delete a stream's schema.
 
 `bydbctl` is the command line tool to delete a stream in this example.
 ```shell
-$ bydbctl delete -g default -n sw
+$ bydbctl stream delete -g default -n sw
 ```
 
 ## List operation