1 package DBIx::DBSchema;
4 use vars qw($VERSION $DEBUG $errstr);
6 use DBIx::DBSchema::_util qw(_load_driver _dbh);
7 use DBIx::DBSchema::Table 0.05;
8 use DBIx::DBSchema::Index;
9 use DBIx::DBSchema::Column;
10 use DBIx::DBSchema::ColGroup::Unique;
11 use DBIx::DBSchema::ColGroup::Index;
14 $VERSION = eval $VERSION; # modperlstyle: convert the string into a number
20 DBIx::DBSchema - Database-independent schema objects
26 $schema = new DBIx::DBSchema @dbix_dbschema_table_objects;
27 $schema = new_odbc DBIx::DBSchema $dbh;
28 $schema = new_odbc DBIx::DBSchema $dsn, $user, $pass;
29 $schema = new_native DBIx::DBSchema $dbh;
30 $schema = new_native DBIx::DBSchema $dsn, $user, $pass;
32 $schema->save("filename");
33 $schema = load DBIx::DBSchema "filename" or die $DBIx::DBSchema::errstr;
35 $schema->addtable($dbix_dbschema_table_object);
37 @table_names = $schema->tables;
39 $DBIx_DBSchema_table_object = $schema->table("table_name");
41 @sql = $schema->sql($dbh);
42 @sql = $schema->sql($dsn, $username, $password);
43 @sql = $schema->sql($dsn); #doesn't connect to database - less reliable
45 $perl_code = $schema->pretty_print;
46 %hash = eval $perl_code;
47 use DBI qw(:sql_types); $schema = pretty_read DBIx::DBSchema \%hash;
51 DBIx::DBSchema objects are collections of DBIx::DBSchema::Table objects and
52 represent a database schema.
54 This module implements an OO-interface to database schemas. Using this module,
55 you can create a database schema with an OO Perl interface. You can read the
56 schema from an existing database. You can save the schema to disk and restore
57 it in a different process. You can write SQL CREATE statements statements for
58 different databases from a single source. In recent versions, you can
59 transform one schema to another, adding any necessary new columns and tables
60 (and, as of 0.33, indices).
62 Currently supported databases are MySQL, PostgreSQL and SQLite. Sybase and
63 Oracle drivers are partially implemented. DBIx::DBSchema will attempt to use
64 generic SQL syntax for other databases. Assistance adding support for other
65 databases is welcomed. See L<DBIx::DBSchema::DBD>, "Driver Writer's Guide and
72 =item new TABLE_OBJECT, TABLE_OBJECT, ...
74 Creates a new DBIx::DBSchema object.
79 my($proto, @tables) = @_;
80 my %tables = map { $_->name, $_ } @tables; #check for duplicates?
82 my $class = ref($proto) || $proto;
87 bless ($self, $class);
91 =item new_odbc DATABASE_HANDLE | DATA_SOURCE USERNAME PASSWORD [ ATTR ]
93 Creates a new DBIx::DBSchema object from an existing data source, which can be
94 specified by passing an open DBI database handle, or by passing the DBI data
95 source name, username, and password. This uses the experimental DBI type_info
96 method to create a schema with standard (ODBC) SQL column types that most
97 closely correspond to any non-portable column types. Use this to import a
98 schema that you wish to use with many different database engines. Although
99 primary key and (unique) index information will only be read from databases
100 with DBIx::DBSchema::DBD drivers (currently MySQL and PostgreSQL), import of
101 column names and attributes *should* work for any database. Note that this
102 method only uses "ODBC" column types; it does not require or use an ODBC
108 my($proto, $dbh) = ( shift, _dbh(@_) );
110 map { new_odbc DBIx::DBSchema::Table $dbh, $_ } _tables_from_dbh($dbh)
114 =item new_native DATABASE_HANDLE | DATA_SOURCE USERNAME PASSWORD [ ATTR ]
116 Creates a new DBIx::DBSchema object from an existing data source, which can be
117 specified by passing an open DBI database handle, or by passing the DBI data
118 source name, username and password. This uses database-native methods to read
119 the schema, and will preserve any non-portable column types. The method is
120 only available if there is a DBIx::DBSchema::DBD for the corresponding database engine (currently, MySQL and PostgreSQL).
125 my($proto, $dbh) = (shift, _dbh(@_) );
127 map { new_native DBIx::DBSchema::Table ( $dbh, $_ ) } _tables_from_dbh($dbh)
133 Loads a DBIx::DBSchema object from a file. If there is an error, returns
134 false and puts an error message in $DBIx::DBSchema::errstr;
139 my($proto,$file)=@_; #use $proto ?
144 eval { $self = Storable::retrieve($file); };
146 if ( $@ && $@ =~ /not.*storable/i ) { #then try FreezeThaw
149 eval "use FreezeThaw;";
154 or do { $errstr = "Can't open $file: $!"; return ''; };
155 my $string = join('',<FILE>);
157 or do { $errstr = "Can't close $file: $!"; return ''; };
158 ($self) = FreezeThaw::thaw($string);
172 Saves a DBIx::DBSchema object to a file.
177 #my($self, $file) = @_;
178 Storable::nstore(@_);
181 =item addtable TABLE_OBJECT
183 Adds the given DBIx::DBSchema::Table object to this DBIx::DBSchema.
189 $self->{'tables'}->{$table->name} = $table; #check for dupliates?
194 Returns a list of the names of all tables.
200 keys %{$self->{'tables'}};
203 =item table TABLENAME
205 Returns the specified DBIx::DBSchema::Table object.
211 $self->{'tables'}->{$table};
214 =item sql [ DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ] ]
216 Returns a list of SQL `CREATE' statements for this schema.
218 The data source can be specified by passing an open DBI database handle, or by
219 passing the DBI data source name, username and password.
221 Although the username and password are optional, it is best to call this method
222 with a database handle or data source including a valid username and password -
223 a DBI connection will be opened and the quoting and type mapping will be more
226 If passed a DBI data source (or handle) such as `DBI:mysql:database' or
227 `DBI:Pg:dbname=database', will use syntax specific to that database engine.
228 Currently supported databases are MySQL and PostgreSQL.
230 If not passed a data source (or handle), or if there is no driver for the
231 specified database, will attempt to use generic SQL syntax.
236 my($self, $dbh) = ( shift, _dbh(@_) );
237 map { $self->table($_)->sql_create_table($dbh); } $self->tables;
240 =item sql_update_schema PROTOTYPE_SCHEMA [ DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ] ]
242 Returns a list of SQL statements to update this schema so that it is idential
243 to the provided prototype schema, also a DBIx::DBSchema object.
245 #Optionally, the data source can be specified by passing an open DBI database
246 #handle, or by passing the DBI data source name, username and password.
248 #If passed a DBI data source (or handle) such as `DBI:mysql:database' or
249 #`DBI:Pg:dbname=database', will use syntax specific to that database engine.
250 #Currently supported databases are MySQL and PostgreSQL.
252 #If not passed a data source (or handle), or if there is no driver for the
253 #specified database, will attempt to use generic SQL syntax.
255 Right now this method knows how to add new tables and alter existing tables.
256 It doesn't know how to drop tables yet.
258 See L<DBIx::DBSchema::Table/sql_alter_table>,
259 L<DBIx::DBSchema::Column/sql_add_coumn> and
260 L<DBIx::DBSchema::Column/sql_alter_column> for additional specifics and
265 #gosh, false laziness w/DBSchema::Table::sql_alter_schema
267 sub sql_update_schema {
268 my($self, $new, $dbh) = ( shift, shift, _dbh(@_) );
272 foreach my $table ( $new->tables ) {
274 if ( $self->table($table) ) {
276 warn "$table exists\n" if $DEBUG > 1;
279 $self->table($table)->sql_alter_table( $new->table($table), $dbh );
283 warn "table $table does not exist.\n" if $DEBUG;
286 $new->table($table)->sql_create_table( $dbh );
292 # drop tables not in $new
293 foreach my $table ( $self->tables ) {
295 if ( !$new->table($table) ) {
297 warn "table $table should be dropped.\n" if $DEBUG;
300 $self->table($table)->sql_drop_table( $dbh );
304 warn join("\n", @r). "\n"
311 =item update_schema PROTOTYPE_SCHEMA, DATABASE_HANDLE | DATA_SOURCE [ USERNAME PASSWORD [ ATTR ] ]
313 Same as sql_update_schema, except actually runs the SQL commands to update
314 the schema. Throws a fatal error if any statement fails.
319 my($self, $new, $dbh) = ( shift, shift, _dbh(@_) );
321 foreach my $statement ( $self->sql_update_schema( $new, $dbh ) ) {
322 $dbh->do( $statement )
323 or die "Error: ". $dbh->errstr. "\n executing: $statement";
330 Returns the data in this schema as Perl source, suitable for assigning to a
341 my $table = $self->table($tablename);
342 my %indices = $table->indices;
344 "'$tablename' => {\n".
347 #cant because -w complains about , in qw()
348 # (also biiiig problems with empty lengths)
350 #$table->column($_)->type. " ".
351 #( $table->column($_)->null ? 'NULL' : 0 ). " ".
352 #$table->column($_)->length. " ),\n"
354 "'". $table->column($_)->type. "', ".
355 "'". $table->column($_)->null. "', ".
356 "'". $table->column($_)->length. "', ".
357 "'". $table->column($_)->default. "', ".
358 "'". $table->column($_)->local. "',\n"
362 " 'primary_key' => '". $table->primary_key. "',\n".
364 #old style index representation..
367 $table->{'unique'} # $table->unique
368 ? " 'unique' => [ ". join(', ',
369 map { "[ '". join("', '", @{$_}). "' ]" }
370 @{$table->unique->lol_ref}
375 ( $table->{'index'} # $table->index
376 ? " 'index' => [ ". join(', ',
377 map { "[ '". join("', '", @{$_}). "' ]" }
378 @{$table->index->lol_ref}
384 " 'indices' => { ". join( ",\n ",
386 map { my $iname = $_;
387 my $index = $indices{$iname};
390 ? " 'using' => '". $index->using ."',\n"
393 " 'unique' => ". $index->unique .",\n".
395 join("', '", @{$index->columns} ).
409 =item pretty_read HASHREF
411 Creates a schema as specified by a data structure such as that created by
412 B<pretty_print> method.
417 my($proto, $href) = @_;
419 my $schema = $proto->new( map {
422 my $info = $href->{$tablename};
425 while ( @{$info->{'columns'}} ) {
426 push @columns, DBIx::DBSchema::Column->new(
427 splice @{$info->{'columns'}}, 0, 6
431 DBIx::DBSchema::Table->new({
432 'name' => $tablename,
433 'primary_key' => $info->{'primary_key'},
434 'columns' => \@columns,
437 'unique' => DBIx::DBSchema::ColGroup::Unique->new($info->{'unique'}),
438 'index' => DBIx::DBSchema::ColGroup::Index->new($info->{'index'}),
441 'indices' => [ map { my $idx_info = $info->{'indices'}{$_};
442 DBIx::DBSchema::Index->new({
445 'unique' => $idx_info->{'unique'},
446 'columns' => $idx_info->{'columns'},
449 keys %{ $info->{'indices'} }
457 # private subroutines
459 sub _tables_from_dbh {
461 my $driver = _load_driver($dbh);
463 scalar(eval "DBIx::DBSchema::DBD::$driver->default_db_catalog");
465 scalar(eval "DBIx::DBSchema::DBD::$driver->default_db_schema");
466 my $sth = $dbh->table_info($db_catalog, $db_schema, '', 'TABLE')
468 #map { $_->{TABLE_NAME} } grep { $_->{TABLE_TYPE} eq 'TABLE' }
469 # @{ $sth->fetchall_arrayref({ TABLE_NAME=>1, TABLE_TYPE=>1}) };
470 map { $_->[0] } grep { $_->[1] =~ /^TABLE$/i }
471 @{ $sth->fetchall_arrayref([2,3]) };
478 Ivan Kohler <ivan-dbix-dbschema@420.am>
480 Charles Shapiro <charles.shapiro@numethods.com> and Mitchell Friedman
481 <mitchell.friedman@numethods.com> contributed the start of a Sybase driver.
483 Daniel Hanks <hanksdc@about-inc.com> contributed the Oracle driver.
485 Jesse Vincent contributed the SQLite driver.
489 Contributions are welcome! I'm especially keen on any interest in the top
490 items/projects below under BUGS.
494 Copyright (c) 2000-2007 Ivan Kohler
495 Copyright (c) 2000 Mail Abuse Prevention System LLC
496 Copyright (c) 2007 Freeside Internet Services, Inc.
498 This program is free software; you can redistribute it and/or modify it under
499 the same terms as Perl itself.
503 Multiple primary keys are not yet supported.
505 Foreign keys and other constraints are not yet supported.
507 Eventually it would be nice to have additional transformations (deleted,
508 modified columns, deleted tables). sql_update_schema doesn't drop tables
509 or deal with deleted or modified columns yet.
511 Need to port and test with additional databases
513 Each DBIx::DBSchema object should have a name which corresponds to its name
514 within the SQL database engine (DBI data source).
516 pretty_print is actually pretty ugly.
518 pretty_print isn't so good about quoting values... save/load is a much better
519 alternative to using pretty_print/pretty_read
521 pretty_read is pretty ugly too.
523 pretty_read should *not* create and pass in old-style unique/index indices
524 when nothing is given in the read.
526 Perhaps pretty_read should eval column types so that we can use DBI
527 qw(:sql_types) here instead of externally.
529 Need to support "using" index attribute in pretty_read and in reverse
532 perhaps we should just get rid of pretty_read entirely. pretty_print is useful
533 for debugging, but pretty_read is pretty bunk.
535 sql CREATE TABLE output should convert integers
536 (i.e. use DBI qw(:sql_types);) to local types using DBI->type_info plus a hash
541 L<DBIx::DBSchema::Table>, L<DBIx::DBSchema::Index>,
542 L<DBIx::DBSchema::Column>, L<DBIx::DBSchema::DBD>,
543 L<DBIx::DBSchema::DBD::mysql>, L<DBIx::DBSchema::DBD::Pg>, L<FS::Record>,