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;
+use namespace::clean;
+
+__PACKAGE__->mk_group_accessors(simple => qw/callback _debugfh silence/);
=head1 NAME
=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.
should be set to STDERR - although see information on the
L<DBIC_TRACE> 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, 'a')
+ 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.
sub txn_begin {
my $self = shift;
- $self->debugfh->print("BEGIN WORK\n");
+ return if $self->callback;
+
+ $self->print("BEGIN WORK\n");
}
=head2 txn_rollback
sub txn_rollback {
my $self = shift;
- $self->debugfh->print("ROLLBACK\n");
+ return if $self->callback;
+
+ $self->print("ROLLBACK\n");
}
=head2 txn_commit
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
if(defined($self->callback)) {
$string =~ m/^(\w+)/;
- $self->callback()->($1, $message);
+ $self->callback->($1, $message);
return;
}
- $self->debugfh->print($message);
+ $self->print($message);
}
=head2 query_end
1;
-=head1 AUTHORS
+=head1 AUTHOR AND CONTRIBUTORS
-Cory G. Watson <gphat@cpan.org>
+See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
=head1 LICENSE
-You may distribute this code under the same license as Perl itself.
+You may distribute this code under the same terms as Perl itself.
=cut