Skip to main content
Version: 3.5.3

Output: amqp

Send events to AMQP server

Field Summary

Field NameTypeDescriptionDefault
uristringAMQP address to send events toamqp://localhost//
input-fieldfieldA field from where data is to be read, meaning JSON is assumed-
exchangeExchangeAn AMQP Exchange-
routing-keystringUsed in conjunction with topic exchange, to route data-
routing-key-fieldfieldA field containing the routing-key value-
queueQueueAn AMQP Queue-
persistentboolLet messages be cached and survive server restartfalse
durableboolLet Queue or Exchange survive server restartfalse

Fields

uri

Type: string

Default: amqp://localhost//

AMQP address to send events to

Example

Pipe Language Snippet:

amqp:
uri: amqp://localhost//

input-field

Type: field

A field from where data is to be read, meaning JSON is assumed

Example

Pipe Language Snippet:

amqp:
input-field: some-field
queue:
name: some-queue

exchange

Type: Exchange

An AMQP Exchange

Field NameTypeDescriptionDefault
namestringExchange name-
typestringExchange type-
passiveboolAssume Exchange has already been declared, else errorfalse

  name

Type: string

Exchange name

Example

Pipe Language Snippet:

amqp:
exchange:
name: some-exchange
type: fanout

  type

Type: string

Possible Values: fanout, topic, direct

Exchange type

There are 2 supported types:

  • fanout: For when same messages are to be consumed by multiple comsumers
  • topic: Topic-based pub-sub
  • direct: For when routing keys are to be used

Example

Pipe Language Snippet:

amqp:
exchange:
name: some-exchange
type: topic
routing-key: some.key

  passive

Type: bool

Default: false

Assume Exchange has already been declared, else error

Example

Pipe Language Snippet:

amqp:
exchange:
name: some-exchange
passive: true

routing-key

Type: string

Used in conjunction with topic exchange, to route data

routing-key-field

Type: field

A field containing the routing-key value

Example

Pipe Language Snippet:

amqp:
exchange:
name: some-exchange
type: topic
routing-key-field: some-field

queue

Type: Queue

An AMQP Queue

Unlike exchange, this keeps a backlog for when a consumer reconnects to get missed events.

Field NameTypeDescriptionDefault
namestringQueue name-
passiveboolAssume Queue has already been declared, else errorfalse

  name

Type: string

Queue name

Example

Pipe Language Snippet:

amqp:
queue:
name: queue-name

  passive

Type: bool

Default: false

Assume Queue has already been declared, else error

Example

Pipe Language Snippet:

amqp:
queue:
name: some-queue
passive: true

persistent

Type: bool

Default: false

Let messages be cached and survive server restart

Example

Pipe Language Snippet:

amqp:
queue:
name: some-queue
persistent: true

durable

Type: bool

Default: false

Let Queue or Exchange survive server restart

Example

Pipe Language Snippet:

amqp:
queue:
name: some-queue
durable: true