RabbitMQ connector reference
This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.
This page contains reference documentation for the managed RabbitMQ connector in Lakeflow Connect.
Connector options
The following options configure the RabbitMQ source for each destination table in the ingestion pipeline. Specify these options under connector_options.rabbitmq_options in your pipeline definition. See Examples for full pipeline examples.
Option | Type | Default | Description |
|---|---|---|---|
| String | — | (Required) Name of the RabbitMQ classic queue to consume from. |
Connection properties
When you create the Unity Catalog RabbitMQ connection in Catalog Explorer, you must specify the following properties. See Create a RabbitMQ connection for connection creation steps.
Property | Description |
|---|---|
Connection name | A unique name for the connection in Unity Catalog. |
Connection type | Select RabbitMQ. |
Host | The hostname of the RabbitMQ broker. |
Username | The username used to authenticate with the RabbitMQ broker. |
Password | The password used to authenticate with the RabbitMQ broker. |
Virtual host | The virtual host of the RabbitMQ broker. The default virtual host is |
Port | The port of the RabbitMQ broker. The default port is |
Destination table schema
The RabbitMQ connector writes to streaming tables (append-only). Each destination table contains the decoded message body and RabbitMQ metadata columns, including a _redelivered column that is true for messages that were redelivered after a failed acknowledgement.