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
20 $ dbicdump -o dump_directory=./lib \
21 -o components='["InflateColumn::DateTime"]' \
22 MyApp::Schema dbi:SQLite:./foo.db '{ quote_char => "\"" }'
24 $ dbicdump -o dump_directory=./lib \
25 -o components='["InflateColumn::DateTime"]' \
27 MyApp::Schema dbi:mysql:database=foo user pass '{ quote_char => "`" }'
29 $ dbicdump -o dump_directory=./lib \
30 -o components='["InflateColumn::DateTime"]' \
31 MyApp::Schema 'dbi:mysql:database=foo;host=domain.tld;port=3306' user pass
33 On Windows that would be:
35 $ dbicdump -o dump_directory=.\lib ^
36 -o components="[q{InflateColumn::DateTime}]" ^
38 MyApp::Schema dbi:mysql:database=foo user pass "{ quote_char => q{`} }"
40 Configuration files must have schema_class and connect_info sections,
41 an example of a general config file is as follows:
43 schema_class MyApp::Schema
54 components InflateColumn::DateTime
58 Using a config file requires L<Config::Any> installed.
62 Dbicdump generates a L<DBIx::Class> schema using
63 L<DBIx::Class::Schema::Loader/make_schema_at> and dumps it to disk.
65 You can pass any L<DBIx::Class::Schema::Loader::Base> constructor option using
66 C<< -o <option>=<value> >>. For convenience, option names will have C<->
67 replaced with C<_> and values that look like references or quote-like
68 operators will be C<eval>-ed before being passed to the constructor.
70 The C<dump_directory> option defaults to the current directory if not
75 L<DBIx::Class::Schema::Loader>, L<DBIx::Class>.
79 Dagfinn Ilmari Manns?ker C<< <ilmari@ilmari.org> >>
83 Caelum: Rafael Kitover <rkitover@cpan.org>
87 This program is free software; you can redistribute it and/or modify it
88 under the same terms as Perl itself.
96 use DBIx::Class::Schema::Loader 'make_schema_at';
97 use DBIx::Class::Schema::Loader::Base ();
98 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
102 GetOptions( 'loader-option|o=s%' => \&handle_option );
103 $loader_options->{dump_directory} ||= '.';
106 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('dbicdump_config')) {
107 die sprintf "You must install the following CPAN modules to use a config file with dbicdump: %s.\n",
108 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('dbicdump_config');
111 my $configuration_file = shift @ARGV;
114 Config::Any->load_files( {
116 flatten_to_hash => 1,
117 files => [$configuration_file] } );
119 my $c = (values %$configurations)[0];
121 unless (keys %{$c->{connect_info}} && $c->{schema_class}) {
125 my ($dsn, $user, $pass, $options) =
126 map { $c->{connect_info}->{$_} } qw/dsn user pass options/;
128 $c->{loader_options}->{dump_directory} ||=
129 $loader_options->{dump_directory};
133 $c->{loader_options} || {},
134 [ $dsn, $user, $pass, %{$options} ],
138 my ($schema_class, @loader_connect_info) = @ARGV
141 my $dsn = shift @loader_connect_info;
143 my ($user, $pass) = $dsn =~ /sqlite/i ? ('', '')
144 : splice @loader_connect_info, 0, 2;
146 my @extra_connect_info_opts = map parse_value($_), @loader_connect_info;
151 [ $dsn, $user, $pass, @extra_connect_info_opts ],
160 $value = eval $value if $value =~ /^\s*(?:sub\s*\{|q\w?\s*[^\w\s]|[[{])/;
166 my ($self, $key, $value) = @_;
169 die "Unknown option: $key\n"
170 unless DBIx::Class::Schema::Loader::Base->can($key);
172 $value = parse_value $value;
174 $loader_options->{$key} = $value;