Example doesn't work without 'year' column
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual / Example.pod
index 5d8980f..83e96fe 100644 (file)
@@ -11,7 +11,7 @@ as the database frontend.
 The database consists of the following:
 
   table 'artist' with columns:  artistid, name
-  table 'cd'     with columns:  cdid, artist, title
+  table 'cd'     with columns:  cdid, artist, title, year
   table 'track'  with columns:  trackid, cd, title
 
 
@@ -49,7 +49,8 @@ Save the following into a example.sql in the directory db
   CREATE TABLE cd (
     cdid INTEGER PRIMARY KEY,
     artist INTEGER NOT NULL REFERENCES artist(artistid),
-    title TEXT NOT NULL
+    title TEXT NOT NULL,
+    year TEXT
   );
 
   CREATE TABLE track (
@@ -58,7 +59,7 @@ Save the following into a example.sql in the directory db
     title TEXT NOT NULL
   );
 
-and create the sqlite database file:
+and create the SQLite database file:
 
   sqlite3 example.db < example.sql
 
@@ -70,58 +71,56 @@ Change directory back from db to the directory app:
 
 Now create some more directories:
 
-  mkdir MyDatabase
-  mkdir MyDatabase/Main
-  mkdir MyDatabase/Main/Result
-  mkdir MyDatabase/Main/ResultSet
+  mkdir MyApp
+  mkdir MyApp/Schema
+  mkdir MyApp/Schema/Result
+  mkdir MyApp/Schema/ResultSet
 
 Then, create the following DBIx::Class::Schema classes:
 
-MyDatabase/Main.pm:
+MyApp/Schema.pm:
 
-  package MyDatabase::Main;
+  package MyApp::Schema;
   use base qw/DBIx::Class::Schema/;
   __PACKAGE__->load_namespaces;
 
   1;
 
 
-MyDatabase/Main/Result/Artist.pm:
+MyApp/Schema/Result/Artist.pm:
 
-  package MyDatabase::Main::Result::Artist;
-  use base qw/DBIx::Class/;
-  __PACKAGE__->load_components(qw/Core/);
+  package MyApp::Schema::Result::Artist;
+  use base qw/DBIx::Class::Core/;
   __PACKAGE__->table('artist');
   __PACKAGE__->add_columns(qw/ artistid name /);
   __PACKAGE__->set_primary_key('artistid');
-  __PACKAGE__->has_many('cds' => 'MyDatabase::Main::Result::Cd');
+  __PACKAGE__->has_many('cds' => 'MyApp::Schema::Result::Cd');
 
   1;
 
 
-MyDatabase/Main/Result/Cd.pm:
+MyApp/Schema/Result/Cd.pm:
 
-  package MyDatabase::Main::Result::Cd;
-  use base qw/DBIx::Class/;
-  __PACKAGE__->load_components(qw/Core/);
+  package MyApp::Schema::Result::Cd;
+  use base qw/DBIx::Class::Core/;
+  __PACKAGE__->load_components(qw/InflateColumn::DateTime/);
   __PACKAGE__->table('cd');
-  __PACKAGE__->add_columns(qw/ cdid artist title/);
+  __PACKAGE__->add_columns(qw/ cdid artist title year/);
   __PACKAGE__->set_primary_key('cdid');
-  __PACKAGE__->belongs_to('artist' => 'MyDatabase::Main::Result::Artist');
-  __PACKAGE__->has_many('tracks' => 'MyDatabase::Main::Result::Track');
+  __PACKAGE__->belongs_to('artist' => 'MyApp::Schema::Result::Artist');
+  __PACKAGE__->has_many('tracks' => 'MyApp::Schema::Result::Track');
 
   1;
 
 
-MyDatabase/Main/Result/Track.pm:
+MyApp/Schema/Result/Track.pm:
 
-  package MyDatabase::Main::Result::Track;
-  use base qw/DBIx::Class/;
-  __PACKAGE__->load_components(qw/Core/);
+  package MyApp::Schema::Result::Track;
+  use base qw/DBIx::Class::Core/;
   __PACKAGE__->table('track');
-  __PACKAGE__->add_columns(qw/ trackid cd title/);
+  __PACKAGE__->add_columns(qw/ trackid cd title /);
   __PACKAGE__->set_primary_key('trackid');
-  __PACKAGE__->belongs_to('cd' => 'MyDatabase::Main::Result::Cd');
+  __PACKAGE__->belongs_to('cd' => 'MyApp::Schema::Result::Cd');
 
   1;
 
@@ -130,16 +129,14 @@ MyDatabase/Main/Result/Track.pm:
 
 insertdb.pl
 
-  #!/usr/bin/perl -w
+  #!/usr/bin/perl
 
-  use MyDatabase::Main;
   use strict;
+  use warnings;
 
-  my $schema = MyDatabase::Main->connect('dbi:SQLite:db/example.db');
+  use MyApp::Schema;
 
-  #  here's some of the SQL that is going to be generated by the schema
-  #  INSERT INTO artist VALUES (NULL,'Michael Jackson');
-  #  INSERT INTO artist VALUES (NULL,'Eminem');
+  my $schema = MyApp::Schema->connect('dbi:SQLite:db/example.db');
 
   my @artists = (['Michael Jackson'], ['Eminem']);
   $schema->populate('Artist', [
@@ -194,13 +191,15 @@ insertdb.pl
 
 testdb.pl:
 
-  #!/usr/bin/perl -w
+  #!/usr/bin/perl
 
-  use MyDatabase::Main;
   use strict;
+  use warnings;
+
+  use MyApp::Schema;
 
-  my $schema = MyDatabase::Main->connect('dbi:SQLite:db/example.db');
-  # for other DSNs, e.g. MySql, see the perldoc for the relevant dbd
+  my $schema = MyApp::Schema->connect('dbi:SQLite:db/example.db');
+  # for other DSNs, e.g. MySQL, see the perldoc for the relevant dbd
   # driver, e.g perldoc L<DBD::mysql>.
 
   get_tracks_by_cd('Bad');
@@ -347,29 +346,34 @@ It should output:
 
 =head1 Notes
 
-A reference implentation of the database and scripts in this example
+A reference implementation of the database and scripts in this example
 are available in the main distribution for DBIx::Class under the
-directory F<t/examples/Schema>.
+directory F<examples/Schema>.
 
 With these scripts we're relying on @INC looking in the current
-working directory.  You may want to add the MyDatabase namespaces to
+working directory.  You may want to add the MyApp namespaces to
 @INC in a different way when it comes to deployment.
 
 The F<testdb.pl> script is an excellent start for testing your database
 model.
 
 This example uses L<DBIx::Class::Schema/load_namespaces> to load in the
-appropriate L<Row|DBIx::Class::Row> classes from the MyDatabase::Main::Result namespace,
-and any required resultset classes from the MyDatabase::Main::ResultSet
-namespace (although we created the directory in the directions above we
-did not add, or need to add, any resultset classes).
+appropriate L<Result|DBIx::Class::Manual::ResultClass> classes from the
+C<MyApp::Schema::Result> namespace, and any required
+L<ResultSet|DBIx::Class::ResultSet> classes from the
+C<MyApp::Schema::ResultSet> namespace (although we created the directory
+in the directions above we did not add, or need to add, any resultset
+classes).
+
+=head1 FURTHER QUESTIONS?
 
-=head1 TODO
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=head1 AUTHOR
+=head1 COPYRIGHT AND LICENSE
 
-  sc_ from irc.perl.org#dbix-class
-  Kieren Diment <kd@totaldatasolution.com>
-  Nigel Metheringham <nigelm@cpan.org>
+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>.
 
 =cut