X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FStorage%2FStatistics.pm;h=d4937d1932391deb3eeed718c4cd3d8838d8798a;hb=c6fa3170af14483e9d749931642fdd3000baa28c;hp=09f79da830b4acbd938d96b637108a35244e44bf;hpb=0547bab13aa1008c751cbb7f72a3743ceed9a5c2;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Storage/Statistics.pm b/lib/DBIx/Class/Storage/Statistics.pm index 09f79da..d4937d1 100644 --- a/lib/DBIx/Class/Storage/Statistics.pm +++ b/lib/DBIx/Class/Storage/Statistics.pm @@ -2,8 +2,10 @@ package DBIx::Class::Storage::Statistics; use strict; use warnings; -use base qw/DBIx::Class::AccessorGroup Class::Data::Accessor/; -__PACKAGE__->mk_group_accessors(simple => qw/callback debugfh/); +use base qw/DBIx::Class/; +use IO::File; + +__PACKAGE__->mk_group_accessors(simple => qw/callback _debugfh silence/); =head1 NAME @@ -14,7 +16,7 @@ DBIx::Class::Storage::Statistics - SQL Statistics =head1 DESCRIPTION This class is called by DBIx::Class::Storage::DBI as a means of collecting -statistics on it's actions. Using this class alone merely prints the SQL +statistics on its actions. Using this class alone merely prints the SQL executed, the fact that it completes and begin/end notification for transactions. @@ -44,6 +46,52 @@ be an IO::Handle compatible object (only the C method is used). Initially should be set to STDERR - although see information on the L environment variable. +As getter it will lazily open a filehandle for you if one is not already set. + +=cut + +sub debugfh { + my $self = shift; + + if (@_) { + $self->_debugfh($_[0]); + } elsif (!defined($self->_debugfh())) { + my $fh; + my $debug_env = $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} + || $ENV{DBIC_TRACE}; + if (defined($debug_env) && ($debug_env =~ /=(.+)$/)) { + $fh = IO::File->new($1, 'w') + or die("Cannot open trace file $1"); + } else { + $fh = IO::File->new('>&STDERR') + or die('Duplication of STDERR for debug output failed (perhaps your STDERR is closed?)'); + } + + $fh->autoflush(); + $self->_debugfh($fh); + } + + $self->_debugfh; +} + +=head2 print + +Prints the specified string to our debugging filehandle. Provided to save our +methods the worry of how to display the message. + +=cut +sub print { + my ($self, $msg) = @_; + + return if $self->silence; + + $self->debugfh->print($msg); +} + +=head2 silence + +Turn off all output if set to true. + =head2 txn_begin Called when a transaction begins. @@ -52,7 +100,9 @@ Called when a transaction begins. sub txn_begin { my $self = shift; - $self->debugfh->print("BEGIN WORK\n"); + return if $self->callback; + + $self->print("BEGIN WORK\n"); } =head2 txn_rollback @@ -63,7 +113,9 @@ Called when a transaction is rolled back. sub txn_rollback { my $self = shift; - $self->debugfh->print("ROLLBACK\n"); + return if $self->callback; + + $self->print("ROLLBACK\n"); } =head2 txn_commit @@ -74,7 +126,48 @@ Called when a transaction is committed. sub txn_commit { my $self = shift; - $self->debugfh->print("COMMIT\n"); + return if $self->callback; + + $self->print("COMMIT\n"); +} + +=head2 svp_begin + +Called when a savepoint is created. + +=cut +sub svp_begin { + my ($self, $name) = @_; + + return if $self->callback; + + $self->print("SAVEPOINT $name\n"); +} + +=head2 svp_release + +Called when a savepoint is released. + +=cut +sub svp_release { + my ($self, $name) = @_; + + return if $self->callback; + + $self->print("RELEASE SAVEPOINT $name\n"); +} + +=head2 svp_rollback + +Called when rolling back to a savepoint. + +=cut +sub svp_rollback { + my ($self, $name) = @_; + + return if $self->callback; + + $self->print("ROLLBACK TO SAVEPOINT $name\n"); } =head2 query_start @@ -94,7 +187,7 @@ sub query_start { return; } - $self->debugfh->print($message); + $self->print($message); } =head2 query_end