Merge pull request #16 from zwk4zhendeC/alpha

sink describe

Author: zwk4zhendeC

docs-en/00-release/0.20.md

@@ -4,26 +4,77 @@
 
 ### Added Elasticsearch Sink.
 Supports batch writing parsed records to the Elasticsearch `/_bulk` API over HTTP/HTTPS, with timeout, retry, and password authentication support.
+Example:
+```toml
+[connectors.params]
+protocol = "http"      # Transport protocol; switch to https if needed
+host = "localhost"     # Elasticsearch server host
+port = "9200"          # Elasticsearch service port
+index = "wp_nginx"     # Target index name
+username = "elastic"   # Username
+password = ""          # Password
+batch_size = 1_0000     # Number of records per batch
+```
 - Usage doc: [Elasticsearch Sink](../10-user/05-connectors/02-sinks/20-elasticsearch_sink.md)
 - Example index: [wp-examples/extensions/elasticsearch/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/elasticsearch/README.md)
 
 ### Added PostgreSQL Sink.
-Supports writing Record data to PostgreSQL tables in batches based on the configured `columns`, which fits relational storage and idempotent retry scenarios.
 - Usage doc: [PostgreSQL Sink](../10-user/05-connectors/02-sinks/23-postgresql_sink.md)
 - Example index: [wp-examples/extensions/tcp_postgres/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/tcp_postgres/README.md)
 
 ### Added Doris Sink.
 Supports batch loading data into Apache Doris through the Stream Load API, with custom Stream Load headers, timeout, retry, and password authentication support.
+Example:
+```toml
+[connectors.params]
+endpoint = "http://localhost:8040"  # Use the BE HTTP port
+user = "root"                       # Username
+password = ""                       # Password
+database = ""                       # Database name
+table = ""                          # Table name
+batch_size = 1_0000                  # Request batch size
+
+# Optional: custom Stream Load parameters
+[connectors.params.headers]
+strip_outer_array = "false"
+max_filter_ratio = "0.1"
+strict_mode = "false"
+```
 - Usage doc: [Doris Sink](../10-user/05-connectors/02-sinks/17-doris.md)
 - Example index: [wp-examples/extensions/doris/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/doris/README.md)
 
 ### Added ClickHouse Sink.
 Supports writing to ClickHouse with the RowBinary format over HTTP, with timeout, retry, and password authentication support.
