X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FManual%2FIntro.pod;h=556c5527c142735d6e3cd891b0a8974c45071ce1;hb=85b9b27201051777f5deb7c18119541e7f558beb;hp=10cb50e7836937fa1ac5f00a017caacd419a9e63;hpb=429bd4f15b0ea80aef96873a9db11801538eb3ee;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/lib/DBIx/Class/Manual/Intro.pod b/lib/DBIx/Class/Manual/Intro.pod
index 10cb50e..556c552 100644
--- a/lib/DBIx/Class/Manual/Intro.pod
+++ b/lib/DBIx/Class/Manual/Intro.pod
@@ -1,3 +1,7 @@
+=head1 NAME
+
+DBIx::Class::Manual::Intro - Introduction to DBIx::Class
+
 =head1 Introduction.
 
 So, you are bored with SQL, and want a native perl interface for your classes?
@@ -26,9 +30,11 @@ mostly useful if you want to use multiple database connections.
   __PACKAGE__->load_components(qw/Core DB/);
 
 If you want serial/auto-incremental primary keys, you'll need to add
-the apropriate component for your db as well, for example
+the apropriate component for your db as well, for example. The 
+PK::Auto::* modules help L<DBIx::Class> keep up with newly generated
+keys in auto increment database fields.
 
-  __PACKAGE__->load_components(qw/Core DB PK::Auto::SQLite/);
+  __PACKAGE__->load_components(qw/PK::Auto::SQLite Core DB/);
 
 Once you've loaded the components, it's time to  set up your connection:
 
@@ -39,24 +45,24 @@ attribute hash as well as the dsn.
 
 With that out of the way, we can define our first table class:
 
-  package MyApp::DB::Frob
+  package MyApp::DB::Album;
 
   use base qw/MyApp::DB/;
 
 Then we specify which table it uses,
 
-  __PACKAGE__->table('frob');
+  __PACKAGE__->table('album');
 
 and specify which columns it has.
 
-  __PACKAGE__->add_columns(qw/id foo bar/);
+  __PACKAGE__->add_columns(qw/albumID artist title label year/);
 
 This will automatically create accessors for each of the columns, so that
 you can read/update the values in rows you've retrieved.
 
 Also, you need to tell it which column is the primary key:
 
-  __PACKAGE__->set_primary_key('id');
+  __PACKAGE__->set_primary_key('albumID');
 
 If you have multiple primary keys, just pass a list instead.
 
@@ -74,9 +80,9 @@ creates classes for all the tables in your database. Here's a simple setup:
   
   use DBIx::Class::Loader;
 
-  my $loader=DBIx::Class::Loader->new(
-      dsn       => 'dbi:SQLite:/home/me/myapp/my.db',
-      namespace => 'MyApp::DB');
+  my $loader = DBIx::Class::Loader->new(
+	  dsn	   => 'dbi:SQLite:/home/me/myapp/my.db',
+	  namespace => 'MyApp::DB');
   1;
 
 This should be equivalent to the manual in the section above. 
@@ -88,14 +94,15 @@ consult the reference documentation.
 Once you've defined the basic classes, you can start interacting with your
 database. The simplest way to get a column is by primary key:
 
-  my $frob=MyApp::DB::Frob->find(14);
+  $albumID = 14;
+  $album = MyApp::DB::Album->find($albumID); 
 
-This will run a select with id=14 in the WHERE clause, and return an instance 
-of MyApp::DB::Frob that represents this row. Once you have that row, you can
+This will run a select with albumID=14 in the WHERE clause, and return an instance 
+of MyApp::DB::Artist that represents this row. Once you have that row, you can
 access and update columns 
 
-    my $val=$frob->bar;
-    $frob->bar(14);
+  $album->title('Physical Graffiti');
+  $title = $album->title;   # $title holds 'Physical Graffiti'
 
 or if you prefer, you can use the set_column/get_column accessors instead
 of the autogenerated accessors based on your column names.
@@ -103,64 +110,73 @@ of the autogenerated accessors based on your column names.
 Just like with L<Class::DBI>, you do an 'update' to commit your changes
 to the database:
 
-   $frob->update;
+  $album->update;
 
 If needed, you can drop your local changes instead like this:
 
-  $frob->discard_changes if $frob->is_changed;
+  $album->discard_changes if $album->is_changed;
 
 As you can see, is_changed allows you to check if there are local changes to 
 your object.
 
 =head2 Adding and removing rows.
 
-To make a new row, and put it into the database, you can use the 'create' 
-method from L<DBIx::Class::Row>
+To create a new record in the database, you can use the 'create' 
+method from L<DBIx::Class::Row>.  It returns a L<DBIx::Class::ResultSet>
+object that can be used to access the data in the new record.
+
+  $new_album = MyApp::DB::Album->create({ 
+		title => 'Wish You Were Here',
+		artist => 'Pink Floyd'
+  });
+
+Now you can add data to the new record:
 
-  my $new_thingie=MyApp::DB::Frob->create({
-    foo=>'homer',
-    bar=>'bart' });
+  $new_album->label('Capitol');
+  $new_album->year('1975');
 
 likewise, you can remove if from the database like this:
 
-  $new_thingie->delete();
+  $new_album->delete();
 
 or even without retrieving first. This operation takes the same kind of 
 arguments as a search.
 
-  MyApp::DB::Frob->delete({foo=>'bart'});
+  MyApp::DB::Album->delete({ artist => 'Falco' });
 
 =head2 Finding your objects.
 
 DBIx::Class provides a few different ways to retrieve data from your database.
 The simplest looks something like this:
 
-  $rs=MyApp::DB::Frob->search(foo=>'bart');
+  $album = MyApp::DB::Album->search( artist => 'Santana' );
 
-note that all the search methods return a recordset in scalar context or
-a list containing all the elements in list context.
+note that all the search methods return a L<DBIx::Class::ResultSet> object
+in scalar context or a list containing all the records in list context. 
 
-We also provide a handy shortcut for doing a like search:
+We also provide a handy shortcut for doing a "like" search:
 
-  $rs=MyApp::DB::Frob->search_like(foo=>'bar%');
+  $album = MyApp::DB::Album->search_like( artist => 'Jimi%');
 
 Or you can provide your own handmade WHERE clause, like
   
-  $rs=MyApp::DB::Frob->search_literal('foo=?','bart');
+  $album = MyApp::DB::Album->search_literal('artist=?','Peter Frampton');
 
 The other way to provide more complex queries, is to provide a
 L<SQL::Abstract> construct to search:
 
-  $rs=MyApp::DB::Frob->search({
-    bar=>{'>' => 10 },
-    foo=>{'!=','bart'},
-    id => [1,14,15,65,43]
+  $album = MyApp::DB::Album->search({
+	artist => { '!=', 'Janis Joplin' },
+	year => { '<' => 1980 },
+	id => [ 1, 14, 15, 65, 43 ]
   });
 
 The search can also be modifyed by passing another hash with attributes:
 
-  $rs=MyApp::DB::Frob->search( {foo=>'bart'},
-      { page=>1, rows=>2, order_by=>'bar' } ); 
+  $album = MyApp::DB::Album->search( 
+		{ artist => 'Bob Marley' },
+		{ page => 1, rows => 2, order_by => 'year' } 
+  ); 
 
 For a complete overview over the available attributes, see
 L<DBIx::Class::ResultSet>