This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new f4b53bf4c50 [fix][doc] RabbitMQ source and sink (#517)
f4b53bf4c50 is described below
commit f4b53bf4c50d4333d341fc7e6dafd7e86b8e80da
Author: tison <[email protected]>
AuthorDate: Fri Apr 14 15:31:25 2023 +0800
[fix][doc] RabbitMQ source and sink (#517)
Signed-off-by: tison <[email protected]>
---
docs/io-rabbitmq-sink.md | 35 ++++++++++------------
docs/io-rabbitmq-source.md | 34 ++++++++++-----------
versioned_docs/version-2.10.x/io-rabbitmq-sink.md | 33 ++++++++++----------
.../version-2.10.x/io-rabbitmq-source.md | 34 ++++++++++-----------
versioned_docs/version-2.11.x/io-rabbitmq-sink.md | 33 ++++++++++----------
.../version-2.11.x/io-rabbitmq-source.md | 34 ++++++++++-----------
6 files changed, 99 insertions(+), 104 deletions(-)
diff --git a/docs/io-rabbitmq-sink.md b/docs/io-rabbitmq-sink.md
index f2f45ac1e00..ad910ec8635 100644
--- a/docs/io-rabbitmq-sink.md
+++ b/docs/io-rabbitmq-sink.md
@@ -12,31 +12,28 @@ You can download all the Pulsar connectors on [download
page](pathname:///downlo
The RabbitMQ sink connector pulls messages from Pulsar topics and persists the
messages to RabbitMQ queues.
-
## Configuration
The configuration of the RabbitMQ sink connector has the following properties.
-
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The exchange to publish messages. |
-| `exchangeName` | String|true | " " (empty string) | The maximum number of
messages that the server delivers.<br /><br /> 0 means unlimited. |
-| `routingKey` |String|true | " " (empty string) |The routing key used to
publish messages. |
-
+| Name | Type | Required | Default | Description
|
+|-----------------------|--------|----------|----------------|--------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `exchangeName` | String | true | (empty string) | The exchange to
publish messages. |
+| `routingKey` | String | true | (empty string) | The routing key
used to publish messages. |
### Example
diff --git a/docs/io-rabbitmq-source.md b/docs/io-rabbitmq-source.md
index 4322871df98..f8d4c0c8612 100644
--- a/docs/io-rabbitmq-source.md
+++ b/docs/io-rabbitmq-source.md
@@ -18,23 +18,23 @@ The configuration of the RabbitMQ source connector has the
following properties.
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The requested heartbeat timeout in
seconds. |
-| `prefetchCount` | int|false | 0 | The maximum number of messages that the
server delivers.<br /><br /> 0 means unlimited. |
-| `prefetchGlobal` | boolean|false | false |Whether the setting should be
applied to the entire channel rather than each consumer. |
-| `passive` | boolean|false | false | Whether the rabbitmq consumer should
create its own queue or bind to an existing one. |
+| Name | Type | Required | Default | Description
|
+|-----------------------|---------|----------|----------------|----------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `prefetchCount` | int | false | 0 | The maximum
number of messages that the server delivers.<br/> 0 means unlimited. |
+| `prefetchGlobal` | boolean | false | false | Whether the
setting should be applied to the entire channel rather than each consumer. |
+| `passive` | boolean | false | false | Whether the
rabbitmq consumer should create its own queue or bind to an existing one. |
### Example
diff --git a/versioned_docs/version-2.10.x/io-rabbitmq-sink.md
b/versioned_docs/version-2.10.x/io-rabbitmq-sink.md
index e03ff38ac77..985ecb2dbda 100644
--- a/versioned_docs/version-2.10.x/io-rabbitmq-sink.md
+++ b/versioned_docs/version-2.10.x/io-rabbitmq-sink.md
@@ -16,23 +16,22 @@ The configuration of the RabbitMQ sink connector has the
following properties.
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The exchange to publish messages. |
-| `exchangeName` | String|true | " " (empty string) | The maximum number of
messages that the server delivers.<br /><br /> 0 means unlimited. |
-| `prefetchGlobal` |String|true | " " (empty string) |The routing key used to
publish messages. |
-
+| Name | Type | Required | Default | Description
|
+|-----------------------|--------|----------|----------------|--------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `exchangeName` | String | true | (empty string) | The exchange to
publish messages. |
+| `routingKey` | String | true | (empty string) | The routing key
used to publish messages. |
### Example
diff --git a/versioned_docs/version-2.10.x/io-rabbitmq-source.md
b/versioned_docs/version-2.10.x/io-rabbitmq-source.md
index 21c732d21b5..d6eab9429d7 100644
--- a/versioned_docs/version-2.10.x/io-rabbitmq-source.md
+++ b/versioned_docs/version-2.10.x/io-rabbitmq-source.md
@@ -14,23 +14,23 @@ The configuration of the RabbitMQ source connector has the
following properties.
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The requested heartbeat timeout in
seconds. |
-| `prefetchCount` | int|false | 0 | The maximum number of messages that the
server delivers.<br /><br /> 0 means unlimited. |
-| `prefetchGlobal` | boolean|false | false |Whether the setting should be
applied to the entire channel rather than each consumer. |
-| `passive` | boolean|false | false | Whether the rabbitmq consumer should
create its own queue or bind to an existing one. |
+| Name | Type | Required | Default | Description
|
+|-----------------------|---------|----------|----------------|----------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `prefetchCount` | int | false | 0 | The maximum
number of messages that the server delivers.<br/> 0 means unlimited. |
+| `prefetchGlobal` | boolean | false | false | Whether the
setting should be applied to the entire channel rather than each consumer. |
+| `passive` | boolean | false | false | Whether the
rabbitmq consumer should create its own queue or bind to an existing one. |
### Example
diff --git a/versioned_docs/version-2.11.x/io-rabbitmq-sink.md
b/versioned_docs/version-2.11.x/io-rabbitmq-sink.md
index f2f45ac1e00..c93aa593c9c 100644
--- a/versioned_docs/version-2.11.x/io-rabbitmq-sink.md
+++ b/versioned_docs/version-2.11.x/io-rabbitmq-sink.md
@@ -20,23 +20,22 @@ The configuration of the RabbitMQ sink connector has the
following properties.
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The exchange to publish messages. |
-| `exchangeName` | String|true | " " (empty string) | The maximum number of
messages that the server delivers.<br /><br /> 0 means unlimited. |
-| `routingKey` |String|true | " " (empty string) |The routing key used to
publish messages. |
-
+| Name | Type | Required | Default | Description
|
+|-----------------------|--------|----------|----------------|--------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `exchangeName` | String | true | (empty string) | The exchange to
publish messages. |
+| `routingKey` | String | true | (empty string) | The routing key
used to publish messages. |
### Example
diff --git a/versioned_docs/version-2.11.x/io-rabbitmq-source.md
b/versioned_docs/version-2.11.x/io-rabbitmq-source.md
index 4322871df98..f8d4c0c8612 100644
--- a/versioned_docs/version-2.11.x/io-rabbitmq-source.md
+++ b/versioned_docs/version-2.11.x/io-rabbitmq-source.md
@@ -18,23 +18,23 @@ The configuration of the RabbitMQ source connector has the
following properties.
### Property
-| Name | Type|Required | Default | Description
-|------|----------|----------|---------|-------------|
-| `connectionName` |String| true | " " (empty string) | The connection name. |
-| `host` | String| true | " " (empty string) | The RabbitMQ host. |
-| `port` | int |true | 5672 | The RabbitMQ port. |
-| `virtualHost` |String|true | / | The virtual host used to connect to
RabbitMQ. |
-| `username` | String|false | guest | The username used to authenticate to
RabbitMQ. |
-| `password` | String|false | guest | The password used to authenticate to
RabbitMQ. |
-| `queueName` | String|true | " " (empty string) | The RabbitMQ queue name
that messages should be read from or written to. |
-| `requestedChannelMax` | int|false | 0 | The initially requested maximum
channel number. <br /><br />0 means unlimited. |
-| `requestedFrameMax` | int|false |0 | The initially requested maximum frame
size in octets. <br /><br />0 means unlimited. |
-| `connectionTimeout` | int|false | 60000 | The timeout of TCP connection
establishment in milliseconds. <br /><br />0 means infinite. |
-| `handshakeTimeout` | int|false | 10000 | The timeout of AMQP0-9-1 protocol
handshake in milliseconds. |
-| `requestedHeartbeat` | int|false | 60 | The requested heartbeat timeout in
seconds. |
-| `prefetchCount` | int|false | 0 | The maximum number of messages that the
server delivers.<br /><br /> 0 means unlimited. |
-| `prefetchGlobal` | boolean|false | false |Whether the setting should be
applied to the entire channel rather than each consumer. |
-| `passive` | boolean|false | false | Whether the rabbitmq consumer should
create its own queue or bind to an existing one. |
+| Name | Type | Required | Default | Description
|
+|-----------------------|---------|----------|----------------|----------------------------------------------------------------------------------------|
+| `connectionName` | String | true | (empty string) | The connection
name. |
+| `host` | String | true | (empty string) | The RabbitMQ
host. |
+| `port` | int | true | 5672 | The RabbitMQ
port. |
+| `virtualHost` | String | true | / | The virtual
host used to connect to RabbitMQ. |
+| `username` | String | false | guest | The username
used to authenticate to RabbitMQ. |
+| `password` | String | false | guest | The password
used to authenticate to RabbitMQ. |
+| `queueName` | String | true | (empty string) | The RabbitMQ
queue name that messages should be read from or written to. |
+| `requestedChannelMax` | int | false | 0 | The initially
requested maximum channel number. <br/> 0 means unlimited. |
+| `requestedFrameMax` | int | false | 0 | The initially
requested maximum frame size in octets. <br/> 0 means unlimited. |
+| `connectionTimeout` | int | false | 60000 | The timeout of
TCP connection establishment in milliseconds. <br/> 0 means infinite. |
+| `handshakeTimeout` | int | false | 10000 | The timeout of
AMQP0-9-1 protocol handshake in milliseconds. |
+| `requestedHeartbeat` | int | false | 60 | The requested
heartbeat timeout in seconds. |
+| `prefetchCount` | int | false | 0 | The maximum
number of messages that the server delivers.<br/> 0 means unlimited. |
+| `prefetchGlobal` | boolean | false | false | Whether the
setting should be applied to the entire channel rather than each consumer. |
+| `passive` | boolean | false | false | Whether the
rabbitmq consumer should create its own queue or bind to an existing one. |
### Example
