-#!/usr/bin/perl
+#!/usr/bin/env perl
use strict;
use warnings;
-use Getopt::Long::Descriptive;
+BEGIN {
+ use DBIx::Class;
+ die ( 'The following modules are required for the dbicadmin utility: '
+ . DBIx::Class::Optional::Dependencies->req_missing_for ('admin_script')
+ . "\n"
+ ) unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin_script');
+}
+
+use DBIx::Class::Admin::Descriptive;
+#use Getopt::Long::Descriptive;
use DBIx::Class::Admin;
+my $short_description = "utility for administrating DBIx::Class schemata";
+my $synopsis_text =q|
+ deploy a schema to a database
+ %c --schema=MyApp::Schema \
+ --connect='["dbi:SQLite:my.db", "", ""]' \
+ --deploy
+
+ update an existing record
+ %c --schema=MyApp::Schema --class=Employee \
+ --connect='["dbi:SQLite:my.db", "", ""]' \
+ --op=update --set='{ "name": "New_Employee" }'
+|;
+
my ($opts, $usage) = describe_options(
- "%c: %o",
+ "%c: %o",
(
['Actions'],
["action" => hidden => { one_of => [
- ['create|c' => 'Create version diffs needs preversion',],
- ['upgrade|u' => 'Upgrade the database to the current schema '],
- ['install|i' => 'Install the schema to the database',],
- ['deploy|d' => 'Deploy the a to the database',],
- ['select|s' => 'Select data from the schema', ],
- ['insert|i' => 'Insert data into the schema', ],
- ['update|u' => 'Update data in the schema', ],
- ['delete|D' => 'Delete data from the schema',],
- ['op:s' => 'compatiblity option all of the above can be suppied as --op=<action>'],
- ['help|h' => 'display this help'],
- ], required=> 1 }],
- ['Options'],
- ['schema-class|schema|C:s' => 'The class of the schema to load', { required => 1 } ],
- ['resultset|resultset_class|class|r:s' => 'The resultset to operate on for data manipulation' ],
- ['config-stanza|S:s' => 'Where in the config to find the connection_info, supply in form MyApp::Model::DB',],
- ['config|f:s' => 'Supply the config file for parsing by Config::Any', { depends => 'config_stanza'} ],
- ['connect-info|n:s%' => 'Supply the connect info as additonal options ie -I dsn=<dsn> user=<user> password=<pass> '],
- ['connect:s' => 'Supply the connect info as a json string' ],
- ['sql-dir|q:s' => 'The directory where sql diffs will be created'],
- ['sql-type|t:s' => 'The RDBMs flavour you wish to use'],
- ['version|v:i' => 'Supply a version install'],
- ['preversion|p:s' => 'The previous version to diff against',],
+ ['create' => 'Create version diffs needs preversion'],
+ ['upgrade' => 'Upgrade the database to the current schema'],
+ ['install' => 'Install the schema version tables to an existing database'],
+ ['deploy' => 'Deploy the schema to the database'],
+ ['select' => 'Select data from the schema'],
+ ['insert' => 'Insert data into the schema'],
+ ['update' => 'Update data in the schema'],
+ ['delete' => 'Delete data from the schema'],
+ ['op:s' => 'compatibility option all of the above can be supplied as --op=<action>'],
+ ['help' => 'display this help', { implies => { schema_class => '__dummy__' } } ],
+ ['documentation-as-pod:s' => 'hidden', { implies => { schema_class => '__dummy__' } } ],
+ ], required => 1 }],
+ ['Arguments'],
+ ["configuration" => hidden => { one_of => [
+ ['config-file|config:s' => 'Supply the config file for parsing by Config::Any', { depends => 'config_stanza'} ],
+ ['connect-info:s%' => 'Supply the connect info as trailing options e.g. --connect-info dsn=<dsn> user=<user> password=<pass>' ],
+ ['connect:s' => 'Supply the connect info as a JSON-encoded structure, e.g. an --connect=["dsn","user","pass"]'],
+ ] }],
+ ['schema-class:s' => 'The class of the schema to load', { required => 1 } ],
+ ['config-stanza:s' => 'Where in the config to find the connection_info, supply in form MyApp::Model::DB',],
+ ['resultset|resultset-class|class:s' => 'The resultset to operate on for data manipulation' ],
+ ['sql-dir:s' => 'The directory where sql diffs will be created'],
+ ['sql-type:s' => 'The RDBMs flavour you wish to use'],
+ ['version:i' => 'Supply a version install'],
+ ['preversion:s' => 'The previous version to diff against',],
['set:s' => 'JSON data used to perform data operations' ],
- ['lib|I:s' => 'Additonal library path to search in'],
['attrs:s' => 'JSON string to be used for the second argument for search'],
['where:s' => 'JSON string to be used for the where clause of search'],
['force' => 'Be forceful with some operations'],
['trace' => 'Turn on DBIx::Class trace output'],
['quiet' => 'Be less verbose'],
+ ['I:s@' => 'Same as perl\'s -I, prepended to current @INC'],
)
);
+if(defined (my $fn = $opts->{documentation_as_pod}) ) {
+ $usage->synopsis($synopsis_text);
+ $usage->short_description($short_description);
+
+ if ($fn) {
+ require File::Spec;
+ require File::Path;
+ my $dir = File::Spec->catpath( (File::Spec->splitpath($fn))[0,1] );
+ File::Path::mkpath([$dir]);
+ }
+
+ local *STDOUT if $fn;
+ open (STDOUT, '>', $fn) or die "Unable to open $fn: $!\n" if $fn;
+
+ print STDOUT "\n";
+ print STDOUT $usage->pod;
+ print STDOUT "\n";
-if ($opts->{help}) {
- print $usage->text;
+ close STDOUT if $fn;
exit 0;
}
-die "please only use one of --config or --connect-info" if ($opts->{config} and $opts->{connect_info});
+# FIXME - lowercasing will eventually go away when Getopt::Long::Descriptive is fixed
+if($opts->{i}) {
+ require lib;
+ lib->import( @{delete $opts->{i}} );
+}
+
+if($opts->{help}) {
+ $usage->die();
+}
-# option compatability mangle
+# option compatibility mangle
+# (can not be joined in the spec, one is s% the other is s)
if($opts->{connect}) {
$opts->{connect_info} = delete $opts->{connect};
}
my $admin = DBIx::Class::Admin->new( %$opts );
-
my $action = $opts->{action};
$action = $opts->{op} if ($action eq 'op');
-my $res = $admin->$action();
-print "going to perform action $action\n";
+print "Performing action $action...\n";
+
+my $res = $admin->$action();
if ($action eq 'select') {
- my $csv_class;
my $format = $opts->{format} || 'tsv';
die('Invalid format') if ($format!~/^tsv|csv$/s);
- $csv_class = 'Text::CSV_XS';
- eval{ require Text::CSV_XS };
- if ($@) {
- $csv_class = 'Text::CSV_PP';
- eval{ require Text::CSV_PP };
- die('The select op requires either the Text::CSV_XS or the Text::CSV_PP module') if ($@);
- }
- my $csv = $csv_class->new({
- sep_char => ( $format eq 'tsv' ? "\t" : ',' ),
- });
+ require Text::CSV;
+
+ my $csv = Text::CSV->new({
+ sep_char => ( $format eq 'tsv' ? "\t" : ',' ),
+ });
+
foreach my $row (@$res) {
$csv->combine( @$row );
print $csv->string()."\n";
}
}
+1;
-
-=head1 AUTHOR
-
-Aran Deltac <bluefeet@cpan.org>
-
-refactored by
-Gordon Irving <goraxe@cpan.org>
-
-=head1 LICENSE
-
-You may distribute this code under the same terms as Perl itself.
+__END__
projects / dbsrgits/DBIx-Class.git / blobdiff