add some docs

[dbsrgits/SQL-Abstract.git] / lib / DBIx / Class / Storage / PrettyPrinter.pm

diff --git a/lib/DBIx/Class/Storage/PrettyPrinter.pm b/lib/DBIx/Class/Storage/PrettyPrinter.pm
index 58a64a4..d71995f 100644 (file)
--- a/lib/DBIx/Class/Storage/PrettyPrinter.pm
+++ b/lib/DBIx/Class/Storage/PrettyPrinter.pm
@@ -27,3 +27,28 @@ sub query_start {
 }
 
 1;
+
+=pod
+
+=head1 SYNOPSIS
+
+ package MyApp::Schema;
+
+ use parent 'DBIx::Class::Schema';
+
+ use DBIx::Class::Storage::PrettyPrinter;
+
+ __PACKAGE__->load_namespaces;
+
+ my $pp = DBIx::Class::Storage::PrettyPrinter->new({ profile => 'console' });
+
+ sub connection {
+       my $self = shift;
+
+       my $ret = $self->next::method(@_);
+
+       $self->storage->debugobj($pp);
+
+       $ret
+ }
+