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 78d16b7 Move group as the first doc of concepts (#218)
78d16b7 is described below
commit 78d16b75862261e80900d8a0dde3c3de1ce90d14
Author: Brandon Fergerson <[email protected]>
AuthorDate: Fri Nov 18 12:15:01 2022 +0400
Move group as the first doc of concepts (#218)
---
docs/concept/data-model.md | 76 +++++++++++++++++++++++-----------------------
1 file changed, 38 insertions(+), 38 deletions(-)
diff --git a/docs/concept/data-model.md b/docs/concept/data-model.md
index fa676ed..fc40867 100644
--- a/docs/concept/data-model.md
+++ b/docs/concept/data-model.md
@@ -14,6 +14,44 @@ The hierarchy that data is organized into **streams**,
**measures** and **proper
+### Groups
+
+`Group` does not provide a mechanism for isolating groups of resources within
a single banyand-server but is the minimal unit to manage physical structures.
Each group contains a set of options, like retention policy, shard number, etc.
Several shards distribute in a group.
+
+```yaml
+metadata:
+ name: others
+```
+
+or
+
+```yaml
+metadata:
+ name: sw_metric
+catalog: CATALOG_MEASURE
+resource_opts:
+ shard_num: 2
+ block_interval:
+ unit: UNIT_HOUR
+ num: 2
+ segment_interval:
+ unit: UNIT_DAY
+ num: 1
+ ttl:
+ unit: UNIT_DAY
+ num: 7
+```
+
+The group creates two shards to store data points. Every day, it would create
a segment that will generate a block every 2 hours. The available units are
`HOUR` and `DAY`. The data in this group will keep 7 days.
+
+Every other resource should belong to a group. The `catalog` indicates which
kind of data model the group contains.
+
+* `UNSPECIFIED`: `Property` or other data models.
+* `MEASURE`: [`Measure`](#streams).
+* `STREAM`: [`Stream`](#measures).
+
+[Group Registration Operations](api-reference.md#groupregistryservice)
+
### Measures
BanyanDB lets you define a measure as follows:
@@ -154,44 +192,6 @@ You could Create, Read, Update and Drop a property, and
update or drop several t
[Property Operations](../api-reference.md#propertyservice)
-### Groups
-
-`Group` does not provide a mechanism for isolating groups of resources within
a single banyand-server but is the minimal unit to manage physical structures.
Each group contains a set of options, like retention policy, shard number, etc.
Several shards distribute in a group.
-
-```yaml
-metadata:
- name: others
-```
-
-or
-
-```yaml
-metadata:
- name: sw_metric
-catalog: CATALOG_MEASURE
-resource_opts:
- shard_num: 2
- block_interval:
- unit: UNIT_HOUR
- num: 2
- segment_interval:
- unit: UNIT_DAY
- num: 1
- ttl:
- unit: UNIT_DAY
- num: 7
-```
-
-The group creates two shards to store data points. Every day, it would create
a segment that will generate a block every 2 hours. The available units are
`HOUR` and `DAY`. The data in this group will keep 7 days.
-
-Every other resource should belong to a group. The `catalog` indicates which
kind of data model the group contains.
-
-* `UNSPECIFIED`: `Property` or other data models.
-* `MEASURE`: [`Measure`](#streams).
-* `STREAM`: [`Stream`](#measures).
-
-[Group Registration Operations](api-reference.md#groupregistryservice)
-
## Data Models
Data models in BanyanDB derive from some classic data models.
