forked from omniti-labs/pg_amqp
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add spare documentation. Someone should add more!
- Loading branch information
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
amqp 0.2.0 | ||
========== | ||
|
||
Synopsis | ||
-------- | ||
|
||
% CREATE EXTENSION amqp; | ||
CREATE EXTENSION | ||
|
||
% SELECT amqp.publish(broker_id, 'amqp.direct', 'foo', 'message'); | ||
|
||
Description | ||
----------- | ||
|
||
The pg_amqp package provides the ability for postgres statements to directly | ||
publish messages to an [AMQP](http://www.amqp.org/) broker. | ||
|
||
Usage | ||
----- | ||
Insert AMQP broker information (host/port/user/pass) into the | ||
`amqp.broker` table. | ||
|
||
A process starts and connects to PostgreSQL and runs: | ||
|
||
SELECT amqp.publish(broker_id, 'amqp.direct', 'foo', 'message'); | ||
|
||
Upon process termination, all broker connections will be torn down. | ||
If there is a need to disconnect from a specific broker, one can call: | ||
|
||
select amqp.disconnect(broker_id); | ||
|
||
which will disconnect from the broker if it is connected and do nothing | ||
if it is already disconnected. | ||
|
||
Support | ||
------- | ||
|
||
This library is stored in an open [GitHub | ||
repository](http://github.com/omniti-labs/pg_amqp). Feel free to fork and | ||
contribute! Please file bug reports via [GitHub | ||
Issues](http://github.com/omniti-labs/pg_amqp/issues/). | ||
|
||
Author | ||
------ | ||
|
||
[Theo Schlossnagle](http://lethargy.org/~jesus/) |