=head1 DESCRIPTION
-This tutorial will guide you through the proeccess of setting up and testing a very basic CD database using Mysql, with DBIx::Class::Schema as the database frontend.
+This tutorial will guide you through the proeccess of setting up and
+testing a very basic CD database using SQLite, with DBIx::Class::Schema
+as the database frontend.
The database consists of the following:
=head2 Installation
-=head3 Create the database/tables and populate them with a few records
+Install DBIx::Class via CPAN should be sufficient.
- CREATE DATABASE cdtestdb ;
- USE cdtestdb;
+=head3 Create the database/tables.
- CREATE TABLE artist (
- artistid INT NOT NULL AUTO_INCREMENT ,
- name CHAR( 40 ) NOT NULL ,
- PRIMARY KEY ( artistid )
- );
+First make and change the directory:
- CREATE TABLE cd (
- cdid INT NOT NULL AUTO_INCREMENT ,
- artist INT NOT NULL ,
- title CHAR( 40 ) NOT NULL ,
- PRIMARY KEY ( cdid )
- );
+ mkdir app
+ cd app
- CREATE TABLE track (
- trackid INT NOT NULL AUTO_INCREMENT ,
- cd INT NOT NULL ,
- title CHAR( 40 ) NOT NULL ,
- PRIMARY KEY ( trackid )
- ;
+This example uses SQLite which is a dependency of DBIx::Class, so you
+shouldn't have to install extra software.
+Save the following into a example.sql
- INSERT INTO artist VALUES
- (NULL,'Michael Jackson'),
- (NULL,'Eminem');
-
- INSERT INTO cd VALUES
- (NULL,'1','Thriller'),
- (NULL,'1','Bad'),
- (NULL,'2','The Marshall Mathers LP');
-
- INSERT INTO track VALUES
- (NULL,'1','Beat it'),
- (NULL,'1','Billie Jean'),
- (NULL,'2','Dirty Diana'),
- (NULL,'2','Smooth Criminal'),
- (NULL,'2','Leave Me Alone'),
- (NULL,'3','Stan'),
- (NULL,'3','The Way I Am');
+ CREATE TABLE artist (
+ artistid INTEGER PRIMARY KEY,
+ name TEXT NOT NULL
+ );
+
+ CREATE TABLE cd (
+ cdid INTEGER PRIMARY KEY,
+ artist INTEGER NOT NULL REFERENCES artist(artistid),
+ title TEXT NOT NULL);
+ CREATE TABLE track (
+ trackid INTEGER PRIMARY KEY,
+ cd INTEGER NOT NULL REFERENCES cd(cdid),
+ title TEXT NOT NULL) ;
+and create the sqlite database file:
+
+sqlite3 example.db < example.sql
=head3 Set up DBIx::Class::Schema
First, create some dirs and change working directory:
- mkdir app
- mkdir app/DB
- mkdir app/DB/Main
- cd app
+ mkdir MyDatabase
+ mkdir MyDatabase/Main
-
Then, create the following DBIx::Class::Schema classes:
-DB/Main.pm:
+MyDatabase/Main.pm:
- package DB::Main;
+ package MyDatabase::Main;
use base qw/DBIx::Class::Schema/;
- __PACKAGE__->load_classes(qw/Artist CD Track/);
+ __PACKAGE__->load_classes(qw/Artist Cd Track/);
1;
-DB/Main/Artist.pm:
+MyDatabase/Main/Artist.pm:
- package DB::Main::Artist;
+ package MyDatabase::Main::Artist;
use base qw/DBIx::Class/;
__PACKAGE__->load_components(qw/Core/);
__PACKAGE__->table('artist');
__PACKAGE__->add_columns(qw/ artistid name /);
__PACKAGE__->set_primary_key('artistid');
- __PACKAGE__->has_many('cds' => 'DB::Main::CD');
+ __PACKAGE__->has_many('cds' => 'MyDatabase::Main::Cd');
1;
-DB/Main/CD.pm:
+MyDatabase/Main/Cd.pm:
- package DB::Main::CD;
+ package MyDatabase::Main::Cd;
use base qw/DBIx::Class/;
__PACKAGE__->load_components(qw/Core/);
__PACKAGE__->table('cd');
__PACKAGE__->add_columns(qw/ cdid artist title/);
__PACKAGE__->set_primary_key('cdid');
- __PACKAGE__->belongs_to('artist' => 'DB::Main::Artist');
- __PACKAGE__->has_many('tracks' => 'DB::Main::Track');
-
+ __PACKAGE__->belongs_to('artist' => 'MyDatabase::Main::Artist');
+ __PACKAGE__->has_many('tracks' => 'MyDatabase::Main::Track');
+
1;
-
-DB/Main/Track.pm:
- package DB::Main::Track;
+MyDatabase/Main/Track.pm:
+
+ package MyDatabase::Main::Track;
use base qw/DBIx::Class/;
__PACKAGE__->load_components(qw/Core/);
__PACKAGE__->table('track');
__PACKAGE__->add_columns(qw/ trackid cd title/);
__PACKAGE__->set_primary_key('trackid');
- __PACKAGE__->belongs_to('cd' => 'DB::Main::CD');
-
+ __PACKAGE__->belongs_to('cd' => 'MyDatabase::Main::Cd');
+
1;
-=head3 Create and run the test script
+=head3 Write a script to insert some records.
+
+insertdb.pl
+
+ #!/usr/bin/perl -w
+
+ use MyDatabase::Main;
+ use strict;
+
+ my $schema = MyDatabase::Main->connect('dbi:SQLite:example.db');
+
+ # 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 @artists = (['Michael Jackson'], ['Eminem']);
+ $schema->populate('Artist', [
+ [qw/name/],
+ @artists,
+ ]);
+
+ my %albums = (
+ 'Thriller' => 'Michael Jackson',
+ 'Bad' => 'Michael Jackson',
+ 'The Marshall Mathers LP' => 'Eminem',
+ );
+
+ my @cds;
+ foreach my $lp (keys %albums) {
+ my $artist = $schema->resultset('Artist')->search({
+ name => $albums{$lp}
+ });
+ push @cds, [$lp, $artist->first];
+ }
+
+ $schema->populate('Cd', [
+ [qw/title artist/],
+ @cds,
+ ]);
+
+
+ my %tracks = (
+ 'Beat It' => 'Thriller',
+ 'Billie Jean' => 'Thriller',
+ 'Dirty Diana' => 'Bad',
+ 'Smooth Criminal' => 'Bad',
+ 'Leave Me Alone' => 'Bad',
+ 'Stan' => 'The Marshall Mathers LP',
+ 'The Way I Am' => 'The Marshall Mathers LP',
+ );
+
+ my @tracks;
+ foreach my $track (keys %tracks) {
+ my $cdname = $schema->resultset('Cd')->search({
+ title => $tracks{$track},
+ });
+ push @tracks, [$cdname->first, $track];
+ }
+
+ $schema->populate('Track',[
+ [qw/cd title/],
+ @tracks,
+ ]);
+
+=head3 Create and run the scripts
testdb.pl:
#!/usr/bin/perl -w
- use DB::Main;
+ use MyDatabase::Main;
use strict;
- my $schema = DB::Main->connect('dbi:mysql:cdtestdb', 'serval', 'TNOownage');
+ my $schema = MyDatabase::Main->connect('dbi:SQLite:example.db');
get_tracks_by_cd('Bad');
get_tracks_by_artist('Michael Jackson');
sub get_cd_by_track {
my $tracktitle = shift;
print "get_cd_by_track($tracktitle):\n";
- my $rs = $schema->resultset('CD')->search(
+ my $rs = $schema->resultset('Cd')->search(
{
'tracks.title' => $tracktitle
},
sub get_cds_by_artist {
my $artistname = shift;
print "get_cds_by_artist($artistname):\n";
- my $rs = $schema->resultset('CD')->search(
+ my $rs = $schema->resultset('Cd')->search(
{
'artist.name' => $artistname
},
get_artist_by_cd(The Marshall Mathers LP):
Eminem
+=head1 Notes
+
+With these scripts we're relying on @INC looking in the current
+working directory. You may want to add the MyDatabase namespaces to
+@INC in a different way when it comes to deployemnt.
+
+The testdb.pl script is an excellent start for testing your database
+model.
+
+=head1 TODO
+
=head1 AUTHOR
- sc_
+ sc_ from irc.perl.org#dbix-class
+ Kieren Diment <kd@totaldatasolution.com>
=cut
projects / dbsrgits/DBIx-Class.git / blobdiff