added dev comments about per-cursor wrapper

[dbsrgits/DBIx-Class-RowCountStatistics.git] / lib / DBIx / Class / RowCountStatistics.pm

diff --git a/lib/DBIx/Class/RowCountStatistics.pm b/lib/DBIx/Class/RowCountStatistics.pm
index 75060c1..48ebc0a 100644 (file)
--- a/lib/DBIx/Class/RowCountStatistics.pm
+++ b/lib/DBIx/Class/RowCountStatistics.pm
@@ -12,7 +12,7 @@ our $VERSION = '0.000001'; # 0.0.1
 $VERSION = eval $VERSION;
 
 # Wrap the original ::Storage::DBI we received so we can extract data
-# from it's usage by the Cursor.
+# from it's usage by the Cursor. This wrapping is per-Cursor.
 around new => sub {
     my $orig = shift;
     my ($class, $storage, @rest) = @_;
@@ -73,6 +73,11 @@ DBIx::Class::RowCountStatistics - Provide row-count statistics
         { cursor_class => 'DBIx::Class::RowCountStatistics' },
     );
 
+=head1 WARNING
+
+This module overrides internal L<DBIx::Class> functionality, and might
+break with every update.
+
 =head1 DESCRIPTION
 
 This L<DBIx::Class::Storage::DBI::Cursor> subclass allows you to log the
@@ -89,20 +94,27 @@ If available on the L<DBIx::Class::Storage/debugobj>, this method will be
 called with the following signature:
 
     sub query_complete {
-        my ($self, $row_count, $sql, @bind_values) = @_;
+        my ($self, $row_count, $sql) = @_;
         ...
     }
 
-B<Note>: The passing of the C<@bind_values> is currently not yet
-implemented, and no values will be passed yet.
+=head1 SPONSORS
+
+Development of this module was sponsored by
+
+=over
+
+=item * Ctrl O L<http://ctrlo.com>
+
+=back
 
 =head1 AUTHOR
 
- r.sedlacek@shadowcat.co.uk
+ Robert Sedlacek <r.sedlacek@shadowcat.co.uk>
 
 =head1 CONTRIBUTORS
 
-None yet.
+ Matt S. Trout <mst@shadowcat.co.uk>
 
 =head1 COPYRIGHT