.. _rabbit-m-q-source-connector-config: Configuration Properties ------------------------ To use this connector, specify the name of the connector class in the ``connector.class`` configuration property. .. codewithvars:: properties connector.class=io.confluent.connect.rabbitmq.RabbitMQSourceConnector Connector-specific configuration properties are described below. |cp| ^^^^ .. include:: ../includes/platform-license.rst .. _rabbit-m-q-source-connector-license-config: .. include:: ../includes/platform-license-detail.rst Connection ^^^^^^^^^^ ``rabbitmq.host`` The RabbitMQ host to connect to. See `ConnectionFactory.setHost(java.lang.String) `_ * Type: string * Default: localhost * Importance: high ``rabbitmq.password`` The password to authenticate to RabbitMQ with. See `ConnectionFactory.setPassword(java.lang.String) `_ * Type: string * Default: guest * Importance: high ``rabbitmq.username`` The username to authenticate to RabbitMQ with. See `ConnectionFactory.setUsername(java.lang.String) `_ * Type: string * Default: guest * Importance: high ``rabbitmq.virtual.host`` The virtual host to use when connecting to the broker. See `ConnectionFactory.setVirtualHost(java.lang.String) `_ * Type: string * Default: / * Importance: high ``rabbitmq.port`` The RabbitMQ port to connect to. See `ConnectionFactory.setPort(int) `_ * Type: int * Default: 5672 * Importance: medium ``rabbitmq.automatic.recovery.enabled`` Enables or disables automatic connection recovery. See `ConnectionFactory.setAutomaticRecoveryEnabled(boolean) `_ * Type: boolean * Default: true * Importance: low ``rabbitmq.connection.timeout.ms`` Connection TCP establishment timeout in milliseconds. zero for infinite. See `ConnectionFactory.setConnectionTimeout(int) `_ * Type: int * Default: 60000 * Valid Values: [0,...] * Importance: low ``rabbitmq.handshake.timeout.ms`` The AMQP0-9-1 protocol handshake timeout, in milliseconds. See `ConnectionFactory.setHandshakeTimeout(int) `_ * Type: int * Default: 10000 * Importance: low ``rabbitmq.network.recovery.interval.ms`` See `ConnectionFactory.setNetworkRecoveryInterval(long) `_ * Type: int * Default: 10000 * Importance: low ``rabbitmq.requested.channel.max`` Initially requested maximum channel number. Zero for unlimited. See `ConnectionFactory.setRequestedChannelMax(int) `_ * Type: int * Default: 0 * Importance: low ``rabbitmq.requested.frame.max`` Initially requested maximum frame size, in octets. Zero for unlimited. See `ConnectionFactory.setRequestedFrameMax(int) `_ * Type: int * Default: 0 * Importance: low ``rabbitmq.requested.heartbeat.seconds`` Set the requested heartbeat timeout. Heartbeat frames will be sent at about 1/2 the timeout interval. If server heartbeat timeout is configured to a non-zero value, this method can only be used to lower the value; otherwise any value provided by the client will be used. See `ConnectionFactory.setRequestedHeartbeat(int) `_ * Type: int * Default: 60 * Importance: low ``rabbitmq.shutdown.timeout.ms`` Set the shutdown timeout. This is the amount of time that Consumer implementations have to continue working through deliveries (and other Consumer callbacks) after the connection has closed but before the ConsumerWorkService is torn down. If consumers exceed this timeout then any remaining queued deliveries (and other Consumer callbacks, *including* the Consumer's handleShutdownSignal() invocation) will be lost. See `ConnectionFactory.setShutdownTimeout(int) `_ * Type: int * Default: 10000 * Importance: low ``rabbitmq.topology.recovery.enabled`` Enables or disables topology recovery. See `ConnectionFactory.setTopologyRecoveryEnabled(boolean) `_ * Type: boolean * Default: true * Importance: low Source ^^^^^^ ``kafka.topic`` |ak-tm| topic to write the messages to. * Type: string * Importance: high ``rabbitmq.queue`` RabbitMQ queue to read from. * Type: list * Importance: high ``backoff.time.ms`` The number of milliseconds to wait when no records are returned from the RabbitMQ queue. * Type: int * Default: 100 * Valid Values: [1,...] * Importance: medium ``batch.size`` The maximum number of records to return to Connect for each poll, if there are more than this number of records already available from RabbitMQ. This setting is independent from the general producer setting ``batch.size`` * Type: int * Default: 1024 * Valid Values: [1,...] * Importance: medium ``rabbitmq.prefetch.count`` Maximum number of messages that the server will deliver, 0 if unlimited. See `Channel.basicQos(int, boolean) `_ * Type: int * Default: 0 * Importance: medium ``rabbitmq.prefetch.global`` True if the settings should be applied to the entire channel rather than each consumer. See `Channel.basicQos(int, boolean) `_ * Type: boolean * Default: false * Importance: medium .. _rabbitmq-source-connector-license-config: |cp| license ^^^^^^^^^^^^ ``confluent.topic.bootstrap.servers`` A list of host/port pairs to use for establishing the initial connection to the Kafka cluster used for licensing. All servers in the cluster will be discovered from the initial connection. This list should be in the form host1:port1,host2:port2,.... Since these servers are just used for the initial connection to discover the full cluster membership (which may change dynamically), this list need not contain the full set of servers (you may want more than one, though, in case a server is down). * Type: list * Importance: high ``confluent.topic`` Name of the Kafka topic used for Confluent Platform configuration, including licensing information. * Type: string * Default: _confluent-command * Importance: low ``confluent.topic.replication.factor`` The replication factor for the Kafka topic used for Confluent Platform configuration, including licensing information. This is used only if the topic does not already exist, and the default of 3 is appropriate for production use. If you are using a development environment with less than 3 brokers, you must set this to the number of brokers (often 1). * Type: int * Default: 3 * Importance: low ---------------------------- Confluent license properties ---------------------------- .. include:: ../includes/security-info.rst .. include:: ../includes/platform-license.rst .. include:: ../includes/security-configs.rst .. _rabbit-m-q-source-license-topic-configuration: .. include:: ../includes/platform-license-detail.rst .. include:: ../includes/overriding-default-config-properties.rst