Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: refine some content #1171

Merged
merged 4 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
nicecui marked this conversation as resolved.
Show resolved Hide resolved
You can connect to the database without providing a username and password in this section.

```shell
mysql -h 127.0.0.1 -P 4002
Expand Down
11 changes: 5 additions & 6 deletions docs/user-guide/ingest-data/for-iot/grpc-sdks/go.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ concurrent-safe library that is easy to use with the metric struct.

</div>

<div id="quick-start-demos">

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.

</div>

<div id="ingester-lib-installation">

Expand Down Expand Up @@ -212,12 +217,6 @@ affected, err := cli.CloseStream(ctx)

</div>

<div id="more-ingestion-examples">

For fully runnable code snippets and explanations for common methods, see the [Examples](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples).

</div>

<div id="ingester-lib-reference">

- [API Documentation](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go)
Expand Down
14 changes: 7 additions & 7 deletions docs/user-guide/ingest-data/for-iot/grpc-sdks/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ The Java ingester SDK provided by GreptimeDB is a lightweight library with the f

</div>

<div id="quick-start-demos">

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.

</div>

<div id="ingester-lib-installation">

1. Install the Java Development Kit(JDK)
Expand Down Expand Up @@ -300,19 +306,13 @@ LOG.info("Write result: {}", result);

<div id="ingester-lib-debug-logs">

### 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.

</div>

<div id="more-ingestion-examples">

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).

</div>

<div id="ingester-lib-reference">

- [API Documentation](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html)
Expand Down
8 changes: 4 additions & 4 deletions docs/user-guide/ingest-data/for-iot/grpc-sdks/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ For more information, refer to [Automatic Schema Generation](/user-guide/ingest-

<InjectContent id="ingester-lib-introduction" content={props.children}/>

## Quick start demos

<InjectContent id="quick-start-demos" content={props.children}/>

## Installation

<InjectContent id="ingester-lib-installation" content={props.children}/>
Expand Down Expand Up @@ -84,10 +88,6 @@ Streaming insert is useful when you want to insert a large amount of data such a

<InjectContent id="high-level-style-update-data" content={props.children}/>

## More examples

<InjectContent id="more-ingestion-examples" content={props.children}/>

<InjectContent id="ingester-lib-debug-logs" content={props.children}/>

## Ingester library reference
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/query-data/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- ## Client SDK libraries

Client libraries provide a convenient way to connect to GreptimeDB and interact with data.
There are mature SQL driver libraries available for querying GreptimeDB.
For more information, please refer to the [Client Libraries](/user-guide/ingest-data/for-iot/grpc-sdks/overview.md) documentation.
For more information, please refer to the [Client Libraries](/user-guide/ingest-data/for-iot/grpc-sdks/overview.md) documentation. -->

## Query external data

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ GreptimeDB 提供的 Go Ingest SDK 是一个轻量级、并发安全的库,使

</div>

<div id="quick-start-demos">

你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples) 来了解如何使用 GreptimeDB Go SDK。

</div>

<div id="ingester-lib-installation">

Expand Down Expand Up @@ -189,12 +194,6 @@ affected, err := cli.CloseStream(ctx)

</div>

<div id="more-ingestion-examples">

有关更多可运行的代码片段和常用方法的解释,请参阅[示例](https://github.com/GreptimeTeam/greptimedb-ingester-go/tree/main/examples)

</div>

<div id="ingester-lib-reference">

- [API 文档](https://pkg.go.dev/github.com/GreptimeTeam/greptimedb-ingester-go)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ GreptimeDB 提供的 Java ingester SDK 是一个轻量级库,具有以下特

</div>

<div id="quick-start-demos">

你可以通过[快速开始 Demo](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime) 来了解如何使用 GreptimeDB Java SDK。

</div>

<div id="ingester-lib-installation">

1. 安装 Java 开发工具包(JDK)
Expand Down Expand Up @@ -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) 了解如何启用或禁用日志。

</div>

<div id="more-ingestion-examples">

请参考[示例](https://github.com/GreptimeTeam/greptimedb-ingester-java/tree/main/ingester-example/src/main/java/io/greptime)获取更多完全可运行的代码片段和常用方法的解释。

</div>

<div id="ingester-lib-reference">

- [API 文档](https://javadoc.io/doc/io.greptime/ingester-protocol/latest/index.html)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ GreptimeDB 提供了用于高吞吐量数据写入的 ingester 库。

<InjectContent id="ingester-lib-introduction" content={props.children}/>

## 快速开始 Demo

<InjectContent id="quick-start-demos" content={props.children}/>

## 安装

<InjectContent id="ingester-lib-installation" content={props.children}/>
Expand Down Expand Up @@ -82,10 +86,6 @@ SDK 的高层级 API 使用 ORM 风格的对象写入数据,

<InjectContent id="high-level-style-update-data" content={props.children}/>

## 更多示例

<InjectContent id="more-ingestion-examples" content={props.children}/>

<InjectContent id="ingester-lib-debug-logs" content={props.children}/>

## Ingester 库参考
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
* [View](./view.md)
* [公共表表达式(CTE)](./cte.md)

## 客户端库
<!-- ## 客户端库

客户端库提供了一种方便的方式来连接 GreptimeDB 并与数据交互。
现有的成熟 SQL driver 库可用于查询 GreptimeDB。
请参考[客户端库](/user-guide/ingest-data/for-iot/grpc-sdks/overview.md)文档获取更多信息。
请参考[客户端库](/user-guide/ingest-data/for-iot/grpc-sdks/overview.md)文档获取更多信息。 -->

## 查询外部数据

Expand Down
Loading