diff --git a/docs/content/docs/core-concept/data-pipeline.md b/docs/content/docs/core-concept/data-pipeline.md index a6f9822b2..b86ab5461 100644 --- a/docs/content/docs/core-concept/data-pipeline.md +++ b/docs/content/docs/core-concept/data-pipeline.md @@ -109,12 +109,17 @@ We could use following yaml file to define a complicated Data Pipeline describin ``` # Pipeline Configurations -The following config options of Data Pipeline level are supported: -| parameter | meaning | optional/required | -|-----------------|-----------------------------------------------------------------------------------------|-------------------| -| name | The name of the pipeline, which will be submitted to the Flink cluster as the job name. | optional | -| parallelism | The global parallelism of the pipeline. Defaults to 1. | optional | -| local-time-zone | The local time zone defines current session time zone id. | optional | +The following config options of Data Pipeline level are supported. +Note that whilst the parameters are each individually optional, at least one of them must be specified. That is to say, The `pipeline` section is mandatory and cannot be empty. + + +| parameter | meaning | optional/required | +|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| `name` | The name of the pipeline, which will be submitted to the Flink cluster as the job name. | optional | +| `parallelism` | The global parallelism of the pipeline. Defaults to 1. | optional | +| `local-time-zone` | The local time zone defines current session time zone id. | optional | +| `schema.change.behavior` | How to handle [changes in schema]({{< ref "docs/core-concept/schema-evolution/" >}}). One of: [`exception`]({{< ref "docs/core-concept/schema-evolution/" >}}#exception-mode), [`evolve`]({{< ref "docs/core-concept/schema-evolution/" >}}#evolve-mode), [`try_evolve`]({{< ref "docs/core-concept/schema-evolution/" >}}#tryevolve-mode), [`lenient`]({{< ref "docs/core-concept/schema-evolution/" >}}#lenient-mode) (default) or [`ignore`]({{< ref "docs/core-concept/schema-evolution/" >}}#ignore-mode). | optional | +| `schema.operator.uid` | The unique ID for schema operator. This ID will be used for inter-operator communications and must be unique across operators. | optional | +| `schema-operator.rpc-timeout` | The timeout time for SchemaOperator to wait downstream SchemaChangeEvent applying finished, the default value is 3 minutes. | optional | -NOTE: Whilst the above parameters are each individually optional, at least one of them must be specified. The `pipeline` section is mandatory and cannot be empty.