X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FManual%2FIntro.pod;h=dd37d0e8d3eb8f0d20d0b37e9fcb1086300dd08a;hb=bbd107cf7ae1e53547ce63b710716d88adb73013;hp=974efe5c226290b6ef98116ef60d217e7bc53bb5;hpb=11736b4c186bbc10c80f13fdb1eca80b1ff75711;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/Manual/Intro.pod b/lib/DBIx/Class/Manual/Intro.pod
index 974efe5..dd37d0e 100644
--- a/lib/DBIx/Class/Manual/Intro.pod
+++ b/lib/DBIx/Class/Manual/Intro.pod
@@ -11,23 +11,25 @@ better way?  You've come to the right place.
 =head1 THE DBIx::Class WAY
 
 Here are a few simple tips that will help you get your bearings with
-DBIx::Class.  
+DBIx::Class.
 
-=head2 Tables become ResultSources
+=head2 Tables become Result classes
 
-DBIx::Class needs to know what your Table structure looks like.  You do that by
-defining L<DBIx::Class::ResultSource>s.  Each table gets a ResultSource, which
-defines the Columns it has, along with any Relationships it has to other tables.
-(And oh, so much more besides)  The important thing to understand:
+DBIx::Class needs to know what your Table structure looks like.  You
+do that by defining Result classes. Result classes are defined by
+calling methods proxied to L<DBIx::Class::ResultSource>.  Each Result
+class defines one Table, which defines the Columns it has, along with
+any Relationships it has to other tables.  (And oh, so much more
+besides) The important thing to understand:
 
-  A ResultSource == Table
+  A Result class == Table
 
 (most of the time, but just bear with my simplification)
 
 =head2 It's all about the ResultSet
 
 So, we've got some ResultSources defined.  Now, we want to actually use those
-definitions to help us translate the queries we need into handy perl objects!  
+definitions to help us translate the queries we need into handy perl objects!
 
 Let's say we defined a ResultSource for an "album" table with three columns:
 "albumid", "artist", and "title".  Any time we want to query this table, we'll
@@ -37,18 +39,18 @@ results of:
   SELECT albumid, artist, title FROM album;
 
 Would be retrieved by creating a ResultSet object from the album table's
-ResultSource, likely by using the "search" method.  
+ResultSource, likely by using the "search" method.
 
 DBIx::Class doesn't limit you to creating only simple ResultSets -- if you
 wanted to do something like:
 
   SELECT title FROM album GROUP BY title;
 
-You could easily achieve it. 
+You could easily achieve it.
 
-The important thing to understand: 
+The important thing to understand:
 
-  Any time you would reach for a SQL query in DBI, you are 
+  Any time you would reach for a SQL query in DBI, you are
   creating a DBIx::Class::ResultSet.
 
 =head2 Search is like "prepare"
@@ -62,6 +64,11 @@ The important thing to understand:
   Setting up a ResultSet does not execute the query; retrieving
   the data does.
 
+=head2 Search results are returned as Rows
+
+Rows of the search from the database are blessed into
+L<DBIx::Class::Row> objects.
+
 =head1 SETTING UP DBIx::Class
 
 Let's look at how you can set and use your first native L<DBIx::Class> tree.
@@ -79,40 +86,32 @@ L<DBIx::Class::Schema>:
   use base qw/DBIx::Class::Schema/;
 
 In this class you load your result_source ("table", "model") classes, which we
-will define later, using the load_classes() method. You can specify which
-classes to load manually: 
+will define later, using the load_namespaces() method:
 
-  # load My::Schema::Album and My::Schema::Artist
-  __PACKAGE__->load_classes(qw/ Album Artist /);
+  # load My::Schema::Result::* and their resultset classes
+  __PACKAGE__->load_namespaces();
 
-Or load classes by namespace:
+By default this loads all the Result (Row) classes in the
+My::Schema::Result:: namespace, and also any resultset classes in the
+My::Schema::ResultSet:: namespace (if missing, the resultsets are
+defaulted to be DBIx::Class::ResultSet objects). You can change the
+result and resultset namespaces by using options to the
+L<DBIx::Class::Schema/load_namespaces> call.
 
