FabForce::DBDesigner4::DBIC - create DBIC scheme for DBDesigner4 xml file

Version 0.0802

    use FabForce::DBDesigner4::DBIC;

    my $foo = FabForce::DBDesigner4::DBIC->new();
    $foo->output_path( $some_path );
    $foo->namespace( 'MyApp::DB' );
    $foo->create_schema( $xml_document );

creates a new object of FabForce::DBDesigner4::DBIC. You can pass some parameters to new (all parameters are optional)

  my $foo = FabForce::DBDesigner4::DBIC->new(
    output_path => '/path/to/dir',
    input_file  => '/path/to/dbdesigner.file',
    namespace   => 'MyApp::Database',
    schema_name => 'MySchema',
  );

sets / gets the output path for the scheme

  $foo->output_path( '/any/directory' );
  print $foo->output_path;

sets / gets the name of the DBDesigner file (XML format)

  $foo->input_file( 'dbdesigner.xml' );
  print $foo->input_file;

creates all the files that are needed to work with DBIx::Class schema:

The main module that loads all classes and one class per table. If you haven't specified an input file, the module will croak.

You can specify the input file either with input_file or as an parameter for create_schema

  $foo->input_file( 'dbdesigner.xml' );
  $foo->create_schema;

  # or

  $foo->create_schema( 'dbdesigner.xml' );

create_scheme is an alias for create_schema for compatibility reasons

sets a new name for the schema. By default on of these names is used:

  DBIC_Scheme Database DBIC MyScheme MyDatabase DBIxClass_Scheme

  $dbic->schema_name( 'MyNewSchema' );

sets / gets the name of the namespace. If you set the namespace to 'Test' and you have a table named 'MyTable', the main module is named 'Test::DBIC_Scheme' and the class for 'MyTable' is named 'Test::DBIC_Scheme::MyTable'

  $foo->namespace( 'MyApp::DB' );

In relationships the accessor for the objects of the "other" table shouldn't have the name of the column. Otherwise it is very clumsy to get the orginial value of this table.

  $foo->prefix( 'belongs_to' => 'fk_' );
  $foo->prefix( 'has_many' => 'has_' );

creates (col1 is the column name of the foreign key)

  __PACKAGE__->belongs_to( 'fk_col1' => 'OtherTable', {'foreign.col1' => 'self.col1' } );

returns the FabForce::DBDesigner4 object.

Renee Baecker, <module at renee-baecker.de>

Please report any bugs or feature requests to bug-fabforce-dbdesigner4-dbic at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FabForce::DBDesigner4::DBIC. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc FabForce::DBDesigner4::DBIC

You can also look for information at:

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/FabForce::DBDesigner4::DBIC

* CPAN Ratings

http://cpanratings.perl.org/d/FabForce::DBDesigner4::DBIC

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=FabForce::DBDesigner4::DBIC

* Search CPAN

http://search.cpan.org/dist/FabForce::DBDesigner4::DBIC

Copyright 2007 Renee Baecker, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.