cba7285c99
* Added RabbitMQ destination * Added unit tests * Added exchange to config * Updated to support different connection parameters * Added integration tests * Added RabbitMQ destination documentation * small change * Addressed PR comments * add creds * format files * bump connector config files version * run format Co-authored-by: Marcos Marx <marcosmarxm@gmail.com>
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# RabbitMQ
|
|
|
|
## Overview
|
|
|
|
The RabbitMQ destination allows you to send/stream data to a RabbitMQ routing key. RabbitMQ is one of the most popular open source message brokers.
|
|
|
|
### Sync overview
|
|
|
|
#### Output schema
|
|
|
|
Each stream will be output a RabbitMQ message with properties. The message properties will be
|
|
|
|
* `content_type`: set as `application/json`
|
|
* `headers`: message headers, which include:
|
|
* `stream`: the name of stream where the data is coming from
|
|
* `namespace`: namespace if available from the stream
|
|
* `emitted_at`: timestamp the `AirbyteRecord` was emitted at.
|
|
|
|
The `AirbyteRecord` data will be serialized as JSON and set as the RabbitMQ message body.
|
|
|
|
#### Features
|
|
|
|
| Feature | Supported?\(Yes/No\) | Notes |
|
|
| :--- | :--- | :--- |
|
|
| Full Refresh Sync | Yes | |
|
|
| Incremental - Append Sync | Yes | |
|
|
| Incremental - Deduped History | No | As this connector does not support dbt, we don't support this sync mode on this destination. |
|
|
| Namespaces | Yes | |
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
To use the RabbitMQ destination, you'll need:
|
|
|
|
* A RabbitMQ host and credentials (username/password) to publish messages, if required.
|
|
* A RabbitMQ routing key.
|
|
* RabbitMQ exchange is optional. If specified, a binding between exchange and routing key is required.
|
|
* RabbitMQ port is optional (it defaults to 5672).
|
|
* RabbitMQ virtual host is also optional.
|
|
|
|
## CHANGELOG
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :--- | :--- | :--- | :--- |
|
|
| 0.1.0 | October 29, 2021 | [\#7560](https://github.com/airbytehq/airbyte/pull/7560) | Initial release |
|
|
|