From: Rafael Kitover <rkitover@cpan.org>
Date: Tue, 25 Oct 2011 11:12:42 +0000 (-0400)
Subject: update DBIx::Class::Schema::Loader POD
X-Git-Tag: 0.07011~21
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=227cea92df7d444f3a69a57cb2a926031b3fb44e;p=dbsrgits%2FDBIx-Class-Schema-Loader.git

update DBIx::Class::Schema::Loader POD

Update list of supported DBDs and minimum necessary DBIx::Class version.
Remove the admonition that this module is for simple situations only.
Add link to ::Loader::Base for options.
---

diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm
index f701e74..7f33215 100644
--- a/lib/DBIx/Class/Schema/Loader.pm
+++ b/lib/DBIx/Class/Schema/Loader.pm
@@ -26,7 +26,7 @@ __PACKAGE__->_loader_args({});
 
 =head1 NAME
 
-DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
+DBIx::Class::Schema::Loader - Create a DBIx::Class::Schema based on a database
 
 =head1 SYNOPSIS
 
@@ -47,6 +47,7 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
   # from the command line or a shell script with dbicdump (distributed
   # with this module).  Do `perldoc dbicdump` for usage.
   dbicdump -o dump_directory=./lib \
+           -o components='["InflateColumn::DateTime"]' \
            -o debug=1 \
            My::Schema \
            'dbi:Pg:dbname=foo' \
@@ -76,15 +77,17 @@ DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
 =head1 DESCRIPTION 
 
 DBIx::Class::Schema::Loader automates the definition of a
-L<DBIx::Class::Schema> by scanning database table definitions and
-setting up the columns, primary keys, and relationships.
+L<DBIx::Class::Schema> by scanning database table definitions and setting up
+the columns, primary keys, unique constraints and relationships.
 
 See L<dbicdump> for the C<dbicdump> utility.
 
-DBIx::Class::Schema::Loader currently supports only the DBI storage type.  It
+DBIx::Class::Schema::Loader currently supports only the DBI storage type. It
 has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
+L<DBD::Firebird>, L<DBD::InterBase>, L<DBD::Informix>, L<DBD::SQLAnywhere>,
 L<DBD::SQLite>, L<DBD::Sybase> (for Sybase ASE and MSSSQL), L<DBD::ODBC> (for
-MSSQL) and L<DBD::Oracle>.  Other DBI drivers may function to a greater or
+MSSQL, MSAccess, Firebird and SQL Anywhere) L<DBD::ADO> (for MSSQL and
+MSAccess) and L<DBD::Oracle>.  Other DBI drivers may function to a greater or
 lesser degree with this loader, depending on how much of the DBI spec they
 implement, and how standard their implementation is.
 
@@ -93,23 +96,17 @@ Patches to make other DBDs work correctly welcome.
 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
 your own vendor-specific subclass for an unsupported DBD driver.
 
-This module requires L<DBIx::Class> 0.07006 or later, and obsoletes
-the older L<DBIx::Class::Loader>.
+This module requires L<DBIx::Class> 0.08127 or later, and obsoletes the older
+L<DBIx::Class::Loader>.
 
-This module is designed more to get you up and running quickly against
-an existing database, or to be effective for simple situations, rather
-than to be what you use in the long term for a complex database/project.
-
-That being said, transitioning your code from a Schema generated by this
-module to one that doesn't use this module should be straightforward and
-painless, so don't shy away from it just for fears of the transition down
-the road.
+See L<DBIx::Class::Schema::Loader::Base> for available options.
 
 =head1 METHODS
 
 =head2 loader
 
-The loader object, as class data on your Schema. For methods available see L<DBIx::Class::Schema::Loader::Base> and L<DBIx::Class::Schema::Loader::DBI>.
+The loader object, as class data on your Schema. For methods available see
+L<DBIx::Class::Schema::Loader::Base> and L<DBIx::Class::Schema::Loader::DBI>.
 
 =cut