Source Configuration Options
Reference of the source connector options.
Database
connection.cluster_address
Couchbase Cluster addresses to listen (use comma to specify several).
-
Type: list
-
Importance: high
connection.username
Couchbase username for Couchbase Server 5.0 and later.
-
Type: string
-
Importance: high
-
Default: the bucket name specified by
connection.bucket
connection.password
Couchbase password. For Couchbase Server versions prior to 5.0 this is the bucket password.
For versions 5.0 and later, this is the password associated with connection.username
.
-
Type: password
-
Importance: low
-
Default:
""
Connector
use_snapshots
If true, it will only commit into Kafka when full snapshot from Couchbase received.
-
Type: boolean
-
Importance: low
-
Default:
false
dcp.message.converter.class
The class name of the message converter to use.
-
Type: string
-
Importance: low
-
Default:
"com.couchbase.connect.kafka.handler.source.DefaultSchemaSourceHandler"
event.filter.class
The class name of the event filter to use.
-
Type: string
-
Importance: low
-
Default:
"com.couchbase.connect.kafka.filter.AllPassFilter"
couchbase.stream_from
The point in Couchbase history to start streaming from.
-
Possible values:
-
SAVED_OFFSET_OR_BEGINNING - Restart from saved state, or if none, restart from oldest available mutation in Couchbase
-
SAVED_OFFSET_OR_NOW - Restart from saved state, or if none, restart from current Couchbase state
-
BEGINNING - Restart from oldest available mutation in Couchbase (ignore any potential saved state)
-
NOW - Restart from current Couchbase state (ignore any potential saved state)
-
-
Since: 3.2.2
-
Type: string
-
Importance: low
-
Default:
"SAVED_OFFSET_OR_BEGINNING"
couchbase.log_redaction
Optionally tag sensitive values in the log output for later redaction.
-
Possible values:
-
NONE - No redaction is performed.
-
PARTIAL - Only user data is redacted, system and metadata are not.
-
FULL - User, System and Metadata are all redacted.
-
-
Since: 3.2.3
-
Type: string
-
Importance: low
-
Default:
"NONE"
couchbase.compression
To reduce bandwidth usage, Couchbase Server 5.5 and later can send documents to the connector in compressed form. (Messages are always published to the Kafka topic in uncompressed form, regardless of this setting.) If the requested mode is not supported by your version of Couchbase Server, compression will be disabled.
-
Possible values:
-
ENABLED
- (default) Couchbase Server decides whether to use compression on a per-document basis, depending on whether the compressed form of the document is readily available. Select this mode to prioritize Couchbase Server performance and reduced bandwidth usage (recommended). Requires Couchbase Server 5.5 or later. -
DISABLED
- No compression. Select this mode to prioritize reduced CPU load for the Kafka connector. -
FORCED
- Compression is used for every document, unless compressed size is greater than uncompressed size. Select this mode to prioritize bandwidth usage reduction above all else. Requires Couchbase Server 5.5 or later.
-
-
Since: 3.3.0
-
Type: string
-
Importance: low
-
Default:
"ENABLED"
couchbase.forceIPv4
In a network environment that supports both IPv4 and IPv6, setting this property to true
will force the use of IPv4 when resolving Couchbase Server hostnames.
-
Since: 3.3.0
-
Type: boolean
-
Importance: low
-
Default:
false
Parent topic: Kafka Connector
Previous topic: Quickstart
Next topic: Sink Configuration Options