diff options
author | Marko Kreen | 2012-07-19 11:15:45 +0000 |
---|---|---|
committer | Marko Kreen | 2012-07-19 11:15:45 +0000 |
commit | 7f4dafd34c2f628e4ad37a26560fd52d6bf580b2 (patch) | |
tree | 1f97e4faf1af99db50339b69ac1e6b2691e3d234 | |
parent | 993cb985382e775690666f0d664492de98b239f2 (diff) |
Add manpages for new scripts.
Also clean up minor issues in common text fragments.
-rw-r--r-- | debian/skytools3.docs | 2 | ||||
-rw-r--r-- | debian/skytools3.manpages | 2 | ||||
-rw-r--r-- | doc/Makefile | 3 | ||||
-rw-r--r-- | doc/common.config.txt | 4 | ||||
-rw-r--r-- | doc/common.switches.txt | 3 | ||||
-rw-r--r-- | doc/simple_consumer3.txt | 28 | ||||
-rw-r--r-- | doc/simple_local_consumer3.txt | 28 |
7 files changed, 67 insertions, 3 deletions
diff --git a/debian/skytools3.docs b/debian/skytools3.docs index b5dc5622..b68b9842 100644 --- a/debian/skytools3.docs +++ b/debian/skytools3.docs @@ -5,3 +5,5 @@ debian/tmp/usr/share/doc/skytools3/skytools3.html debian/tmp/usr/share/doc/skytools3/queue_splitter.html debian/tmp/usr/share/doc/skytools3/queue_mover.html debian/tmp/usr/share/doc/skytools3/londiste3.html +debian/tmp/usr/share/doc/skytools3/simple_consumer3.html +debian/tmp/usr/share/doc/skytools3/simple_local_consumer3.html diff --git a/debian/skytools3.manpages b/debian/skytools3.manpages index a92296f5..5e3caae3 100644 --- a/debian/skytools3.manpages +++ b/debian/skytools3.manpages @@ -3,3 +3,5 @@ debian/tmp/usr/share/man/man1/qadmin.1 debian/tmp/usr/share/man/man1/londiste3.1 debian/tmp/usr/share/man/man1/queue_mover3.1 debian/tmp/usr/share/man/man1/queue_splitter3.1 +debian/tmp/usr/share/man/man1/simple_consumer3.1 +debian/tmp/usr/share/man/man1/simple_local_consumer3.1 diff --git a/doc/Makefile b/doc/Makefile index 3937572d..f1a972af 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -14,6 +14,7 @@ DOCHTML = \ londiste3.html walmgr3.html qadmin.html scriptmgr.html \ sql-grants.html \ skytools_upgrade.html queue_mover.html queue_splitter.html \ + simple_consumer3.html simple_local_consumer3.html \ howto/londiste3_cascaded_rep_howto.html \ howto/londiste3_merge_howto.html \ howto/londiste3_partitioning_howto.html \ @@ -23,7 +24,7 @@ DOCHTML = \ MAN5 = MAN1_SFX = scriptmgr.1 skytools_upgrade.1 queue_mover.1 queue_splitter.1 -MAN1 = qadmin.1 pgqd.1 walmgr3.1 londiste3.1 +MAN1 = qadmin.1 pgqd.1 walmgr3.1 londiste3.1 simple_consumer3.1 simple_local_consumer3.1 FQHTML = $(addprefix html/doc/, $(DOCHTML)) $(addprefix html/, $(TOPHTML)) FQMAN1 = $(addprefix man/, $(MAN1)) diff --git a/doc/common.config.txt b/doc/common.config.txt index 7a74623f..1575d8cb 100644 --- a/doc/common.config.txt +++ b/doc/common.config.txt @@ -26,11 +26,11 @@ ifdef::pgq[] === Common PgQ consumer parameters === - pgq_queue_name:: + queue_name:: Queue name to attach to. No default. - pgq_consumer_id:: + consumer_name:: Consumers ID to use when registering. Default: %(job_name)s diff --git a/doc/common.switches.txt b/doc/common.switches.txt index 72da7bc3..fe5360da 100644 --- a/doc/common.switches.txt +++ b/doc/common.switches.txt @@ -14,6 +14,9 @@ Python programs. -d, --daemon:: make program go background + --ini:: + show commented template config file. + Following switches are used to control already running process. The pidfile is read from config then signal is sent to process id specified there. diff --git a/doc/simple_consumer3.txt b/doc/simple_consumer3.txt new file mode 100644 index 00000000..c746f5a1 --- /dev/null +++ b/doc/simple_consumer3.txt @@ -0,0 +1,28 @@ + += simple_consumer3(1) = + +== NAME == + +simple_consumer3 - PgQ consumer that executes query for each event + +== SYNOPSIS == + + simple_consumer3.py [switches] config.ini + +== DESCRIPTION == + +For each event in batch it will execute query, filling event +values into it. + +Transactionality: query is executed in autocommit mode, +no batch tracking is done. That means on failure, +whole batch is fetched and all events are processed again. + +== CONFIG == + +Run `simple_consumer3 --ini` to see commented config template. + +== COMMAND LINE SWITCHES == + +include::common.switches.txt[] + diff --git a/doc/simple_local_consumer3.txt b/doc/simple_local_consumer3.txt new file mode 100644 index 00000000..04c4db5d --- /dev/null +++ b/doc/simple_local_consumer3.txt @@ -0,0 +1,28 @@ + += simple_local_consumer3(1) = + +== NAME == + +simple_local_consumer3 - PgQ consumer that executes query for each row + +== SYNOPSIS == + + simple_local_consumer3.py [switches] config.ini + +== DESCRIPTION == + +For each event in batch it will execute query, filling event +values into it. + +Transactionality: query is executed in autocommit mode, +completed batch is tracked in local file. It can be switched +between nodes in cascaded queue. + +== CONFIG == + +Run `simple_local_consumer3 --ini` to see commented config template. + +== COMMAND LINE SWITCHES == + +include::common.switches.txt[] + |