Release 0.07037
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI / Writing.pm
index 3ac5618..86a0fc4 100644 (file)
@@ -1,9 +1,9 @@
 package DBIx::Class::Schema::Loader::DBI::Writing;
 use strict;
 
-# Empty. POD only.
+our $VERSION = '0.07037';
 
-1;
+# Empty. POD only.
 
 =head1 NAME                                                                     
                                                                                 
@@ -18,7 +18,7 @@ DBIx::Class::Schema::Loader::DBI::Writing - Loader subclass writing guide for DB
   use strict;
   use warnings;
   use base 'DBIx::Class::Schema::Loader::DBI';
-  use Class::C3;
+  use mro 'c3';
 
   sub _table_uniq_info {
       my ($self, $table) = @_;
@@ -37,19 +37,42 @@ DBIx::Class::Schema::Loader::DBI::Writing - Loader subclass writing guide for DB
       # concatenated if you wish.
   }
 
+  sub _table_comment {
+      my ( $self, $table ) = @_;
+      return 'Comment';
+  }
+
+  sub _column_comment {
+      my ( $self, $table, $column_number ) = @_;
+      return 'Col. comment';
+  }
+
   1;
 
 =head1 DETAILS
 
 The only required method for new subclasses is C<_table_uniq_info>,
-as I have not to date found any pseudo-standardized or DBD-agnostic
-way for obtaining this information.
+as there is not (yet) any standardized, DBD-agnostic way for obtaining
+this information from DBI.
 
 The base DBI Loader contains generic methods that *should* work for
 everything else in theory, although in practice some DBDs need to
 override one or more of the other methods.  The other methods one might
-likely want to override are: C<_table_pk_info>, C<_table_fk_info>, and
-C<_tables_list>.  See the included DBD drivers for examples of these.
+likely want to override are: C<_table_pk_info>, C<_table_fk_info>,
+C<_tables_list> and C<_extra_column_info>.  See the included DBD drivers
+for examples of these.
+
+To import comments from the database you need to implement C<_table_comment>,
+C<_column_comment>
+
+=head1 AUTHOR
+
+See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+
+=head1 LICENSE
+
+This library is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
 
 =cut