-  # load My::Schema::Album, My::Schema::Artist and My::OtherSchema::LinerNotes
-  __PACKAGE__->load_classes(
-    {
-      'My::Schema' => [qw/ Album Artist /],
-      'My::OtherSchema' => [qw/ LinerNotes /]
-    }
-  );
-
-Or let your schema class load all classes in its namespace automatically:
-
-   # load My::Schema::*
-  __PACKAGE__->load_classes();
+It is also possible to do the same things manually by calling
+C<load_classes> for the Row classes and defining in those classes any
+required resultset classes.
 
 Next, create each of the classes you want to load as specified above:
 
-  package My::Schema::Album;
+  package My::Schema::Result::Album;
   use base qw/DBIx::Class/;
 
 Load any components required by each class with the load_components() method.
 This should consist of "Core" plus any additional components you want to use.
-For example, if you want serial/auto-incrementing primary keys:
-
-  __PACKAGE__->load_components(qw/ PK::Auto Core /);
+For example, if you want to force columns to use UTF-8 encoding:
 
-C<PK::Auto> is supported for many databases; see L<DBIx::Class::Storage::DBI>
-for more information.
+  __PACKAGE__->load_components(qw/ ForceUTF8 Core /);
 
 Set the table for your class:
 
@@ -140,7 +139,7 @@ of information that it may be useful to have -- just pass C<add_columns> a hash:
                               is_auto_increment => 0,
                               default_value => '',
                             },
-                          title  => 
+                          title  =>
                             { data_type => 'varchar',
                               size      => 256,
                               is_nullable => 0,
@@ -157,7 +156,7 @@ See L<SQL::Translator> for details.
 See L<DBIx::Class::ResultSource> for more details of the possible column
 attributes.
 
-Accessors are created for each column automatically, so My::Schema::Album will
+Accessors are created for each column automatically, so My::Schema::Result::Album will
 have albumid() (or album(), when using the accessor), artist() and title()
 methods.
 
@@ -174,7 +173,8 @@ to describe a column which contains an ID of another Table, or C<has_many> to
 make a predefined accessor for fetching objects that contain this Table's
 foreign key:
 
-  __PACKAGE__->has_many('albums', 'My::Schema::Artist', 'album_id');
+  # in My::Schema::Result::Artist
+  __PACKAGE__->has_many('albums', 'My::Schema::Result::Album', 'artist');
 
 See L<DBIx::Class::Relationship> for more information about the various types of
 available relationships and how you can design your own.
@@ -241,7 +241,7 @@ The simplest way to get a record is by primary key:
   my $album = $schema->resultset('Album')->find(14);
 
 This will run a C<SELECT> with C<albumid = 14> in the C<WHERE> clause, and
-return an instance of C<My::Schema::Album> that represents this row.  Once you
+return an instance of C<My::Schema::Result::Album> that represents this row.  Once you
 have that row, you can access and update columns:
 
   $album->title('Physical Graffiti');
@@ -268,10 +268,10 @@ your object.
 =head2 Adding and removing rows
 
 To create a new record in the database, you can use the C<create> method.  It
-returns an instance of C<My::Schema::Album> that can be used to access the data
+returns an instance of C<My::Schema::Result::Album> that can be used to access the data
 in the new record:
 
-  my $new_album = $schema->resultset('Album')->create({ 
+  my $new_album = $schema->resultset('Album')->create({
     title  => 'Wish You Were Here',
     artist => 'Pink Floyd'
   });
@@ -377,11 +377,9 @@ L<DBIx::Class::ResultSet/ATTRIBUTES>.
 
 =head2 Problems on RHEL5/CentOS5
 
-There is a problem with slow performance of certain DBIx::Class operations in
-perl-5.8.8-10 and later on RedHat and related systems, due to a bad backport of
-a "use overload" related bug.  The problem is in the Perl binary itself, not in
-DBIx::Class.  If your system has this problem, you will see a warning on
-startup, with some options as to what to do about it.
+There used to be an issue with the system perl on Red Hat Enterprise
+Linux 5, some versions of Fedora and derived systems. Further
+information on this can be found in L<DBIx::Class::Manual::Troubleshooting>
 
 =head1 SEE ALSO