This is an automated email from the ASF dual-hosted git repository.
gaojun2048 pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 9e05fee824 [Doc] Improve Console Sink document (#5230)
9e05fee824 is described below
commit 9e05fee82465cf7ceedc7e68279e2d32d761b38e
Author: ZhilinLi <[email protected]>
AuthorDate: Mon Sep 25 17:33:52 2023 +0800
[Doc] Improve Console Sink document (#5230)
---
docs/en/connector-v2/sink/Console.md | 116 +++++++++++++++++++++--------------
1 file changed, 69 insertions(+), 47 deletions(-)
diff --git a/docs/en/connector-v2/sink/Console.md
b/docs/en/connector-v2/sink/Console.md
index 55df281b27..871c9357ef 100644
--- a/docs/en/connector-v2/sink/Console.md
+++ b/docs/en/connector-v2/sink/Console.md
@@ -2,6 +2,16 @@
> Console sink connector
+## Support Connector Version
+
+- All versions
+
+## Support Those Engines
+
+> Spark<br/>
+> Flink<br/>
+> SeaTunnel Zeta<br/>
+
## Description
Used to send data to Console. Both support streaming and batch mode.
@@ -14,69 +24,91 @@ Used to send data to Console. Both support streaming and
batch mode.
## Options
-| name | type | required | default value |
-|--------------------|---------|----------|---------------|
-| common-options | | no | - |
-| log.print.data | boolean | no | yes |
-| log.print.delay.ms | int | no | 0 |
-
-### common options
-
-Sink plugin common parameters, please refer to [Sink Common
Options](common-options.md) for details
-
-### log.print.data
-
-Flag to determine whether data should be printed in the logs. The default
value is `true`.
+| Name | Type | Required | Default |
Description |
+|--------------------|---------|----------|---------|-----------------------------------------------------------------------------------------------------|
+| common-options | | No | - | Sink plugin common
parameters, please refer to [Sink Common Options](common-options.md) for
details |
+| log.print.data | boolean | No | - | Flag to determine
whether data should be printed in the logs. The default value is `true`
|
+| log.print.delay.ms | int | No | - | Delay in milliseconds
between printing each data item to the logs. The default value is `0`. |
-### log.print.delay.ms
+## Task Example
-Delay in milliseconds between printing each data item to the logs. The default
value is `0`.
+### Simple:
-## Example
+> This is a randomly generated data, written to the console, with a degree of
parallelism of 1
-simple:
-
-```hocon
-Console {
+```
+env {
+ execution.parallelism = 1
+ job.mode = "STREAMING"
+}
+source {
+ FakeSource {
+ result_table_name = "fake"
+ schema = {
+ fields {
+ name = "string"
+ age = "int"
+ }
}
+ }
+}
+
+sink {
+ Console {
+ source_table_name = "fake"
+ }
+}
```
-test:
+### Multiple Sources Simple:
-* Configuring the SeaTunnel config file
+> This is a multiple source and you can specify a data source to write to the
specified end
-```hocon
+```
env {
execution.parallelism = 1
job.mode = "STREAMING"
}
source {
- FakeSource {
- result_table_name = "fake"
- schema = {
- fields {
- name = "string"
- age = "int"
- }
+ FakeSource {
+ result_table_name = "fake1"
+ schema = {
+ fields {
+ id = "int"
+ name = "string"
+ age = "int"
+ sex = "string"
+ }
+ }
+ }
+ FakeSource {
+ result_table_name = "fake2"
+ schema = {
+ fields {
+ name = "string"
+ age = "int"
}
}
+ }
}
sink {
- Console {
-
- }
+ Console {
+ source_table_name = "fake1"
+ }
+ Console {
+ source_table_name = "fake2"
+ }
}
-
```
-* Start a SeaTunnel task
+## Console Sample Data
-* Console print data
+This is a printout from our console
-```text
+```
2022-12-19 11:01:45,417 INFO
org.apache.seatunnel.connectors.seatunnel.console.sink.ConsoleSinkWriter -
output rowType: name<STRING>, age<INT>
2022-12-19 11:01:46,489 INFO
org.apache.seatunnel.connectors.seatunnel.console.sink.ConsoleSinkWriter -
subtaskIndex=0 rowIndex=1: SeaTunnelRow#tableId=-1 SeaTunnelRow#kind=INSERT:
CpiOd, 8520946
2022-12-19 11:01:46,490 INFO
org.apache.seatunnel.connectors.seatunnel.console.sink.ConsoleSinkWriter -
subtaskIndex=0 rowIndex=2: SeaTunnelRow#tableId=-1 SeaTunnelRow#kind=INSERT:
eQqTs, 1256802974
@@ -90,13 +122,3 @@ sink {
2022-12-19 11:01:46,490 INFO
org.apache.seatunnel.connectors.seatunnel.console.sink.ConsoleSinkWriter -
subtaskIndex=0 rowIndex=10: SeaTunnelRow#tableId=-1 SeaTunnelRow#kind=INSERT:
hBoib, 929089763
```
-## Changelog
-
-### 2.2.0-beta 2022-09-26
-
-- Add Console Sink Connector
-
-### 2.3.0-beta 2022-10-20
-
-- [Improve] Console sink support print subtask index
([3000](https://github.com/apache/seatunnel/pull/3000))
-
