diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md index 58fd7d88a..fbbb11964 100644 --- a/docs/getting-started/quick-start.md +++ b/docs/getting-started/quick-start.md @@ -10,7 +10,10 @@ GreptimeDB supports [multiple protocols](/user-guide/protocols/overview.md) for In this quick start document, we use SQL for simplicity. If your GreptimeDB instance is running on `127.0.0.1` with the MySQL client default port `4002` or the PostgreSQL client default port `4003`, -you can connect to GreptimeDB using the following commands: +you can connect to GreptimeDB using the following commands. + +By default, GreptimeDB does not have [authentication](/user-guide/operations/authentication.md) enabled. +You can connect to the database without providing a username and password in this section. ```shell mysql -h 127.0.0.1 -P 4002 diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md index 15b8a073b..0828fe889 100644 --- a/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md +++ b/docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md @@ -11,6 +11,11 @@ concurrent-safe library that is easy to use with the metric struct. +
+ +To quickly get started, you can explore the [quick start demos](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples) to understand how to use the GreptimeDB Go ingester SDK. + +
@@ -212,12 +217,6 @@ affected, err := cli.CloseStream(ctx)
-
- -For fully runnable code snippets and explanations for common methods, see the [Examples](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples). - -
-
- [API Documentation](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go) diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md index c88a61e46..a479b2c68 100644 --- a/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md +++ b/docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md @@ -15,6 +15,12 @@ The Java ingester SDK provided by GreptimeDB is a lightweight library with the f
+
+ +To quickly get started, you can explore the [quick start demos](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime) to understand how to use the GreptimeDB Java ingester SDK. + +
+
1. Install the Java Development Kit(JDK) @@ -300,19 +306,13 @@ LOG.info("Write result: {}", result);
-### Debug logs +## Debug logs The ingester SDK provides metrics and logs for debugging. Please refer to [Metrics & Display](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/metrics-display.md) and [Magic Tools](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/magic-tools.md) to learn how to enable or disable the logs.
-
- -For fully runnable code snippets and the complete code of the demo, please refer to the [Examples](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime). - -
-
- [API Documentation](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html) diff --git a/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md index 4570407d1..01e020ab6 100644 --- a/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md +++ b/docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md @@ -6,6 +6,10 @@ For more information, refer to [Automatic Schema Generation](/user-guide/ingest- +## Quick start demos + + + ## Installation @@ -84,10 +88,6 @@ Streaming insert is useful when you want to insert a large amount of data such a -## More examples - - - ## Ingester library reference diff --git a/docs/user-guide/query-data/overview.md b/docs/user-guide/query-data/overview.md index cd38b3932..f4b105635 100644 --- a/docs/user-guide/query-data/overview.md +++ b/docs/user-guide/query-data/overview.md @@ -10,11 +10,11 @@ Since v0.9, GreptimeDB supports view and CTE just like other databases, used to * [View](./view.md) * [Common Table Expression (CTE)](./cte.md) -## Client SDK libraries + ## Query external data diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md index 7933c967f..fede90767 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/quick-start.md @@ -11,7 +11,10 @@ GreptimeDB 支持[多种协议](/user-guide/protocols/overview.md)与数据库 如果你的 GreptimeDB 实例运行在 `127.0.0.1` 中， 并且使用 MySQL 客户端默认端口 `4002` 或 PostgreSQL 客户端默认端口 `4003`， -你可以使用以下命令连接到数据库： +你可以使用以下命令连接到数据库。 + +GreptimeDB 默认不开启[鉴权认证](/user-guide/operations/authentication.md)。 +在本章节中你可以在连接数据库时不提供用户名密码。 ```shell mysql -h 127.0.0.1 -P 4002 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md index f808cc882..8023409fb 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/go.md @@ -10,6 +10,11 @@ GreptimeDB 提供的 Go Ingest SDK 是一个轻量级、并发安全的库，使
+
+ +你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples) 来了解如何使用 GreptimeDB Go SDK。 + +
@@ -189,12 +194,6 @@ affected, err := cli.CloseStream(ctx)
-
- -有关更多可运行的代码片段和常用方法的解释，请参阅[示例](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples)。 - -
-
- [API 文档](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md index c7eb69390..4fa4dc4ea 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/java.md @@ -15,6 +15,12 @@ GreptimeDB 提供的 Java ingester SDK 是一个轻量级库，具有以下特
+
+ +你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime) 来了解如何使用 GreptimeDB Java SDK。 + +
+
1. 安装 Java 开发工具包（JDK） @@ -294,17 +300,11 @@ LOG.info("Write result: {}", result); ## 调试日志 -ingester SDK 提供了用于调试的指标和日志。 +Java SDK 提供了用于调试的指标和日志。 请参考 [Metrics & Display](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/metrics-display.md) 和 [Magic Tools](https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/main/docs/magic-tools.md) 了解如何启用或禁用日志。
-
- -请参考[示例](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime)获取更多完全可运行的代码片段和常用方法的解释。 - -
-
- [API 文档](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md index 0fb1e46cc..dc0d90adf 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/ingest-data/for-iot/grpc-sdks/template.md @@ -5,6 +5,10 @@ GreptimeDB 提供了用于高吞吐量数据写入的 ingester 库。 +## 快速开始 Demo + + + ## 安装 @@ -82,10 +86,6 @@ SDK 的高层级 API 使用 ORM 风格的对象写入数据， -## 更多示例 - - - ## Ingester 库参考 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/query-data/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/query-data/overview.md index 7a7b64499..e3e188f93 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/query-data/overview.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/query-data/overview.md @@ -10,11 +10,11 @@ * [View](./view.md) * [公共表表达式（CTE）](./cte.md) -## 客户端库 + ## 查询外部数据