This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 61a9c8cd75bbbf525c6d8f1249ff1c186f315b31
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Thu Jul 4 14:05:49 2019 +0200
Regen
---
components/readme.adoc | 8 +-
docs/components/modules/ROOT/nav.adoc | 1 +
.../ROOT/pages/pg-replication-slot-component.adoc | 162 +++++++++++++++++++++
3 files changed, 167 insertions(+), 4 deletions(-)
diff --git a/components/readme.adoc b/components/readme.adoc
index 9691ce0..037831b 100644
--- a/components/readme.adoc
+++ b/components/readme.adoc
@@ -1,7 +1,7 @@
==== Components
// components: START
-Number of Components: 296 in 233 JAR artifacts (0 deprecated)
+Number of Components: 297 in 234 JAR artifacts (0 deprecated)
[width="100%",cols="4,1,5",options="header"]
|===
@@ -664,12 +664,12 @@ Number of Components: 296 in 233 JAR artifacts (0
deprecated)
| link:camel-pdf/src/main/docs/pdf-component.adoc[PDF] (camel-pdf) +
`pdf:operation` | 2.16 | The pdf components provides the ability to create,
modify or extract content from PDF documents.
-|
link:camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc[PostgresSQL
Replication Slot] (camel-pg-replication-slot) +
-`pg-replication-slot:host:port/database/slot` | 2.25 | The pg-replication-slot
component allows for consuming PostgreSQL Streaming Replication change events.
-
| link:camel-pgevent/src/main/docs/pgevent-component.adoc[PostgresSQL Event]
(camel-pgevent) +
`pgevent:host:port/database/channel` | 2.15 | The pgevent component allows for
producing/consuming PostgreSQL events related to the listen/notify commands.
+|
link:camel-pg-replication-slot/src/main/docs/pg-replication-slot-component.adoc[PostgresSQL
Replication Slot] (camel-pg-replication-slot) +
+`pg-replication-slot:host:port/database/slot:plugin` | 3.0 | Consumer endpoint
to receive from PostgreSQL Replication Slot.
+
| link:camel-printer/src/main/docs/lpr-component.adoc[Printer] (camel-printer)
+
`lpr:hostname:port/printername` | 2.1 | The printer component is used for
sending messages to printers as print jobs.
diff --git a/docs/components/modules/ROOT/nav.adoc
b/docs/components/modules/ROOT/nav.adoc
index dc62951..67b3ddb 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -257,6 +257,7 @@
* xref:paho-component.adoc[Paho Component]
* xref:paxlogging-component.adoc[OSGi PAX Logging Component]
* xref:pdf-component.adoc[PDF Component]
+* xref:pg-replication-slot-component.adoc[PostgresSQL Replication Slot
Component]
* xref:pgevent-component.adoc[PostgresSQL Event Component]
* xref:lpr-component.adoc[Printer Component]
* xref:properties-component.adoc[Properties Component]
diff --git
a/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc
b/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc
new file mode 100644
index 0000000..7cab4eb
--- /dev/null
+++ b/docs/components/modules/ROOT/pages/pg-replication-slot-component.adoc
@@ -0,0 +1,162 @@
+[[pg-replication-slot-component]]
+== PostgresSQL Replication Slot Component
+
+*Available as of Camel version 3.0*
+
+This is a component for Apache Camel which allows for
+consuming from PostgreSQL replication slots. The component works with
PostgreSQL 10 or later.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-pg-replication-slot</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+URI format
+
+The pg-replication-slot component uses the following two styles of endpoint URI
+notation:
+
+[source,java]
+-------------------------------------------------
+pg-replication-slot://host:port/database/slot:plugin[?parameters]
+-------------------------------------------------
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+### Options
+
+
+// component options: START
+The PostgresSQL Replication Slot component supports 2 options, which are
listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *resolveProperty Placeholders* (advanced) | Whether the component should
resolve property placeholders on itself when starting. Only properties which
are of String type can use property placeholders. | true | boolean
+| *basicPropertyBinding* (advanced) | Whether the component should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+|===
+// component options: END
+
+
+
+// endpoint options: START
+The PostgresSQL Replication Slot endpoint is configured using URI syntax:
+
+----
+pg-replication-slot:host:port/database/slot:plugin
+----
+
+with the following path and query parameters:
+
+==== Path Parameters (5 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *slot* | *Required* Replication slot name. | | String
+| *host* | PostgreSQL server host | localhost | String
+| *port* | PostgreSQL server port | 5432 | Integer
+| *database* | *Required* PostgreSQL database name | | String
+| *outputPlugin* | *Required* Output plugin name (e.g. test_decoding,
wal2json) | | String
+|===
+
+
+==== Query Parameters (25 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *password* (common) | PostgreSQL password | | String
+| *user* (common) | PostgreSQL username | postgres | String
+| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions occurred while the
consumer is trying to pickup incoming messages, or the likes, will now be
processed as a message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll
any files, you can enable this option to send an empty message (no body)
instead. | false | boolean
+| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. | | ExchangePattern
+| *pollStrategy* (consumer) | A pluggable
org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your
custom implementation to control error handling usually occurred during the
poll operation before an Exchange have been created and being routed in Camel.
| | PollingConsumerPoll Strategy
+| *autoCreateSlot* (advanced) | Auto create slot if it does not exist | true |
Boolean
+| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic
property binding (Camel 2.x) or the newer property binding with additional
capabilities | false | boolean
+| *slotOptions* (advanced) | Slot options to be passed to the output plugin. |
| Map
+| *statusInterval* (advanced) | Specifies the number of seconds between status
packets sent back to Postgres server. | 10 | Integer
+| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls
(failed due some error) that should happen before the backoffMultipler should
kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls
that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer
backoff if there has been a number of subsequent idles/errors in a row. The
multiplier is then the number of polls that will be skipped before the next
actual attempt is happening again. When this option is in use then
backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |
int
+| *delay* (scheduler) | Milliseconds before the next poll. You can also
specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and
30 seconds), and 1h (1 hour). | 500 | long
+| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer
will run immediately again, if the previous run polled 1 or more messages. |
false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You
can also specify time values using units, such as 60s (60 seconds), 5m30s (5
minutes and 30 seconds), and 1h (1 hour). | 1000 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line
when it polls. This option allows you to configure the logging level for that.
| TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a
custom/shared thread pool to use for the consumer. By default each consumer has
its own single threaded thread pool. | | ScheduledExecutor Service
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring
or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
+| *schedulerProperties* (scheduler) | To configure additional properties when
using a custom scheduler or any of the Quartz2, Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started.
| true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. |
MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used.
See ScheduledExecutorService in JDK for details. | true | boolean
+|===
+// endpoint options: END
+// spring-boot-auto-configure options: START
+=== Spring Boot Auto-Configuration
+
+When using Spring Boot make sure to use the following Maven dependency to have
support for auto configuration:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-pg-replication-slot-starter</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+----
+
+
+The component supports 3 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *camel.component.pg-replication-slot.basic-property-binding* | Whether the
component should use basic property binding (Camel 2.x) or the newer property
binding with additional capabilities | false | Boolean
+| *camel.component.pg-replication-slot.enabled* | Enable pg-replication-slot
component | true | Boolean
+| *camel.component.pg-replication-slot.resolve-property-placeholders* |
Whether the component should resolve property placeholders on itself when
starting. Only properties which are of String type can use property
placeholders. | true | Boolean
+|===
+// spring-boot-auto-configure options: END
+
+### Example
+
+[source,java]
+----
+from("pg-replication-slot://localhost:5432/finance/sync_slot:test_decoding?user={{username}}&password={{password}}&slotOptions.skip-empty-xacts=true&slotOptions.include-xids=false")
+ .to("mock:result");
+----
+
+### Tips
+
+TIP: PostgreSQL can generate a huge amount of empty transactions on certain
operations (e.g. `VACUUM`). These transactions can congest
+your route. Using `greedy=true` query parameter can help with this problem. It
will help your route filter out empty transactions quickly
+without waiting for the `delay`*`timeUnit` parameter between each exchange.
+
+TIP: The order of the messages is guaranteed, but the same message might come
more than once. So, for example, if you're using
+this component to sync data from PostgreSQL to other database, make sure your
operations are idempotent (e.g. use UPSERT
+instead of INSERT,...). This will make sure repeated messages won't affect
your system negatively.
+
+
+### See Also
+
+* Configuring Camel
+* Component
+* Endpoint
+* Getting Started
