This is an automated email from the ASF dual-hosted git repository.
hjf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new bd8d2ba [Issue 5157][docs] Update source and sink
--processing-guarantees description (#7767)
bd8d2ba is described below
commit bd8d2bab3b56d550138911b1cc674eb98cbe42e4
Author: Jennifer Huang <47805623+jennifer88hu...@users.noreply.github.com>
AuthorDate: Tue Aug 11 16:56:14 2020 +0800
[Issue 5157][docs] Update source and sink --processing-guarantees
description (#7767)
* update source create description
* update as per advice from sijia
---
site2/docs/io-cli.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/site2/docs/io-cli.md b/site2/docs/io-cli.md
index 345b3d9..a1ecc2a 100644
--- a/site2/docs/io-cli.md
+++ b/site2/docs/io-cli.md
@@ -64,7 +64,7 @@ $ pulsar-admin sources create options
|`--name` | The source's name.
| `--namespace` | The source's namespace.
| ` --parallelism` | The source's parallelism factor, that is, the number of
source instances to run.
-| `--processing-guarantees` | The processing guarantees (aka delivery
semantics) applied to the source.<br>Possible Values: ATLEAST_ONCE,
ATMOST_ONCE, EFFECTIVELY_ONCE.
+| `--processing-guarantees` | The processing guarantees (also named as
delivery semantics) applied to the source. A source connector receives messages
from external system and writes messages to a Pulsar topic. The
`--processing-guarantees` is used to ensure the processing guarantees for
writing messages to the Pulsar topic. <br>The available values are
ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance
(applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br> Either a builtin schema (for
example, AVRO and JSON) or custom schema class name to be used to encode
messages emitted from source.
| `--source-config` | Source config key/values.
@@ -95,7 +95,7 @@ $ pulsar-admin sources update options
|`--name` | The source's name.
| `--namespace` | The source's namespace.
| ` --parallelism` | The source's parallelism factor, that is, the number of
source instances to run.
-| `--processing-guarantees` | The processing guarantees (aka delivery
semantics) applied to the source.<br>Possible Values: ATLEAST_ONCE,
ATMOST_ONCE, EFFECTIVELY_ONCE.
+| `--processing-guarantees` | The processing guarantees (also named as
delivery semantics) applied to the source. A source connector receives messages
from external system and writes messages to a Pulsar topic. The
`--processing-guarantees` is used to ensure the processing guarantees for
writing messages to the Pulsar topic. <br>The available values are
ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
| `--ram` | The RAM (in bytes) that needs to be allocated per source instance
(applicable only to the process and Docker runtimes).
| `-st`, `--schema-type` | The schema type.<br> Either a builtin schema (for
example, AVRO and JSON) or custom schema class name to be used to encode
messages emitted from source.
| `--source-config` | Source config key/values.
@@ -263,7 +263,7 @@ $ pulsar-admin sources localrun options
|`--name`|The source’s name.|
|`--namespace`|The source’s namespace.|
|`--parallelism`|The source’s parallelism factor, that is, the number of
source instances to run).|
-|`--processing-guarantees`|The processing guarantees (aka delivery semantics)
applied to the source. <br>Available values: ATLEAST_ONCE, ATMOST_ONCE,
EFFECTIVELY_ONCE.
+|`--processing-guarantees` | The processing guarantees (also named as delivery
semantics) applied to the source. A source connector receives messages from
external system and writes messages to a Pulsar topic. The
`--processing-guarantees` is used to ensure the processing guarantees for
writing messages to the Pulsar topic. <br>The available values are
ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
|`--ram`|The RAM (in bytes) that needs to be allocated per source instance
(applicable only to the Docker runtime).|
| `-st`, `--schema-type` | The schema type.<br> Either a builtin schema (for
example, AVRO and JSON) or custom schema class name to be used to encode
messages emitted from source.
|`--source-config`|Source config key/values.
@@ -354,7 +354,7 @@ $ pulsar-admin sinks create options
|`--name` | The sink's name.
| `--namespace` | The sink's namespace.
| ` --parallelism` | The sink's parallelism factor, that is, the number of
sink instances to run.
-| `--processing-guarantees` | The processing guarantees (aka delivery
semantics) applied to the sink.<br>Possible Values: ATLEAST_ONCE, ATMOST_ONCE,
EFFECTIVELY_ONCE.
+| `--processing-guarantees` | The processing guarantees (also known as
delivery semantics) applied to the sink. The `--processing-guarantees`
implementation in Pulsar also relies on sink implementation. <br>The available
values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance
(applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
@@ -390,7 +390,7 @@ $ pulsar-admin sinks update options
|`--name` | The sink's name.
| `--namespace` | The sink's namespace.
| ` --parallelism` | The sink's parallelism factor, that is, the number of
sink instances to run.
-| `--processing-guarantees` | The processing guarantees (aka delivery
semantics) applied to the sink.<br>Possible Values: ATLEAST_ONCE, ATMOST_ONCE,
EFFECTIVELY_ONCE.
+| `--processing-guarantees` | The processing guarantees (also known as
delivery semantics) applied to the sink. The `--processing-guarantees`
implementation in Pulsar also relies on sink implementation. <br>The available
values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
| `--ram` | The RAM (in bytes) that needs to be allocated per sink instance
(applicable only to the process and Docker runtimes).
| `--retain-ordering` | Sink consumes and sinks messages in order.
| `--sink-config` | sink config key/values.
@@ -566,7 +566,7 @@ $ pulsar-admin sinks localrun options
|`--name`|The sink’s name.|
|`--namespace`|The sink’s namespace.|
|`--parallelism`|The sink’s parallelism factor, that is, the number of sink
instances to run).|
-|`--processing-guarantees`|The processing guarantees (aka delivery semantics)
applied to the sink. <br>Available values: ATLEAST_ONCE, ATMOST_ONCE,
EFFECTIVELY_ONCE.
+|`--processing-guarantees`|The processing guarantees (also known as delivery
semantics) applied to the sink. The `--processing-guarantees` implementation in
Pulsar also relies on sink implementation. <br>The available values are
ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.
|`--ram`|The RAM (in bytes) that needs to be allocated per sink instance
(applicable only to the Docker runtime).|
|`--retain-ordering` | Sink consumes and sinks messages in order.
|`--sink-config`|sink config key/values.
