+++ /dev/null
-NAME
- DBIx::Class::Schema::Loader - Dynamic definition of a
- DBIx::Class::Schema
-
-SYNOPSIS
- ### use this module to generate a set of class files
-
- # in a script
- use DBIx::Class::Schema::Loader qw/ make_schema_at /;
- make_schema_at(
- 'My::Schema',
- { debug => 1,
- dump_directory => './lib',
- },
- [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword' ],
- );
-
- # from the command line or a shell script with dbicdump (distributed
- # with this module). Do `perldoc dbicdump` for usage.
- dbicdump -o dump_directory=./lib \
- -o debug=1 \
- My::Schema \
- 'dbi:Pg:dbname=foo' \
- myuser \
- mypassword
-
- ### or generate and load classes at runtime
- # note: this technique is not recommended
- # for use in production code
-
- package My::Schema;
- use base qw/DBIx::Class::Schema::Loader/;
-
- __PACKAGE__->loader_options(
- constraint => '^foo.*',
- # debug => 1,
- );
-
- #### in application code elsewhere:
-
- use My::Schema;
-
- my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
- # -or-
- my $schema1 = "My::Schema"; $schema1->connection(as above);
-
-DESCRIPTION
- DBIx::Class::Schema::Loader automates the definition of a
- DBIx::Class::Schema by scanning database table definitions and setting
- up the columns, primary keys, and relationships.
-
- DBIx::Class::Schema::Loader currently supports only the DBI storage
- type. It has explicit support for DBD::Pg, DBD::mysql, DBD::DB2,
- DBD::SQLite, and DBD::Oracle. Other DBI drivers may function to a
- greater or lesser degree with this loader, depending on how much of the
- DBI spec they implement, and how standard their implementation is.
-
- Patches to make other DBDs work correctly welcome.
-
- See DBIx::Class::Schema::Loader::DBI::Writing for notes on writing your
- own vendor-specific subclass for an unsupported DBD driver.
-
- This module requires DBIx::Class 0.07006 or later, and obsoletes the
- older DBIx::Class::Loader.
-
- This module is designed more to get you up and running quickly against
- an existing database, or to be effective for simple situations, rather
- than to be what you use in the long term for a complex database/project.
-
- That being said, transitioning your code from a Schema generated by this
- module to one that doesn't use this module should be straightforward and
- painless, so don't shy away from it just for fears of the transition
- down the road.
-
-METHODS
- loader_class
- Argument: $loader_class
-
- Set the loader class to be instantiated when "connection" is called. If
- the classname starts with "::", "DBIx::Class::Schema::Loader" is
- prepended. Defaults to "storage_type" in DBIx::Class::Schema (which must
- start with "::" when using DBIx::Class::Schema::Loader).
-
- This is mostly useful for subclassing existing loaders or in conjunction
- with "dump_to_dir".
-
- loader_options
- Argument: \%loader_options
-
- Example in Synopsis above demonstrates a few common arguments. For
- detailed information on all of the arguments, most of which are only
- useful in fairly complex scenarios, see the
- DBIx::Class::Schema::Loader::Base documentation.
-
- If you intend to use "loader_options", you must call "loader_options"
- before any connection is made, or embed the "loader_options" in the
- connection information itself as shown below. Setting "loader_options"
- after the connection has already been made is useless.
-
- connection
- Arguments: @args
- Return Value: $new_schema
-
- See "connection" in DBIx::Class::Schema for basic usage.
-
- If the final argument is a hashref, and it contains the keys
- "loader_options" or "loader_class", those keys will be deleted, and
- their values value will be used for the loader options or class,
- respectively, just as if set via the "loader_options" or "loader_class"
- methods above.
-
- The actual auto-loading operation (the heart of this module) will be
- invoked as soon as the connection information is defined.
-
- clone
- See "clone" in DBIx::Class::Schema.
-
- dump_to_dir
- Argument: $directory
-
- Calling this as a class method on either DBIx::Class::Schema::Loader or
- any derived schema class will cause all schemas to dump manual versions
- of themselves to the named directory when they are loaded. In order to
- be effective, this must be set before defining a connection on this
- schema class or any derived object (as the loading happens as soon as
- both a connection and loader_options are set, and only once per class).
-
- See "dump_directory" in DBIx::Class::Schema::Loader::Base for more
- details on the dumping mechanism.
-
- This can also be set at module import time via the import option
- "dump_to_dir:/foo/bar" to DBIx::Class::Schema::Loader, where "/foo/bar"
- is the target directory.
-
- Examples:
-
- # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
- # hardcoded in the class itself:
- perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
-
- # Same, but no hard-coded connection, so we must provide one:
- perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
-
- # Or as a class method, as long as you get it done *before* defining a
- # connection on this schema class or any derived object:
- use My::Schema;
- My::Schema->dump_to_dir('/foo/bar');
- My::Schema->connection(........);
-
- # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
- # derived schemas
- use My::Schema;
- use My::OtherSchema;
- DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
- My::Schema->connection(.......);
- My::OtherSchema->connection(.......);
-
- # Another alternative to the above:
- use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
- use My::Schema;
- use My::OtherSchema;
- My::Schema->connection(.......);
- My::OtherSchema->connection(.......);
-
- make_schema_at
- Arguments: $schema_class_name, \%loader_options, \@connect_info
- Return Value: $schema_class_name
-
- This function creates a DBIx::Class schema from an existing RDBMS
- schema. With the "dump_directory" option, generates a set of DBIx::Class
- classes from an existing database schema read from the given dsn.
- Without a "dump_directory", creates schema classes in memory at runtime
- without generating on-disk class files.
-
- For a complete list of supported loader_options, see
- DBIx::Class::Schema::Loader::Base
-
- This function can be imported in the usual way, as illustrated in these
- Examples:
-
- # Simple example, creates as a new class 'New::Schema::Name' in
- # memory in the running perl interpreter.
- use DBIx::Class::Schema::Loader qw/ make_schema_at /;
- make_schema_at(
- 'New::Schema::Name',
- { debug => 1 },
- [ 'dbi:Pg:dbname="foo"','postgres' ],
- );
-
- # Inside a script, specifying a dump directory in which to write
- # class files
- use DBIx::Class::Schema::Loader qw/ make_schema_at /;
- make_schema_at(
- 'New::Schema::Name',
- { debug => 1, dump_directory => './lib' },
- [ 'dbi:Pg:dbname="foo"','postgres' ],
- );
-
- rescan
- Return Value: @new_monikers
-
- Re-scans the database for newly added tables since the initial load, and
- adds them to the schema at runtime, including relationships, etc. Does
- not process drops or changes.
-
- Returns a list of the new monikers added.
-
-KNOWN ISSUES
- Multiple Database Schemas
- Currently the loader is limited to working within a single schema (using
- the underlying RDBMS's definition of "schema"). If you have a
- multi-schema database with inter-schema relationships (which is easy to
- do in PostgreSQL or DB2 for instance), you currently can only
- automatically load the tables of one schema, and relationships to tables
- in other schemas will be silently ignored.
-
- At some point in the future, an intelligent way around this might be
- devised, probably by allowing the "db_schema" option to be an arrayref
- of schemas to load.
-
- In "normal" DBIx::Class::Schema usage, manually-defined source classes
- and relationships have no problems crossing vendor schemas.
-
-AUTHOR
- Brandon Black, "blblack@gmail.com"
-
- Based on DBIx::Class::Loader by Sebastian Riedel
-
- Based upon the work of IKEBE Tomohiro
-
-THANK YOU
- Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
- in a bug report or suggestion.
-
-LICENSE
- This library is free software; you can redistribute it and/or modify it
- under the same terms as Perl itself.
-
-SEE ALSO
- DBIx::Class, DBIx::Class::Manual::ExampleSchema
-
$self->drop_tables;
}
+# defined in sub create
+my (@statements, @statements_reltests, @statements_advanced,
+ @statements_advanced_sqlite, @statements_inline_rels,
+ @statements_implicit_rels);
+
sub setup_schema {
my $self = shift;
my @connect_info = @_;
my $file_count;
find sub { return if -d; $file_count++ }, $DUMP_DIR;
- is $file_count, 34, 'correct number of files generated';
- exit if $file_count != 34;
+ my $expected_count = 34;
+
+ $expected_count += @{ $self->{extra}{drop} || [] };
+
+ $expected_count -= grep /CREATE TABLE/, @statements_inline_rels
+ if $self->{no_inline_rels};
+
+ $expected_count -= grep /CREATE TABLE/, @statements_implicit_rels
+ if $self->{no_implicit_rels};
+
+ is $file_count, $expected_count, 'correct number of files generated';
+
+ exit if $file_count != $expected_count;
my $warn_count = 2;
$warn_count++ if grep /ResultSetManager/, @loader_warnings;
my $before_digest = $digest->digest;
my $dbh = $self->dbconnect(1);
- $dbh->do($_) for @statements_rescan;
+
+ {
+ # Silence annoying but harmless postgres "NOTICE: CREATE TABLE..."
+ local $SIG{__WARN__} = sub {
+ my $msg = shift;
+ print STDERR $msg unless $msg =~ m{^NOTICE:\s+CREATE TABLE};
+ };
+
+ $dbh->do($_) for @statements_rescan;
+ }
+
$dbh->disconnect;
sleep 1;
$self->{_created} = 1;
my $make_auto_inc = $self->{auto_inc_cb} || sub {};
- my @statements = (
+ @statements = (
qq{
CREATE TABLE loader_test1s (
id $self->{auto_inc_pk},
},
);
- my @statements_reltests = (
+ @statements_reltests = (
qq{
CREATE TABLE loader_test3 (
id INTEGER NOT NULL PRIMARY KEY,
q{ INSERT INTO loader_test34 (id,rel1) VALUES (1,2) },
);
- my @statements_advanced = (
+ @statements_advanced = (
qq{
CREATE TABLE loader_test10 (
id10 $self->{auto_inc_pk},
q{ REFERENCES loader_test11 (id11) }),
);
- my @statements_advanced_sqlite = (
+ @statements_advanced_sqlite = (
qq{
CREATE TABLE loader_test10 (
id10 $self->{auto_inc_pk},
q{ loader_test11 INTEGER REFERENCES loader_test11 (id11) }),
);
- my @statements_inline_rels = (
+ @statements_inline_rels = (
qq{
CREATE TABLE loader_test12 (
id INTEGER NOT NULL PRIMARY KEY,
);
- my @statements_implicit_rels = (
+ @statements_implicit_rels = (
qq{
CREATE TABLE loader_test14 (
id INTEGER NOT NULL PRIMARY KEY,
projects / dbsrgits/DBIx-Class-Schema-Loader.git / commitdiff