+Example:
+```toml
+[connectors.params]
+endpoint = "http://localhost:8123"
+username = ""                       # Username
+password = ""                       # Password
+database = ""                       # Database name
+table = ""                          # Table name
+batch_size = 1_0000                  # Request batch size
+```
 - Usage doc: [ClickHouse Sink](../10-user/05-connectors/02-sinks/21-clickhouse.md)
 - Example index: [wp-examples/extensions/clickhouse](https://github.com/wp-labs/wp-examples/tree/main/extensions/clickhouse)
 
 ### Added HTTP Sink.
 Supports sending parsed records to HTTP/HTTPS endpoints for webhooks, API integrations, and custom pipelines, with `json`, `ndjson`, `csv`, `kv`, `raw`, and `proto-text` output formats, plus Basic Auth, custom headers, gzip compression, timeout, and retry support.
+Example:
+```toml
+[sink_group.sinks.params]
+endpoint = "http://localhost:8080/webhook" # Target HTTP endpoint
+method = "POST"                            # HTTP method
+username = ""                              # Use HTTP Basic authentication
+password = ""                              # Use HTTP Basic authentication
+fmt = "json"                               # Output format: `json`, `ndjson`, `csv`, `kv`, `raw`, `proto-text` (default `json`)
+batch_size = 1_0000                         # Batch send size
+compression = "none"                       # Whether to enable gzip compression
+
+# Optional: custom header parameters
+[connectors.params.headers]
+# content-type = "application/json"
+```
 - Usage doc: [HTTP Sink](../10-user/05-connectors/02-sinks/22-http.md)
 - Example index: [wp-examples/extensions/http/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/http/README.md)
 

docs-zh/00-release/0.20.md

@@ -5,25 +5,80 @@
 
 ### 新增支持 ElasticSearch Sink。
 支持通过 HTTP/HTTPS 将解析后的记录批量写入 Elasticsearch的`/_bulk`接口，支持超时、重试与密码认证配置。
+示例：
+```toml
+[connectors.params]
+protocol = "http"      # 连接协议，按需改为 https
+host = "localhost"     # Elasticsearch 服务地址
+port = "9200"          # Elasticsearch 服务端口
+index = "wp_nginx"     # 写入的目标索引名
+username = "elastic"   # 用户名
+password = ""          # 密码
+batch_size = 1_0000    # 单批次写入记录数
+```
 - 使用文档：[Elasticsearch Sink](../10-user/05-connectors/02-sinks/20-elasticsearch_sink.md)
 - 示例索引：[wp-examples/extensions/elasticsearch/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/elasticsearch/README.md)
 
+
 ### 新增支持 Postgres Sink。
 - 使用文档：[PostgreSQL Sink](../10-user/05-connectors/02-sinks/23-postgresql_sink.md)
 - 示例索引：[wp-examples/extensions/tcp_postgres/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/tcp_postgres/README.md)
 
 ### 新增支持 Doris Sink。
 支持通过 Stream Load API 将数据批量写入 Apache Doris，支持自定义 Stream Load headers、超时、重试与密码认证。
+示例：
+```toml
+[connectors.params]
+endpoint = "http://localhost:8040"  # 使用 BE 的 HTTP 端口
+user = "root"                       # 用户名
+password = ""                       # 密码
+database = ""                       # 数据库
+table = ""                          # 表名
+batch_size = 1_0000                 # 请求批量大小
+
+# 可选：自定义 Stream Load 参数
+[connectors.params.headers]
+strip_outer_array = "false"
+max_filter_ratio = "0.1"
+strict_mode = "false"
+```
 - 使用文档：[Doris Sink](../10-user/05-connectors/02-sinks/17-doris.md)
 - 示例索引：[wp-examples/extensions/doris/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/doris/README.md)
 
+
 ### 新增支持 ClickHouse Sink。
 支持通过 使用 HTTP 传输的 RowBinary 格式写入Clickhouse接口，支持超时、重试与密码认证配置。
+示例：
+```toml
+[connectors.params]
+endpoint= "http://localhost:8123"   
+username = ""                       # 用户名
+password = ""                       # 密码
+database = ""                       # 数据库
+table = ""                          # 表名
+batch_size = 1_0000                 # 请求批量大小
+```
 - 使用文档：[ClickHouse Sink](../10-user/05-connectors/02-sinks/21-clickhouse.md)
 - 示例索引：[wp-examples/extensions/clickhouse](https://github.com/wp-labs/wp-examples/tree/main/extensions/clickhouse)
 
+
 ### 新增支持 HTTP Sink。
 支持将解析后的记录发送到 HTTP/HTTPS 端点，适用于 webhook、API 集成和自定义数据管道，支持将数据以 `json`、`ndjson`、`csv`、`kv`、`raw`、`proto-text` 格式输出，以及 Basic Auth认证、自定义请求头与 gzip 压缩，超时、重试配置。
+示例：
+```toml
+[sink_group.sinks.params]
+endpoint = "http://localhost:8080/webhook" # 目标 HTTP 端点
+method = "POST"                            # 请求方法
+username = ""                              # 使用HTTP Basic 认证
+password = ""                              # 使用HTTP Basic 认证
+fmt = "json"                               # 输出格式:`json`、`ndjson`、`csv`、`kv`、`raw`、`proto-text`（默认 `json`）
+batch_size = 1_0000                        # 批量发送大小
+compression = "none"                       # 是否启用 gzip 压缩
+
+# 可选：自定义 header 参数
+[connectors.params.headers]
+# content-type = "application/json"
+```
 - 使用文档：[HTTP Sink](../10-user/05-connectors/02-sinks/22-http.md)
 - 示例索引：[wp-examples/extensions/http/README.md](https://github.com/wp-labs/wp-examples/blob/main/extensions/http/README.md)