This adapter allows you to access and manage RabbitMQ queues using SQL and REST commands.
Configuration Settings
|
Name
|
Description
|
Default |
| Boolean _isDefault |
Make this the default configuration. Defaults to true if configName is already the default. |
|
| String hostname |
The server where RabbitMQ is installed (ex: localhost) |
|
| String exchange |
The name of the exchange (leave blank for the default exchange) |
|
| String exchangeType |
The type of exchange (string.Empty, direct, fanout, topic) |
|
| String queueName |
The default queue name to connect to |
|
| String persist |
Set to 1 if messages should persist by default |
0 |
| String userId |
The user Id to connect |
|
| String password |
The password to connect |
|
| Boolean durable |
When true marks the queue durable |
False |
| Boolean autoDelete |
When true automatically deletes expired messages |
False |
| Boolean exclusive |
When true marks the queue exclusive |
False |
| String expiration |
Expiration of messages in the queue (ms) - 0: no expiration |
0 |
| String DLX |
Deal letter queue exchange name |
|
| String DLXR |
When DLX specified, changes default routing to the specified value |
|
Handlers
|
CreateQueue
|
Creates a queue with the default settings provided in the configuration and binds it to the exchange provided in the configuration settings
details
Arguments
|
Name
|
Description
|
Default |
|
queueName R
|
The name of the queue to use
|
|
|
routingKey
|
Comma-seperated list of routing keys used to bind the queue for direct and topic exchanges
|
|
SQL Call
EXEC RabbitMQ.CreateQueue 'myqueue' -- default or fanout
EXEC RabbitMQ.CreateQueue 'myqueue', 'white,green' -- direct
EXEC RabbitMQ.CreateQueue 'myqueue', '*.white.#,*.orange.large.*' -- topic
Http Call
/bsc/rabbitmq/createqueue
Output Columns
This call does not return data.
|
|
DeleteQueue
|
Deletes a queue
details
Arguments
|
Name
|
Description
|
Default |
|
queueName R
|
The name of the queue to use
|
|
SQL Call
EXEC RabbitMQ.DeleteQueue 'myqueue'
Http Call
/bsc/rabbitmq/deletequeue
Output Columns
This call does not return data.
|
|
GetMessage
|
Gets or peeks one or more messages from a queue
details
Arguments
|
Name
|
Description
|
Default |
|
queueName
|
The queue to read from (uses the config settings if empty)
|
|
|
count
|
Number of messages returned (1 by default); must be between 1 and 100; use TOP N in a SELECT command
|
1 |
|
peek
|
When 0 automatically ACKs the messages (0 by default)
|
False |
SQL Call
SELECT * FROM RabbitMQ.Messages
EXEC RabbitMQ.GetMessage
EXEC RabbitMQ.GetMessage 'myqueue', 5
Http Call
/bsc/rabbitmq/getmessage
Output Columns
| String routingKey | | | String exchange | | | String message | | | String replyTo | | | String appId | | | String messageId | | | String deliveryTag | | | Boolean redelivered | |
|
|
ping
|
Ping test
details
Arguments
SQL Call
EXEC RabbitMQ.ping
Http Call
/bsc/rabbitmq/ping
Output Columns
|
|
SendMessage
|
Sends a message to an exchange with zero, one or more routing keys
details
Arguments
|
Name
|
Description
|
Default |
|
message R
|
The message to send
|
|
|
routingKey
|
Comma-separated routing keys (leave blank for the default exchange; ignore by fanout exchanges)
|
|
|
expiration
|
The message expiration in ms
|
0 |
|
replyTo
|
The reply to address
|
|
|
appId
|
An application identifier
|
|
|
priority
|
The message priority (1-9)
|
1 |
|
persist
|
Indicates whether the message should be persisted
|
|
|
messageId
|
The message unique identifier (will be set to a random Guid if not provided)
|
|
SQL Call
EXEC RabbitMQ.SendMessage 'test'
Http Call
/bsc/rabbitmq/sendmessage
Output Columns
This call does not return data.
|
|
status
|
Gets the status of the RabbitMQ node
details
Arguments
|
Name
|
Description
|
Default |
|
hostname
|
The name of the host where RabbitMQ is running
|
|
SQL Call
EXEC RabbitMQ.Status
Http Call
/bsc/rabbitmq/status
Output Columns
| String host | | | Int32 port | | | String apiName | | | Int32 majVersion | | | Int32 minVersion | | | Int32 revision | | | String ssl | |
|
