X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FManual%2FIntro.pod;h=11911e7b9092d5d01a5a06f5753dde84a384948a;hb=e532cb4b6bf15c76b2fb502132952276d3333b0d;hp=d4ee303fd07ab19168d9bf56353d429d5a4b7a7d;hpb=d53178fd413748460fe7ab2747602b42454eddad;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Manual/Intro.pod b/lib/DBIx/Class/Manual/Intro.pod index d4ee303..11911e7 100644 --- a/lib/DBIx/Class/Manual/Intro.pod +++ b/lib/DBIx/Class/Manual/Intro.pod @@ -13,14 +13,16 @@ better way? You've come to the right place. Here are a few simple tips that will help you get your bearings with 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 Ls. 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. 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) @@ -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 objects. + =head1 SETTING UP DBIx::Class Let's look at how you can set and use your first native L tree. @@ -79,30 +86,25 @@ L: 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: - - # load My::Schema::Album and My::Schema::Artist - __PACKAGE__->load_classes(qw/ Album Artist /); - -Or load classes by namespace: +will define later, using the load_namespaces() method: - # load My::Schema::Album, My::Schema::Artist and My::OtherSchema::LinerNotes - __PACKAGE__->load_classes( - { - 'My::Schema' => [qw/ Album Artist /], - 'My::OtherSchema' => [qw/ LinerNotes /] - } - ); + # load My::Schema::Result::* and their resultset classes + __PACKAGE__->load_namespaces(); -Or let your schema class load all classes in its namespace automatically: +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 call. - # load My::Schema::* - __PACKAGE__->load_classes(); +It is also possible to do the same things manually by calling +C 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. @@ -157,7 +159,7 @@ See L for details. See L 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 +176,7 @@ to describe a column which contains an ID of another Table, or C to make a predefined accessor for fetching objects that contain this Table's foreign key: - __PACKAGE__->has_many('albums', 'My::Schema::Artist', 'album_id'); + __PACKAGE__->has_many('albums', 'My::Schema::Result::Artist', 'album_id'); See L for more information about the various types of available relationships and how you can design your own. @@ -241,7 +243,7 @@ The simplest way to get a record is by primary key: my $album = $schema->resultset('Album')->find(14); This will run a C