Commit | Line | Data |
9f3849c3 |
1 | package DBIx::Class::Admin; |
2 | |
71ef99d5 |
3 | # check deps |
4 | BEGIN { |
a4a02f15 |
5 | use Carp::Clan qw/^DBIx::Class/; |
6 | use DBIx::Class; |
7 | croak('The following modules are required for DBIx::Class::Admin ' . DBIx::Class::Optional::Dependencies->req_missing_for ('admin') ) |
8 | unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin'); |
71ef99d5 |
9 | } |
585072bb |
10 | |
71ef99d5 |
11 | use Moose; |
a62dec82 |
12 | use MooseX::Types::Moose qw/Int Str Any Bool/; |
13 | use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/; |
71ef99d5 |
14 | use MooseX::Types::JSON qw(JSON); |
15 | use MooseX::Types::Path::Class qw(Dir File); |
16 | use Try::Tiny; |
cbde5b15 |
17 | use JSON::Any qw(DWIW XS JSON); |
8aa16237 |
18 | use namespace::autoclean; |
bb464677 |
19 | |
595cb2c7 |
20 | =head1 NAME |
21 | |
22 | DBIx::Class::Admin - Administration object for schemas |
23 | |
24 | =head1 SYNOPSIS |
25 | |
47442cea |
26 | $ dbicadmin --help |
27 | |
28 | $ dbicadmin --schema=MyApp::Schema \ |
29 | --connect='["dbi:SQLite:my.db", "", ""]' \ |
30 | --deploy |
31 | |
32 | $ dbicadmin --schema=MyApp::Schema --class=Employee \ |
33 | --connect='["dbi:SQLite:my.db", "", ""]' \ |
cbde5b15 |
34 | --op=update --set='{ "name": "New_Employee" }' |
47442cea |
35 | |
9c34993a |
36 | use DBIx::Class::Admin; |
595cb2c7 |
37 | |
9c34993a |
38 | # ddl manipulation |
39 | my $admin = DBIx::Class::Admin->new( |
40 | schema_class=> 'MY::Schema', |
41 | sql_dir=> $sql_dir, |
42 | connect_info => { dsn => $dsn, user => $user, password => $pass }, |
43 | ); |
595cb2c7 |
44 | |
9c34993a |
45 | # create SQLite sql |
46 | $admin->create('SQLite'); |
595cb2c7 |
47 | |
9c34993a |
48 | # create SQL diff for an upgrade |
49 | $admin->create('SQLite', {} , "1.0"); |
595cb2c7 |
50 | |
9c34993a |
51 | # upgrade a database |
52 | $admin->upgrade(); |
595cb2c7 |
53 | |
9c34993a |
54 | # install a version for an unversioned schema |
55 | $admin->install("3.0"); |
9f3849c3 |
56 | |
47442cea |
57 | =head1 REQUIREMENTS |
58 | |
a4a02f15 |
59 | The Admin interface has additional requirements not currently part of |
60 | L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details. |
47442cea |
61 | |
a4a02f15 |
62 | =head1 ATTRIBUTES |
9f3849c3 |
63 | |
595cb2c7 |
64 | =head2 schema_class |
9f3849c3 |
65 | |
595cb2c7 |
66 | the class of the schema to load |
e81f0fe2 |
67 | |
595cb2c7 |
68 | =cut |
e81f0fe2 |
69 | |
9f3849c3 |
70 | has 'schema_class' => ( |
3b27cdac |
71 | is => 'ro', |
72 | isa => Str, |
9f3849c3 |
73 | ); |
74 | |
e81f0fe2 |
75 | |
595cb2c7 |
76 | =head2 schema |
9f3849c3 |
77 | |
595cb2c7 |
78 | A pre-connected schema object can be provided for manipulation |
e81f0fe2 |
79 | |
595cb2c7 |
80 | =cut |
e81f0fe2 |
81 | |
9f3849c3 |
82 | has 'schema' => ( |
3b27cdac |
83 | is => 'ro', |
84 | isa => 'DBIx::Class::Schema', |
a705b175 |
85 | lazy_build => 1, |
9f3849c3 |
86 | ); |
87 | |
9f3849c3 |
88 | sub _build_schema { |
a705b175 |
89 | my ($self) = @_; |
a77f5ab1 |
90 | require Class::MOP; |
b13aab4f |
91 | { |
ab534c33 |
92 | my @include_dirs = @{$self->include_dirs}; |
ab534c33 |
93 | local @INC = (@include_dirs, @INC); |
b13aab4f |
94 | Class::MOP::load_class($self->schema_class); |
95 | } |
a705b175 |
96 | $self->connect_info->[3]->{ignore_version} =1; |
97 | return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} ); |
9f3849c3 |
98 | } |
99 | |
b13aab4f |
100 | =head2 include_dirs |
101 | |
102 | Extra include directories to look when loading C<schema_class> |
103 | |
104 | =cut |
105 | |
106 | has 'include_dirs' => ( |
107 | is => 'rw', |
108 | isa => 'ArrayRef', |
109 | default => sub {[]} |
110 | ); |
e81f0fe2 |
111 | |
bb464677 |
112 | =head2 resultset |
113 | |
114 | a resultset from the schema to operate on |
e81f0fe2 |
115 | |
bb464677 |
116 | =cut |
e81f0fe2 |
117 | |
bb464677 |
118 | has 'resultset' => ( |
3b27cdac |
119 | is => 'rw', |
120 | isa => Str, |
bb464677 |
121 | ); |
122 | |
e81f0fe2 |
123 | |
bb464677 |
124 | =head2 where |
125 | |
126 | a hash ref or json string to be used for identifying data to manipulate |
e81f0fe2 |
127 | |
bb464677 |
128 | =cut |
129 | |
130 | has 'where' => ( |
a705b175 |
131 | is => 'rw', |
3b27cdac |
132 | isa => DBICHashRef, |
133 | coerce => 1, |
bb464677 |
134 | ); |
135 | |
e81f0fe2 |
136 | |
bb464677 |
137 | =head2 set |
e81f0fe2 |
138 | |
bb464677 |
139 | a hash ref or json string to be used for inserting or updating data |
e81f0fe2 |
140 | |
bb464677 |
141 | =cut |
142 | |
143 | has 'set' => ( |
a705b175 |
144 | is => 'rw', |
3b27cdac |
145 | isa => DBICHashRef, |
146 | coerce => 1, |
bb464677 |
147 | ); |
148 | |
e81f0fe2 |
149 | |
bb464677 |
150 | =head2 attrs |
e81f0fe2 |
151 | |
bb464677 |
152 | a hash ref or json string to be used for passing additonal info to the ->search call |
e81f0fe2 |
153 | |
bb464677 |
154 | =cut |
e81f0fe2 |
155 | |
bb464677 |
156 | has 'attrs' => ( |
3b27cdac |
157 | is => 'rw', |
158 | isa => DBICHashRef, |
159 | coerce => 1, |
bb464677 |
160 | ); |
e81f0fe2 |
161 | |
162 | |
595cb2c7 |
163 | =head2 connect_info |
164 | |
165 | connect_info the arguments to provide to the connect call of the schema_class |
bb464677 |
166 | |
e81f0fe2 |
167 | =cut |
bb464677 |
168 | |
9f3849c3 |
169 | has 'connect_info' => ( |
3b27cdac |
170 | is => 'ro', |
171 | isa => DBICConnectInfo, |
a705b175 |
172 | lazy_build => 1, |
3b27cdac |
173 | coerce => 1, |
9f3849c3 |
174 | ); |
175 | |
176 | sub _build_connect_info { |
a705b175 |
177 | my ($self) = @_; |
178 | return $self->_find_stanza($self->config, $self->config_stanza); |
9f3849c3 |
179 | } |
180 | |
e81f0fe2 |
181 | |
595cb2c7 |
182 | =head2 config_file |
183 | |
184 | config_file provide a config_file to read connect_info from, if this is provided |
185 | config_stanze should also be provided to locate where the connect_info is in the config |
186 | The config file should be in a format readable by Config::General |
e81f0fe2 |
187 | |
595cb2c7 |
188 | =cut |
e81f0fe2 |
189 | |
595cb2c7 |
190 | has config_file => ( |
a705b175 |
191 | is => 'ro', |
3b27cdac |
192 | isa => File, |
193 | coerce => 1, |
595cb2c7 |
194 | ); |
195 | |
e81f0fe2 |
196 | |
595cb2c7 |
197 | =head2 config_stanza |
198 | |
199 | config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information |
200 | designed for use with catalyst config files |
e81f0fe2 |
201 | |
595cb2c7 |
202 | =cut |
e81f0fe2 |
203 | |
595cb2c7 |
204 | has 'config_stanza' => ( |
3b27cdac |
205 | is => 'ro', |
206 | isa => Str, |
595cb2c7 |
207 | ); |
208 | |
e81f0fe2 |
209 | |
595cb2c7 |
210 | =head2 config |
211 | |
a03b396b |
212 | Instead of loading from a file the configuration can be provided directly as a hash ref. Please note |
595cb2c7 |
213 | config_stanza will still be required. |
e81f0fe2 |
214 | |
595cb2c7 |
215 | =cut |
e81f0fe2 |
216 | |
9f3849c3 |
217 | has config => ( |
3b27cdac |
218 | is => 'ro', |
219 | isa => DBICHashRef, |
a705b175 |
220 | lazy_build => 1, |
9f3849c3 |
221 | ); |
222 | |
223 | sub _build_config { |
a705b175 |
224 | my ($self) = @_; |
71766122 |
225 | |
9780718f |
226 | try { require Config::Any } |
227 | catch { die ("Config::Any is required to parse the config file.\n") }; |
9f3849c3 |
228 | |
a705b175 |
229 | my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1}); |
9f3849c3 |
230 | |
a705b175 |
231 | # just grab the config from the config file |
232 | $cfg = $cfg->{$self->config_file}; |
233 | return $cfg; |
9f3849c3 |
234 | } |
235 | |
e81f0fe2 |
236 | |
595cb2c7 |
237 | =head2 sql_dir |
9f3849c3 |
238 | |
595cb2c7 |
239 | The location where sql ddl files should be created or found for an upgrade. |
e81f0fe2 |
240 | |
595cb2c7 |
241 | =cut |
e81f0fe2 |
242 | |
9f3849c3 |
243 | has 'sql_dir' => ( |
a705b175 |
244 | is => 'ro', |
3b27cdac |
245 | isa => Dir, |
246 | coerce => 1, |
9f3849c3 |
247 | ); |
248 | |
e81f0fe2 |
249 | |
595cb2c7 |
250 | =head2 version |
9f3849c3 |
251 | |
595cb2c7 |
252 | Used for install, the version which will be 'installed' in the schema |
e81f0fe2 |
253 | |
595cb2c7 |
254 | =cut |
e81f0fe2 |
255 | |
9f3849c3 |
256 | has version => ( |
3b27cdac |
257 | is => 'rw', |
258 | isa => Str, |
9f3849c3 |
259 | ); |
260 | |
e81f0fe2 |
261 | |
595cb2c7 |
262 | =head2 preversion |
263 | |
264 | Previouse version of the schema to create an upgrade diff for, the full sql for that version of the sql must be in the sql_dir |
e81f0fe2 |
265 | |
595cb2c7 |
266 | =cut |
e81f0fe2 |
267 | |
9f3849c3 |
268 | has preversion => ( |
3b27cdac |
269 | is => 'rw', |
270 | isa => Str, |
9f3849c3 |
271 | ); |
272 | |
e81f0fe2 |
273 | |
595cb2c7 |
274 | =head2 force |
275 | |
276 | Try and force certain operations. |
e81f0fe2 |
277 | |
595cb2c7 |
278 | =cut |
e81f0fe2 |
279 | |
912e2d5a |
280 | has force => ( |
3b27cdac |
281 | is => 'rw', |
282 | isa => Bool, |
912e2d5a |
283 | ); |
284 | |
e81f0fe2 |
285 | |
c57f1cf7 |
286 | =head2 quiet |
595cb2c7 |
287 | |
288 | Be less verbose about actions |
e81f0fe2 |
289 | |
595cb2c7 |
290 | =cut |
e81f0fe2 |
291 | |
64c012f4 |
292 | has quiet => ( |
3b27cdac |
293 | is => 'rw', |
294 | isa => Bool, |
64c012f4 |
295 | ); |
296 | |
912e2d5a |
297 | has '_confirm' => ( |
3b27cdac |
298 | is => 'bare', |
299 | isa => Bool, |
912e2d5a |
300 | ); |
301 | |
e81f0fe2 |
302 | |
595cb2c7 |
303 | =head1 METHODS |
304 | |
305 | =head2 create |
306 | |
307 | =over 4 |
308 | |
309 | =item Arguments: $sqlt_type, \%sqlt_args, $preversion |
310 | |
311 | =back |
312 | |
a03b396b |
313 | L<create> will generate sql for the supplied schema_class in sql_dir. The flavour of sql to |
314 | generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name. |
595cb2c7 |
315 | |
316 | Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref. |
317 | |
318 | Optional preversion can be supplied to generate a diff to be used by upgrade. |
e81f0fe2 |
319 | |
595cb2c7 |
320 | =cut |
321 | |
9f3849c3 |
322 | sub create { |
a705b175 |
323 | my ($self, $sqlt_type, $sqlt_args, $preversion) = @_; |
595cb2c7 |
324 | |
a705b175 |
325 | $preversion ||= $self->preversion(); |
595cb2c7 |
326 | |
a705b175 |
327 | my $schema = $self->schema(); |
328 | # create the dir if does not exist |
329 | $self->sql_dir->mkpath() if ( ! -d $self->sql_dir); |
9f3849c3 |
330 | |
a705b175 |
331 | $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args ); |
9f3849c3 |
332 | } |
333 | |
e81f0fe2 |
334 | |
595cb2c7 |
335 | =head2 upgrade |
336 | |
337 | =over 4 |
338 | |
339 | =item Arguments: <none> |
340 | |
341 | =back |
342 | |
343 | upgrade will attempt to upgrade the connected database to the same version as the schema_class. |
344 | B<MAKE SURE YOU BACKUP YOUR DB FIRST> |
e81f0fe2 |
345 | |
595cb2c7 |
346 | =cut |
347 | |
9f3849c3 |
348 | sub upgrade { |
a705b175 |
349 | my ($self) = @_; |
350 | my $schema = $self->schema(); |
351 | if (!$schema->get_db_version()) { |
352 | # schema is unversioned |
b718fd0a |
353 | $schema->throw_exception ("Could not determin current schema version, please either install() or deploy().\n"); |
a705b175 |
354 | } else { |
355 | my $ret = $schema->upgrade(); |
356 | return $ret; |
357 | } |
9f3849c3 |
358 | } |
359 | |
e81f0fe2 |
360 | |
595cb2c7 |
361 | =head2 install |
362 | |
363 | =over 4 |
364 | |
365 | =item Arguments: $version |
366 | |
367 | =back |
368 | |
a03b396b |
369 | install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing |
370 | database. install will take a version and add the version tracking tables and 'install' the version. No |
371 | further ddl modification takes place. Setting the force attribute to a true value will allow overriding of |
595cb2c7 |
372 | already versioned databases. |
e81f0fe2 |
373 | |
595cb2c7 |
374 | =cut |
e81f0fe2 |
375 | |
9f3849c3 |
376 | sub install { |
a705b175 |
377 | my ($self, $version) = @_; |
378 | |
379 | my $schema = $self->schema(); |
380 | $version ||= $self->version(); |
381 | if (!$schema->get_db_version() ) { |
382 | # schema is unversioned |
383 | print "Going to install schema version\n"; |
384 | my $ret = $schema->install($version); |
385 | print "retun is $ret\n"; |
386 | } |
387 | elsif ($schema->get_db_version() and $self->force ) { |
585072bb |
388 | carp "Forcing install may not be a good idea"; |
a705b175 |
389 | if($self->_confirm() ) { |
a705b175 |
390 | $self->schema->_set_db_version({ version => $version}); |
9c34993a |
391 | } |
a705b175 |
392 | } |
393 | else { |
b718fd0a |
394 | $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n"); |
a705b175 |
395 | } |
9f3849c3 |
396 | |
397 | } |
398 | |
e81f0fe2 |
399 | |
595cb2c7 |
400 | =head2 deploy |
401 | |
402 | =over 4 |
403 | |
404 | =item Arguments: $args |
405 | |
406 | =back |
407 | |
a03b396b |
408 | deploy will create the schema at the connected database. C<$args> are passed straight to |
e81f0fe2 |
409 | L<DBIx::Class::Schema/deploy>. |
410 | |
595cb2c7 |
411 | =cut |
e81f0fe2 |
412 | |
9f3849c3 |
413 | sub deploy { |
a705b175 |
414 | my ($self, $args) = @_; |
415 | my $schema = $self->schema(); |
a03b396b |
416 | $schema->deploy( $args, $self->sql_dir ); |
9f3849c3 |
417 | } |
418 | |
bb464677 |
419 | =head2 insert |
595cb2c7 |
420 | |
421 | =over 4 |
422 | |
423 | =item Arguments: $rs, $set |
424 | |
425 | =back |
426 | |
bb464677 |
427 | insert takes the name of a resultset from the schema_class and a hashref of data to insert |
595cb2c7 |
428 | into that resultset |
429 | |
430 | =cut |
e81f0fe2 |
431 | |
bb464677 |
432 | sub insert { |
a705b175 |
433 | my ($self, $rs, $set) = @_; |
bb464677 |
434 | |
a705b175 |
435 | $rs ||= $self->resultset(); |
436 | $set ||= $self->set(); |
437 | my $resultset = $self->schema->resultset($rs); |
438 | my $obj = $resultset->create( $set ); |
439 | print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet); |
9f3849c3 |
440 | } |
441 | |
595cb2c7 |
442 | |
bb464677 |
443 | =head2 update |
595cb2c7 |
444 | |
e81f0fe2 |
445 | =over 4 |
595cb2c7 |
446 | |
447 | =item Arguments: $rs, $set, $where |
448 | |
449 | =back |
450 | |
e81f0fe2 |
451 | update takes the name of a resultset from the schema_class, a hashref of data to update and |
452 | a where hash used to form the search for the rows to update. |
453 | |
595cb2c7 |
454 | =cut |
e81f0fe2 |
455 | |
bb464677 |
456 | sub update { |
a705b175 |
457 | my ($self, $rs, $set, $where) = @_; |
882931aa |
458 | |
a705b175 |
459 | $rs ||= $self->resultset(); |
460 | $where ||= $self->where(); |
461 | $set ||= $self->set(); |
462 | my $resultset = $self->schema->resultset($rs); |
463 | $resultset = $resultset->search( ($where||{}) ); |
882931aa |
464 | |
a705b175 |
465 | my $count = $resultset->count(); |
466 | print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet); |
882931aa |
467 | |
a705b175 |
468 | if ( $self->force || $self->_confirm() ) { |
469 | $resultset->update_all( $set ); |
470 | } |
9f3849c3 |
471 | } |
472 | |
e81f0fe2 |
473 | |
bb464677 |
474 | =head2 delete |
595cb2c7 |
475 | |
476 | =over 4 |
477 | |
478 | =item Arguments: $rs, $where, $attrs |
479 | |
480 | =back |
481 | |
e81f0fe2 |
482 | delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search. |
595cb2c7 |
483 | The found data is deleted and cannot be recovered. |
e81f0fe2 |
484 | |
595cb2c7 |
485 | =cut |
e81f0fe2 |
486 | |
bb464677 |
487 | sub delete { |
a705b175 |
488 | my ($self, $rs, $where, $attrs) = @_; |
9f3849c3 |
489 | |
a705b175 |
490 | $rs ||= $self->resultset(); |
491 | $where ||= $self->where(); |
492 | $attrs ||= $self->attrs(); |
493 | my $resultset = $self->schema->resultset($rs); |
494 | $resultset = $resultset->search( ($where||{}), ($attrs||()) ); |
9f3849c3 |
495 | |
a705b175 |
496 | my $count = $resultset->count(); |
497 | print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet); |
9f3849c3 |
498 | |
a705b175 |
499 | if ( $self->force || $self->_confirm() ) { |
500 | $resultset->delete_all(); |
501 | } |
9f3849c3 |
502 | } |
503 | |
e81f0fe2 |
504 | |
bb464677 |
505 | =head2 select |
595cb2c7 |
506 | |
507 | =over 4 |
508 | |
509 | =item Arguments: $rs, $where, $attrs |
510 | |
511 | =back |
512 | |
a03b396b |
513 | select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search. |
595cb2c7 |
514 | The found data is returned in a array ref where the first row will be the columns list. |
515 | |
516 | =cut |
e81f0fe2 |
517 | |
bb464677 |
518 | sub select { |
a705b175 |
519 | my ($self, $rs, $where, $attrs) = @_; |
520 | |
521 | $rs ||= $self->resultset(); |
522 | $where ||= $self->where(); |
523 | $attrs ||= $self->attrs(); |
524 | my $resultset = $self->schema->resultset($rs); |
525 | $resultset = $resultset->search( ($where||{}), ($attrs||()) ); |
526 | |
527 | my @data; |
528 | my @columns = $resultset->result_source->columns(); |
a03b396b |
529 | push @data, [@columns];# |
a705b175 |
530 | |
531 | while (my $row = $resultset->next()) { |
532 | my @fields; |
533 | foreach my $column (@columns) { |
534 | push( @fields, $row->get_column($column) ); |
9c34993a |
535 | } |
a705b175 |
536 | push @data, [@fields]; |
537 | } |
9c34993a |
538 | |
a705b175 |
539 | return \@data; |
9f3849c3 |
540 | } |
541 | |
595cb2c7 |
542 | sub _confirm { |
a705b175 |
543 | my ($self) = @_; |
544 | print "Are you sure you want to do this? (type YES to confirm) \n"; |
545 | # mainly here for testing |
546 | return 1 if ($self->meta->get_attribute('_confirm')->get_value($self)); |
547 | my $response = <STDIN>; |
548 | return 1 if ($response=~/^YES/); |
549 | return; |
9f3849c3 |
550 | } |
551 | |
595cb2c7 |
552 | sub _find_stanza { |
a705b175 |
553 | my ($self, $cfg, $stanza) = @_; |
554 | my @path = split /::/, $stanza; |
555 | while (my $path = shift @path) { |
556 | if (exists $cfg->{$path}) { |
557 | $cfg = $cfg->{$path}; |
558 | } |
559 | else { |
b718fd0a |
560 | die ("Could not find $stanza in config, $path does not seem to exist.\n"); |
9c34993a |
561 | } |
a705b175 |
562 | } |
563 | return $cfg; |
595cb2c7 |
564 | } |
bb464677 |
565 | |
47442cea |
566 | =head1 AUTHOR |
bb464677 |
567 | |
e81f0fe2 |
568 | See L<DBIx::Class/CONTRIBUTORS>. |
bb464677 |
569 | |
570 | =head1 LICENSE |
571 | |
e81f0fe2 |
572 | You may distribute this code under the same terms as Perl itself |
573 | |
bb464677 |
574 | =cut |
e81f0fe2 |
575 | |
9f3849c3 |
576 | 1; |