=head1 DESCRIPTION
-This tutorial will guide you through the proeccess of setting up and
+This tutorial will guide you through the process 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:
+The database structure is based on the following rules:
- table 'artist' with columns: artistid, name
- table 'cd' with columns: cdid, artist, title
- table 'track' with columns: trackid, cd, title
+ An artist can have many cds, and each cd belongs to just one artist.
+ A cd can have many tracks, and each track belongs to just one cd.
+The database is implemented with the following:
-And these rules exists:
-
- one artist can have many cds
- one cd belongs to one artist
- one cd can have many tracks
- one track belongs to one cd
+ table 'artist' with columns: artistid, name
+ table 'cd' with columns: cdid, artistid, title, year
+ table 'track' with columns: trackid, cdid, title
+Each of the table's first columns is the primary key; any subsequent
+keys are foreign keys.
=head2 Installation
-Install DBIx::Class via CPAN should be sufficient.
-
-=head3 Create the database/tables.
-
-First make and change the directory:
-
- mkdir app
- cd app
-
-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
-
- CREATE TABLE artist (
- artistid INTEGER PRIMARY KEY,
- name TEXT NOT NULL
- );
-
- CREATE TABLE cd (
- cdid INTEGER PRIMARY KEY,
- artist INTEGER NOT NULL REFERENCES artist(id)
- title TEXT NOT NULL);
-
- CREATE TABLE track (
- trackid INTEGER PRIMARY KEY,
- cd INTEGER NOT NULL REFERENCES cd(id),
- 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 DB
- mkdir DB/Main
-
-Then, create the following DBIx::Class::Schema classes:
-
-DB/Main.pm:
-
- package DB::Main;
- use base qw/DBIx::Class::Schema/;
- __PACKAGE__->load_classes(qw/Artist CD Track/);
-
- 1;
-
-
-DB/Main/Artist.pm:
+You'll need to install DBIx::Class via CPAN, and you'll also need to
+install sqlite3 (not sqlite) if it's not already intalled.
- package DB::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');
+=head3 The database/tables/data
- 1;
+Your distribution already comes with a pre-filled SQLite database
+F<examples/Schema/db/example.db>. You can see it by e.g.
+ cpanm --look DBIx::Class
-DB/Main/CD.pm:
+If for some reason the file is unreadable on your system, you can
+recreate it as follows:
- package DB::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');
+ cp -a <unpacked-DBIC-tarball>/examples/Schema dbicapp
+ cd dbicapp
+ rm db/example.db
+ sqlite3 db/example.db < db/example.sql
+ perl insertdb.pl
- 1;
+=head3 Testing the database
+Enter the example Schema directory
-DB/Main/Track.pm:
+ cd <unpacked-DBIC-tarball>/examples/Schema
- package DB::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');
+Run the script testdb.pl, which will test that the database has
+successfully been filled.
- 1;
-
-
-=head3 Write a script to insert some records.
-
-insertdb.pl
-
- #!/usr/bin/perl -w
-
- use DB::Main;
- use strict;
-
- my $schema = DB::Main->connect('dbi:SQLite:dbic_test.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 strict;
-
- my $schema = DB::Main->connect('dbi:mysql:cdtestdb', 'testuser', 'testpass');
-
- get_tracks_by_cd('Bad');
- get_tracks_by_artist('Michael Jackson');
-
- get_cd_by_track('Stan');
- get_cds_by_artist('Michael Jackson');
-
- get_artist_by_track('Dirty Diana');
- get_artist_by_cd('The Marshall Mathers LP');
-
-
- sub get_tracks_by_cd {
- my $cdtitle = shift;
- print "get_tracks_by_cd($cdtitle):\n";
- my $rs = $schema->resultset('Track')->search(
- {
- 'cd.title' => $cdtitle
- },
- {
- join => [qw/ cd /],
- prefetch => [qw/ cd /]
- }
- );
- while (my $track = $rs->next) {
- print $track->title . "\n";
- }
- print "\n";
- }
-
- sub get_tracks_by_artist {
- my $artistname = shift;
- print "get_tracks_by_artist($artistname):\n";
- my $rs = $schema->resultset('Track')->search(
- {
- 'artist.name' => $artistname
- },
- {
- join => {
- 'cd' => 'artist'
- },
- }
- );
- while (my $track = $rs->next) {
- print $track->title . "\n";
- }
- print "\n";
- }
-
-
-
- sub get_cd_by_track {
- my $tracktitle = shift;
- print "get_cd_by_track($tracktitle):\n";
- my $rs = $schema->resultset('CD')->search(
- {
- 'tracks.title' => $tracktitle
- },
- {
- join => [qw/ tracks /],
- }
- );
- my $cd = $rs->first;
- print $cd->title . "\n\n";
- }
-
- sub get_cds_by_artist {
- my $artistname = shift;
- print "get_cds_by_artist($artistname):\n";
- my $rs = $schema->resultset('CD')->search(
- {
- 'artist.name' => $artistname
- },
- {
- join => [qw/ artist /],
- prefetch => [qw/ artist /]
- }
- );
- while (my $cd = $rs->next) {
- print $cd->title . "\n";
- }
- print "\n";
- }
-
-
-
- sub get_artist_by_track {
- my $tracktitle = shift;
- print "get_artist_by_track($tracktitle):\n";
- my $rs = $schema->resultset('Artist')->search(
- {
- 'tracks.title' => $tracktitle
- },
- {
- join => {
- 'cds' => 'tracks'
- }
- }
- );
- my $artist = $rs->first;
- print $artist->name . "\n\n";
- }
-
- sub get_artist_by_cd {
- my $cdtitle = shift;
- print "get_artist_by_cd($cdtitle):\n";
- my $rs = $schema->resultset('Artist')->search(
- {
- 'cds.title' => $cdtitle
- },
- {
- join => [qw/ cds /],
- }
- );
- my $artist = $rs->first;
- print $artist->name . "\n\n";
- }
-
-
-
-It should output:
+When this script is run, it should output the following:
get_tracks_by_cd(Bad):
- Dirty Diana
- Smooth Criminal
Leave Me Alone
+ Smooth Criminal
+ Dirty Diana
get_tracks_by_artist(Michael Jackson):
- Beat it
- Billie Jean
- Dirty Diana
- Smooth Criminal
- Leave Me Alone
+ Billie Jean (from the CD 'Thriller')
+ Beat It (from the CD 'Thriller')
+ Leave Me Alone (from the CD 'Bad')
+ Smooth Criminal (from the CD 'Bad')
+ Dirty Diana (from the CD 'Bad')
get_cd_by_track(Stan):
- The Marshall Mathers LP
+ The Marshall Mathers LP has the track 'Stan'.
get_cds_by_artist(Michael Jackson):
Thriller
Bad
get_artist_by_track(Dirty Diana):
- Michael Jackson
+ Michael Jackson recorded the track 'Dirty Diana'.
get_artist_by_cd(The Marshall Mathers LP):
- Eminem
+ Eminem recorded the CD 'The Marshall Mathers LP'.
+
+
+=head3 Discussion about the results
+
+The data model defined in this example has an artist with multiple CDs,
+and a CD with multiple tracks; thus, it's simple to traverse from a
+track back to a CD, and from there back to an artist. This is
+demonstrated in the get_tracks_by_artist routine, where we easily walk
+from the individual track back to the title of the CD that the track
+came from ($track->cd->title).
-=head1 Notes
+Note also that in the get_tracks_by_cd and get_tracks_by_artist
+routines, the result set is called multiple times with the 'next'
+iterator. In contrast, get_cd_by_track uses the 'first' result set
+method, since only one CD is expected to have a specific track.
-With these scripts we're relying on @INC looking in the current
-working directory. You may want to add the DB namespaces to @INC in a
-different way when it comes to deployemnt.
+This example uses L<DBIx::Class::Schema/load_namespaces> to load in the
+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 did not add, nor needed
+any such classes in this example).
-The testdb.pl script is an excellent start for testing your database
-model.
+=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. Please credit yourself properly!
- Kieren Diment <kd@totaldatasolution.com>
+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
projects / dbsrgits/DBIx-Class.git / blobdiff