/usr/share/perl5/SQL/Translator/Parser/DBIx/Class.pm is in libdbix-class-perl 0.082840-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 | package SQL::Translator::Parser::DBIx::Class;
# AUTHOR: Jess Robinson
# Some mistakes the fault of Matt S Trout
# Others the fault of Ash Berlin
use strict;
use warnings;
our ($DEBUG, $VERSION, @EXPORT_OK);
$VERSION = '1.10';
$DEBUG = 0 unless defined $DEBUG;
use Exporter;
use SQL::Translator::Utils qw(debug normalize_name);
use DBIx::Class::Carp qw/^SQL::Translator|^DBIx::Class|^Try::Tiny/;
use DBIx::Class::Exception;
use Scalar::Util 'blessed';
use Try::Tiny;
use namespace::clean;
use base qw(Exporter);
@EXPORT_OK = qw(parse);
# -------------------------------------------------------------------
# parse($tr, $data)
#
# setting parser_args => { add_fk_index => 0 } will prevent
# the auto-generation of an index for each FK.
#
# Note that $data, in the case of this parser, is not useful.
# We're working with DBIx::Class Schemas, not data streams.
# -------------------------------------------------------------------
sub parse {
my ($tr, $data) = @_;
my $args = $tr->parser_args;
my $dbicschema = $data || $args->{dbic_schema};
for (qw(DBIx::Class::Schema DBIx::Schema package)) {
if (defined (my $s = delete $args->{$_} )) {
carp_unique("Supplying a schema via ... parser_args => { '$_' => \$schema } is deprecated. Please use parser_args => { dbic_schema => \$schema } instead");
# move it from the deprecated to the proper $args slot
unless ($dbicschema) {
$args->{dbic_schema} = $dbicschema = $s;
}
}
}
DBIx::Class::Exception->throw('No DBIx::Class::Schema') unless ($dbicschema);
if (!ref $dbicschema) {
eval "require $dbicschema"
or DBIx::Class::Exception->throw("Can't load $dbicschema: $@");
}
if (
ref $args->{dbic_schema}
and
$args->{dbic_schema}->storage
) {
# we have a storage-holding $schema instance in $args
# we need to dissociate it from that $storage
# otherwise SQLT insanity may ensue due to how some
# serializing producers treat $args (crazy crazy shit)
local $args->{dbic_schema}{storage};
$args->{dbic_schema} = $args->{dbic_schema}->clone;
}
my $schema = $tr->schema;
my $table_no = 0;
$schema->name( ref($dbicschema) . " v" . ($dbicschema->schema_version || '1.x'))
unless ($schema->name);
my @monikers = sort $dbicschema->sources;
if (my $limit_sources = $args->{'sources'}) {
my $ref = ref $limit_sources || '';
$dbicschema->throw_exception ("'sources' parameter must be an array or hash ref")
unless( $ref eq 'ARRAY' || ref eq 'HASH' );
# limit monikers to those specified in
my $sources;
if ($ref eq 'ARRAY') {
$sources->{$_} = 1 for (@$limit_sources);
} else {
$sources = $limit_sources;
}
@monikers = grep { $sources->{$_} } @monikers;
}
my(%table_monikers, %view_monikers);
for my $moniker (@monikers){
my $source = $dbicschema->source($moniker);
if ( $source->isa('DBIx::Class::ResultSource::Table') ) {
$table_monikers{$moniker}++;
} elsif( $source->isa('DBIx::Class::ResultSource::View') ){
next if $source->is_virtual;
$view_monikers{$moniker}++;
}
}
my %tables;
foreach my $moniker (sort keys %table_monikers)
{
my $source = $dbicschema->source($moniker);
my $table_name = $source->name;
# FIXME - this isn't the right way to do it, but sqlt does not
# support quoting properly to be signaled about this
$table_name = $$table_name if ref $table_name eq 'SCALAR';
# It's possible to have multiple DBIC sources using the same table
next if $tables{$table_name};
$tables{$table_name}{source} = $source;
my $table = $tables{$table_name}{object} = SQL::Translator::Schema::Table->new(
name => $table_name,
type => 'TABLE',
);
foreach my $col ($source->columns)
{
# assuming column_info in dbic is the same as DBI (?)
# data_type is a number, column_type is text?
my %colinfo = (
name => $col,
size => 0,
is_auto_increment => 0,
is_foreign_key => 0,
is_nullable => 0,
%{$source->column_info($col)}
);
if ($colinfo{is_nullable}) {
$colinfo{default} = '' unless exists $colinfo{default};
}
my $f = $table->add_field(%colinfo)
|| $dbicschema->throw_exception ($table->error);
}
my @primary = $source->primary_columns;
$table->primary_key(@primary) if @primary;
my %unique_constraints = $source->unique_constraints;
foreach my $uniq (sort keys %unique_constraints) {
if (!$source->_compare_relationship_keys($unique_constraints{$uniq}, \@primary)) {
$table->add_constraint(
type => 'unique',
name => $uniq,
fields => $unique_constraints{$uniq}
);
}
}
my @rels = $source->relationships();
my %created_FK_rels;
# global add_fk_index set in parser_args
my $add_fk_index = (exists $args->{add_fk_index} && ! $args->{add_fk_index}) ? 0 : 1;
REL:
foreach my $rel (sort @rels) {
my $rel_info = $source->relationship_info($rel);
# Ignore any rel cond that isn't a straight hash
next unless ref $rel_info->{cond} eq 'HASH';
my $relsource = try { $source->related_source($rel) };
unless ($relsource) {
carp "Ignoring relationship '$rel' on '$moniker' - related resultsource '$rel_info->{class}' is not registered with this schema\n";
next;
};
# related sources might be excluded via a {sources} filter or might be views
next unless exists $table_monikers{$relsource->source_name};
my $rel_table = $relsource->name;
# FIXME - this isn't the right way to do it, but sqlt does not
# support quoting properly to be signaled about this
$rel_table = $$rel_table if ref $rel_table eq 'SCALAR';
# Force the order of @cond to match the order of ->add_columns
my $idx;
my %other_columns_idx = map {'foreign.'.$_ => ++$idx } $relsource->columns;
for ( keys %{$rel_info->{cond}} ) {
unless (exists $other_columns_idx{$_}) {
carp "Ignoring relationship '$rel' on '$moniker' - related resultsource '@{[ $relsource->source_name ]}' does not contain one of the specified columns: '$_'\n";
next REL;
}
}
my @cond = sort { $other_columns_idx{$a} <=> $other_columns_idx{$b} } keys(%{$rel_info->{cond}});
# Get the key information, mapping off the foreign/self markers
my @refkeys = map {/^\w+\.(\w+)$/} @cond;
my @keys = map {$rel_info->{cond}->{$_} =~ /^\w+\.(\w+)$/} @cond;
# determine if this relationship is a self.fk => foreign.pk (i.e. belongs_to)
my $fk_constraint;
#first it can be specified explicitly
if ( exists $rel_info->{attrs}{is_foreign_key_constraint} ) {
$fk_constraint = $rel_info->{attrs}{is_foreign_key_constraint};
}
# it can not be multi
elsif ( $rel_info->{attrs}{accessor}
&& $rel_info->{attrs}{accessor} eq 'multi' ) {
$fk_constraint = 0;
}
# if indeed single, check if all self.columns are our primary keys.
# this is supposed to indicate a has_one/might_have...
# where's the introspection!!?? :)
else {
$fk_constraint = not $source->_compare_relationship_keys(\@keys, \@primary);
}
my ($otherrelname, $otherrelationship) = %{ $source->reverse_relationship_info($rel) };
my $cascade;
for my $c (qw/delete update/) {
if (exists $rel_info->{attrs}{"on_$c"}) {
if ($fk_constraint) {
$cascade->{$c} = $rel_info->{attrs}{"on_$c"};
}
elsif ( $rel_info->{attrs}{"on_$c"} ) {
carp "SQLT attribute 'on_$c' was supplied for relationship '$moniker/$rel', which does not appear to be a foreign constraint. "
. "If you are sure that SQLT must generate a constraint for this relationship, add 'is_foreign_key_constraint => 1' to the attributes.\n";
}
}
elsif (defined $otherrelationship and $otherrelationship->{attrs}{$c eq 'update' ? 'cascade_copy' : 'cascade_delete'}) {
$cascade->{$c} = 'CASCADE';
}
}
if($rel_table) {
# Constraints are added only if applicable
next unless $fk_constraint;
# Make sure we don't create the same foreign key constraint twice
my $key_test = join("\x00", sort @keys);
next if $created_FK_rels{$rel_table}->{$key_test};
if (scalar(@keys)) {
$created_FK_rels{$rel_table}->{$key_test} = 1;
my $is_deferrable = $rel_info->{attrs}{is_deferrable};
# calculate dependencies: do not consider deferrable constraints and
# self-references for dependency calculations
if (! $is_deferrable and $rel_table ne $table_name) {
$tables{$table_name}{foreign_table_deps}{$rel_table}++;
}
# trim schema before generating constraint/index names
(my $table_abbrev = $table_name) =~ s/ ^ [^\.]+ \. //x;
$table->add_constraint(
type => 'foreign_key',
name => join('_', $table_abbrev, 'fk', @keys),
fields => \@keys,
reference_fields => \@refkeys,
reference_table => $rel_table,
on_delete => uc ($cascade->{delete} || ''),
on_update => uc ($cascade->{update} || ''),
(defined $is_deferrable ? ( deferrable => $is_deferrable ) : ()),
);
# global parser_args add_fk_index param can be overridden on the rel def
my $add_fk_index_rel = (exists $rel_info->{attrs}{add_fk_index}) ? $rel_info->{attrs}{add_fk_index} : $add_fk_index;
# Check that we do not create an index identical to the PK index
# (some RDBMS croak on this, and it generally doesn't make much sense)
# NOTE: we do not sort the key columns because the order of
# columns is important for indexes and two indexes with the
# same cols but different order are allowed and sometimes
# needed
next if join("\x00", @keys) eq join("\x00", @primary);
if ($add_fk_index_rel) {
(my $idx_name = $table_name) =~ s/ ^ [^\.]+ \. //x;
my $index = $table->add_index(
name => join('_', $table_abbrev, 'idx', @keys),
fields => \@keys,
type => 'NORMAL',
);
}
}
}
}
}
# attach the tables to the schema in dependency order
my $dependencies = {
map { $_ => _resolve_deps ($_, \%tables) } (keys %tables)
};
for my $table (sort
{
keys %{$dependencies->{$a} || {} } <=> keys %{ $dependencies->{$b} || {} }
||
$a cmp $b
}
(keys %tables)
) {
$schema->add_table ($tables{$table}{object});
$tables{$table}{source} -> _invoke_sqlt_deploy_hook( $tables{$table}{object} );
# the hook might have already removed the table
if ($schema->get_table($table) && $table =~ /^ \s* \( \s* SELECT \s+/ix) {
carp <<'EOW';
Custom SQL through ->name(\'( SELECT ...') is DEPRECATED, for more details see
"Arbitrary SQL through a custom ResultSource" in DBIx::Class::Manual::Cookbook
or http://search.cpan.org/dist/DBIx-Class/lib/DBIx/Class/Manual/Cookbook.pod
EOW
# remove the table as there is no way someone might want to
# actually deploy this
$schema->drop_table ($table);
}
}
my %views;
my @views = map { $dbicschema->source($_) } keys %view_monikers;
my $view_dependencies = {
map {
$_ => _resolve_deps( $dbicschema->source($_), \%view_monikers )
} ( keys %view_monikers )
};
my @view_sources =
sort {
keys %{ $view_dependencies->{ $a->source_name } || {} } <=>
keys %{ $view_dependencies->{ $b->source_name } || {} }
|| $a->source_name cmp $b->source_name
}
map { $dbicschema->source($_) }
keys %view_monikers;
foreach my $source (@view_sources)
{
my $view_name = $source->name;
# FIXME - this isn't the right way to do it, but sqlt does not
# support quoting properly to be signaled about this
$view_name = $$view_name if ref $view_name eq 'SCALAR';
# Skip custom query sources
next if ref $view_name;
# Its possible to have multiple DBIC source using same table
next if $views{$view_name}++;
$dbicschema->throw_exception ("view $view_name is missing a view_definition")
unless $source->view_definition;
my $view = $schema->add_view (
name => $view_name,
fields => [ $source->columns ],
$source->view_definition ? ( 'sql' => $source->view_definition ) : ()
) || $dbicschema->throw_exception ($schema->error);
$source->_invoke_sqlt_deploy_hook($view);
}
if ($dbicschema->can('sqlt_deploy_hook')) {
$dbicschema->sqlt_deploy_hook($schema);
}
return 1;
}
#
# Quick and dirty dependency graph calculator
#
sub _resolve_deps {
my ( $question, $answers, $seen ) = @_;
my $ret = {};
$seen ||= {};
my @deps;
# copy and bump all deps by one (so we can reconstruct the chain)
my %seen = map { $_ => $seen->{$_} + 1 } ( keys %$seen );
if ( blessed($question)
&& $question->isa('DBIx::Class::ResultSource::View') )
{
$seen{ $question->result_class } = 1;
@deps = keys %{ $question->{deploy_depends_on} };
}
else {
$seen{$question} = 1;
@deps = keys %{ $answers->{$question}{foreign_table_deps} };
}
for my $dep (@deps) {
if ( $seen->{$dep} ) {
return {};
}
my $next_dep;
if ( blessed($question)
&& $question->isa('DBIx::Class::ResultSource::View') )
{
no warnings 'uninitialized';
my ($next_dep_source_name) =
grep {
$question->schema->source($_)->result_class eq $dep
&& !( $question->schema->source($_)
->isa('DBIx::Class::ResultSource::Table') )
} @{ [ $question->schema->sources ] };
return {} unless $next_dep_source_name;
$next_dep = $question->schema->source($next_dep_source_name);
}
else {
$next_dep = $dep;
}
my $subdeps = _resolve_deps( $next_dep, $answers, \%seen );
$ret->{$_} += $subdeps->{$_} for ( keys %$subdeps );
++$ret->{$dep};
}
return $ret;
}
1;
=head1 NAME
SQL::Translator::Parser::DBIx::Class - Create a SQL::Translator schema
from a DBIx::Class::Schema instance
=head1 SYNOPSIS
## Via DBIx::Class
use MyApp::Schema;
my $schema = MyApp::Schema->connect("dbi:SQLite:something.db");
$schema->create_ddl_dir();
## or
$schema->deploy();
## Standalone
use MyApp::Schema;
use SQL::Translator;
my $schema = MyApp::Schema->connect;
my $trans = SQL::Translator->new (
parser => 'SQL::Translator::Parser::DBIx::Class',
parser_args => {
dbic_schema => $schema,
add_fk_index => 0,
sources => [qw/
Artist
CD
/],
},
producer => 'SQLite',
) or die SQL::Translator->error;
my $out = $trans->translate() or die $trans->error;
=head1 DESCRIPTION
This class requires L<SQL::Translator> installed to work.
C<SQL::Translator::Parser::DBIx::Class> reads a DBIx::Class schema,
interrogates the columns, and stuffs it all in an $sqlt_schema object.
Its primary use is in deploying database layouts described as a set
of L<DBIx::Class> classes, to a database. To do this, see
L<DBIx::Class::Schema/deploy>.
This can also be achieved by having DBIx::Class export the schema as a
set of SQL files ready for import into your database, or passed to
other machines that need to have your application installed but don't
have SQL::Translator installed. To do this see
L<DBIx::Class::Schema/create_ddl_dir>.
=head1 PARSER OPTIONS
=head2 dbic_schema
The DBIx::Class schema (either an instance or a class name) to be parsed.
This argument is in fact optional - instead one can supply it later at
translation time as an argument to L<SQL::Translator/translate>. In
other words both of the following invocations are valid and will produce
conceptually identical output:
my $yaml = SQL::Translator->new(
parser => 'SQL::Translator::Parser::DBIx::Class',
parser_args => {
dbic_schema => $schema,
},
producer => 'SQL::Translator::Producer::YAML',
)->translate;
my $yaml = SQL::Translator->new(
parser => 'SQL::Translator::Parser::DBIx::Class',
producer => 'SQL::Translator::Producer::YAML',
)->translate(data => $schema);
=head2 add_fk_index
Create an index for each foreign key.
Enabled by default, as having indexed foreign key columns is normally the
sensible thing to do.
=head2 sources
=over 4
=item Arguments: \@class_names
=back
Limit the amount of parsed sources by supplying an explicit list of source names.
=head1 SEE ALSO
L<SQL::Translator>, L<DBIx::Class::Schema>
=head1 FURTHER QUESTIONS?
Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
=head1 COPYRIGHT AND LICENSE
This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
|