From f1b36c93e0ac92488cbefc1910b742811293b816 Mon Sep 17 00:00:00 2001 From: Young Xu Date: Fri, 6 Sep 2024 07:20:07 +0800 Subject: [PATCH] refactor(sdk): design show xxx command (#131) Signed-off-by: Young Xu --- src/guide/develop/client_design.md | 28 +++++++++++++++++++++++++++ src/zh/guide/develop/client_design.md | 28 +++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) diff --git a/src/guide/develop/client_design.md b/src/guide/develop/client_design.md index d5d3ea57..069384dd 100644 --- a/src/guide/develop/client_design.md +++ b/src/guide/develop/client_design.md @@ -69,6 +69,10 @@ classDiagram + void CreateMeasurement(CreateMeasurementBuilder builder) + String[] ShowMeasurements(ShowMeasurementBuilder builder) + void DropMeasurement(String database, String retentionPolicy, String measurement) + + Map[String]String[] ShowTagKeys(ShowTagKeysBuilder builder) + + String[] ShowTagValues(ShowTagValuesBuilder builder) + + Map[String]Map[String]String ShowFieldKeys(String database, Option measurement) + + String[] ShowSeries(ShowSeriesBuilder builder) } class RpConfig { + String Name // non-null @@ -108,6 +112,30 @@ classDiagram <> ColumnStore // columnstore } + class ShowTagKeysBuilder { + ShowTagKeysBuilder Database(String database) + ShowTagKeysBuilder Measurement(String measurement) + ShowTagKeysBuilder RetentionPolicy(String rp) + ShowTagKeysBuilder Limit(int limit) + ShowTagKeysBuilder Offset(int offset) + } + class ShowTagValuesBuilder { + ShowTagValuesBuilder Database(String database) + ShowTagValuesBuilder Measurement(String measurement) + ShowTagValuesBuilder RetentionPolicy(String rp) + ShowTagValuesBuilder Limit(int limit) + ShowTagValuesBuilder Offset(int offset) + ShowTagValuesBuilder With(String[] keys) + ShowTagValuesBuilder Where(String key, ComparisonOperator operator, String value) + } + class ShowSeriesBuilder { + ShowSeriesBuilder Database(String database) + ShowSeriesBuilder Measurement(String measurement) + ShowSeriesBuilder RetentionPolicy(String rp) + ShowSeriesBuilder Limit(int limit) + ShowSeriesBuilder Offset(int offset) + ShowTagValuesBuilder Where(String key, ComparisonOperator operator, String value) + } ``` # Write point design diff --git a/src/zh/guide/develop/client_design.md b/src/zh/guide/develop/client_design.md index 68637623..43dd628e 100644 --- a/src/zh/guide/develop/client_design.md +++ b/src/zh/guide/develop/client_design.md @@ -70,6 +70,10 @@ classDiagram + void CreateMeasurement(CreateMeasurementBuilder builder) + String[] ShowMeasurements(ShowMeasurementBuilder builder) + void DropMeasurement(String database, String retentionPolicy, String measurement) + + Map[String]String[] ShowTagKeys(ShowTagKeysBuilder builder) + + String[] ShowTagValues(ShowTagValuesBuilder builder) + + Map[String]Map[String]String ShowFieldKeys(String database, Option measurement) + + String[] ShowSeries(ShowSeriesBuilder builder) } class RpConfig { + String Name // non-null @@ -109,6 +113,30 @@ classDiagram <> ColumnStore // columnstore } + class ShowTagKeysBuilder { + ShowTagKeysBuilder Database(String database) + ShowTagKeysBuilder Measurement(String measurement) + ShowTagKeysBuilder RetentionPolicy(String rp) + ShowTagKeysBuilder Limit(int limit) + ShowTagKeysBuilder Offset(int offset) + } + class ShowTagValuesBuilder { + ShowTagValuesBuilder Database(String database) + ShowTagValuesBuilder Measurement(String measurement) + ShowTagValuesBuilder RetentionPolicy(String rp) + ShowTagValuesBuilder Limit(int limit) + ShowTagValuesBuilder Offset(int offset) + ShowTagValuesBuilder With(String[] keys) + ShowTagValuesBuilder Where(String key, ComparisonOperator operator, String value) + } + class ShowSeriesBuilder { + ShowSeriesBuilder Database(String database) + ShowSeriesBuilder Measurement(String measurement) + ShowSeriesBuilder RetentionPolicy(String rp) + ShowSeriesBuilder Limit(int limit) + ShowSeriesBuilder Offset(int offset) + ShowTagValuesBuilder Where(String key, ComparisonOperator operator, String value) + } ``` # 写入点位设计