Changeset 156

Timestamp:

02/09/09 21:46:10 (10 months ago)

Author:

swistow

Message:

Merge in trunk

Files:

• branches/use-existing-dbh/lib/TheSchwartz.pm (modified) (3 diffs)

branches/use-existing-dbh/lib/TheSchwartz.pm

@@ -833 +833 @@
 appropriate jobs in the other databases automatically.
 
-Each member of the C<databases> value should be a hashref containing:
+Each member of the C<databases> value should be a hashref containing either:
 
 =over 4
@@ -848 +848 @@
 
 The password to use when connecting to this database.
+
+=back
+
+or
+
+=over 4
+
+=item * C<driver>
+
+A C<Data::ObjectDriver::Driver::DBI> object.
+
+See note below.
 
 =back
@@ -1014 +1026 @@
 Given an open driver I<$driver> to a database, gets the current server time from the database.
 
+=head1 THE SCOREBOARD
+
+The scoreboards can be used to monitor what the TheSchwartz::Worker subclasses are
+currently working on.  Once the scoreboard has been enabled in the workers with
+C<set_scoreboard> method the C<thetop> utility (shipped with TheSchwartz distribuition
+in the C<extras> directory) can be used to list all current jobs being worked on.
+
+=head2 C<< $client->set_scoreboard( $dir ) >>
+
+Enables the scoreboard.  Setting this to C<1> or C<on> will cause TheSchwartz to create
+a scoreboard file in a location it determines is optimal.
+
+Passing in any other option sets the directory the TheSchwartz scoreboard directory should
+be created in.  For example, if you set this to C</tmp> then this would create a directory
+called C</tmp/theschwartz> and a scoreboard file C</tmp/theschwartz/scoreboard.pid> in it
+(where pid is the current process pid.) 
+
+=head2 C<< $client->scoreboard() >>
+
+Returns the path to the current scoreboard file.
+
+=head2 C<< $client->start_scoreboard() >>
+
+Writes the current job information to the scoreboard file (called by the worker
+in work_safely before it actually starts working)
+
+=head2 C<< $client->end_scoreboard() >>
+
+Appends the current job duration to the end of the scoreboard file (called by
+the worker in work_safely once work has been completed)
+
+=head2 C<< $client->clean_scoreboard() >>
+
+Removes the scoreboard file (but not the scoreboard directory.)  Automatically
+called by TheSchwartz during object destruction (i.e. when the instance goes
+out of scope)
+
+=head1 PASSING IN AN EXISTING DRIVER
+
+You can pass in a existing C<Data::Object::Driver::DBI> object which also allows you
+to reuse exist Database handles like so:
+
+        my $dbh = DBI->connect( $dsn, "root", "", {
+                RaiseError => 1,
+                PrintError => 0,
+                AutoCommit => 1,
+            } ) or die $DBI::errstr;
+        my $driver = Data::ObjectDriver::Driver::DBI->new( dbh => $dbh);
+        return TheSchwartz->new(databases => [{ driver => $driver }]);
+
+B<Note>: it's important that the C<RaiseError> and C<AutoCommit> flags are 
+set on the handle for various bits of functionality to work.
+
+
 =head1 COPYRIGHT, LICENSE & WARRANTY