5 dbicdump - Dump a schema using DBIx::Class::Schema::Loader
9 dbicdump <configuration_file>
10 dbicdump [-o <loader_option>=<value> ] <schema_class> <connect_info>
14 $ dbicdump schema.conf
16 $ dbicdump -o dump_directory=./lib \
17 -o components='["InflateColumn::DateTime"]' \
18 MyApp::Schema dbi:SQLite:./foo.db '{ quote_char => "\"" }'
20 $ dbicdump -o dump_directory=./lib \
21 -o components='["InflateColumn::DateTime"]' \
23 MyApp::Schema dbi:mysql:database=foo user pass '{ quote_char => "`" }'
25 $ dbicdump -o dump_directory=./lib \
26 -o components='["InflateColumn::DateTime"]' \
27 MyApp::Schema 'dbi:mysql:database=foo;host=domain.tld;port=3306' user pass
29 On Windows that would be:
31 $ dbicdump -o dump_directory=.\lib ^
32 -o components="[q{InflateColumn::DateTime}]" ^
34 MyApp::Schema dbi:mysql:database=foo user pass "{ quote_char => q{`} }"
36 Configuration files must have schema_class and connect_info sections,
37 an example of a general config file is as follows:
39 schema_class MyApp::Schema
50 components InflateColumn::DateTime
54 Using a config file requires L<Config::Any> installed.
58 Dbicdump generates a L<DBIx::Class> schema using
59 L<DBIx::Class::Schema::Loader/make_schema_at> and dumps it to disk.
61 You can pass any L<DBIx::Class::Schema::Loader::Base> constructor option using
62 C<< -o <option>=<value> >>. For convenience, option names will have C<->
63 replaced with C<_> and values that look like references or quote-like
64 operators will be C<eval>-ed before being passed to the constructor.
66 The C<dump_directory> option defaults to the current directory if not
71 L<DBIx::Class::Schema::Loader>, L<DBIx::Class>.
75 Dagfinn Ilmari Mannsåker C<< <ilmari@ilmari.org> >>
79 Caelum: Rafael Kitover <rkitover@cpan.org>
83 This program is free software; you can redistribute it and/or modify it
84 under the same terms as Perl itself.
92 use DBIx::Class::Schema::Loader 'make_schema_at';
93 use DBIx::Class::Schema::Loader::Base ();
94 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
98 GetOptions( 'loader-option|o=s%' => \&handle_option );
99 $loader_options->{dump_directory} ||= '.';
102 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('dbicdump_config')) {
103 die sprintf "You must install the following CPAN modules to use a config file with dbicdump: %s.\n",
104 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('dbicdump_config');
107 my $configuration_file = shift @ARGV;
110 Config::Any->load_files( {
112 flatten_to_hash => 1,
113 files => [$configuration_file] } );
115 my $c = (values %$configurations)[0];
117 unless (keys %{$c->{connect_info}} && $c->{schema_class}) {
121 my ($dsn, $user, $pass, $options) =
122 map { $c->{connect_info}->{$_} } qw/dsn user pass options/;
124 $c->{loader_options}->{dump_directory} ||=
125 $loader_options->{dump_directory};
129 $c->{loader_options} || {},
130 [ $dsn, $user, $pass, %{$options} ],
134 my ($schema_class, @loader_connect_info) = @ARGV
137 my $dsn = shift @loader_connect_info;
139 my ($user, $pass) = $dsn =~ /sqlite/i ? ('', '')
140 : splice @loader_connect_info, 0, 2;
142 my @extra_connect_info_opts = map parse_value($_), @loader_connect_info;
147 [ $dsn, $user, $pass, @extra_connect_info_opts ],
156 $value = eval $value if $value =~ /^\s*(?:sub\s*\{|q\w?\s*[^\w\s]|[[{])/;
162 my ($self, $key, $value) = @_;
165 die "Unknown option: $key\n"
166 unless DBIx::Class::Schema::Loader::Base->can($key);
168 $value = parse_value $value;
170 $loader_options->{$key} = $value;