Some cleaup, make use of Text::CSV
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Admin.pm
index 318dd87..bd7cec6 100644 (file)
@@ -30,16 +30,25 @@ use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/;
 use MooseX::Types::JSON qw(JSON);
 use MooseX::Types::Path::Class qw(Dir File);
 use Try::Tiny;
-use JSON::Any;
+use JSON::Any qw(DWIW XS JSON);
 use namespace::autoclean;
 
-
 =head1 NAME
 
 DBIx::Class::Admin - Administration object for schemas
 
 =head1 SYNOPSIS
 
+  $ dbicadmin --help
+
+  $ dbicadmin --schema=MyApp::Schema \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --deploy
+
+  $ dbicadmin --schema=MyApp::Schema --class=Employee \
+    --connect='["dbi:SQLite:my.db", "", ""]' \
+    --op=update --set='{ "name": "New_Employee" }'
+
   use DBIx::Class::Admin;
 
   # ddl manipulation
@@ -61,6 +70,32 @@ DBIx::Class::Admin - Administration object for schemas
   # install a version for an unversioned schema
   $admin->install("3.0");
 
+=head1 REQUIREMENTS
+
+The following CPAN modules are required to use C<dbicadmin> and this module:
+
+L<Moose>
+
+L<MooseX::Types>
+
+L<MooseX::Types::JSON>
+
+L<MooseX::Types::Path::Class>
+
+L<Try::Tiny>
+
+L<parent>
+
+L<JSON::Any>
+
+(L<JSON::DWIW> preferred for barekey support)
+
+L<namespace::autoclean>
+
+L<Getopt::Long::Descriptive>
+
+L<Text::CSV>
+
 =head1 Attributes
 
 =head2 schema_class
@@ -554,7 +589,7 @@ sub _find_stanza {
   return $cfg;
 }
 
-=head1 AUTHORS
+=head1 AUTHOR
 
 See L<DBIx::Class/CONTRIBUTORS>.