X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FManual%2FIntro.pod;h=5c7f7e5809c9d76dd87d012f510472681b614198;hb=5f550837848772810f7ebe6067e1e50150560d39;hp=8e4b7fdb3b88df561ab41066a8ca0409262536db;hpb=d6988be8c653765a1a5dcf988a2e539029584450;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Manual/Intro.pod b/lib/DBIx/Class/Manual/Intro.pod index 8e4b7fd..5c7f7e5 100644 --- a/lib/DBIx/Class/Manual/Intro.pod +++ b/lib/DBIx/Class/Manual/Intro.pod @@ -74,7 +74,8 @@ L objects. Let's look at how you can set and use your first native L tree. First we'll see how you can set up your classes yourself. If you want them to -be auto-discovered, just skip to the next section, which shows you how to use +be auto-discovered, just skip to the L, which shows you how to use L. =head2 Setting it up manually @@ -114,6 +115,10 @@ automatic row ordering: __PACKAGE__->load_components(qw/ Ordered /); __PACKAGE__->position_column('rank'); +Ordered will refer to a field called 'position' unless otherwise directed. Here you are defining +the ordering field to be named 'rank'. (NOTE: Insert errors may occur if you use the Ordered +component, but have not defined a position column or have a 'position' field in your row.) + Set the table for your class: __PACKAGE__->table('album'); @@ -131,34 +136,29 @@ of information that it may be useful to have -- just pass C a hash: size => 16, is_nullable => 0, is_auto_increment => 1, - default_value => '', }, artist => { data_type => 'integer', size => 16, is_nullable => 0, - is_auto_increment => 0, - default_value => '', }, title => { data_type => 'varchar', size => 256, is_nullable => 0, - is_auto_increment => 0, - default_value => '', }, rank => { data_type => 'integer', size => 16, is_nullable => 0, - is_auto_increment => 0, - default_value => '', + default_value => 0, } ); DBIx::Class doesn't directly use most of this data yet, but various related -modules such as L make use of it. Also it allows you to -create your database tables from your Schema, instead of the other way around. +modules such as L make use of it. +Also it allows you to create your database tables from your Schema, +instead of the other way around. See L for details. See L for more details of the possible column @@ -187,24 +187,37 @@ foreign key: See L for more information about the various types of available relationships and how you can design your own. -=head2 Using L +=head2 Using DBIx::Class::Schema::Loader -This is an external module, and not part of the L distribution. -Like L, it inspects your database, and automatically creates -classes for all the tables in your database. Here's a simple setup: +This module (L) is an external module, and not part +of the L distribution. It inspects your database, and automatically +creates classes for all the tables in your schema. - package My::Schema; - use base qw/DBIx::Class::Schema::Loader/; +The simplest way to use it is via the L script from the +L distribution. For example: + + $ dbicdump -o dump_directory=./lib \ + -o components='["InflateColumn::DateTime"]' \ + MyApp::Schema dbi:mysql:mydb user pass + +If you have a mixed-case database, use the C option, e.g.: + + $ dbicdump -o dump_directory=./lib -o preserve_case=1 \ + -o components='["InflateColumn::DateTime"]' \ + MyApp::Schema dbi:mysql:mydb user pass - __PACKAGE__->loader_options( relationships => 1 ); +If you are using L, then you can use the helper that comes with +L: - 1; + $ script/myapp_create.pl model MyDB DBIC::Schema MyDB::Schema \ + create=static moniker_map='{ foo => "FOO" }' dbi:SQLite:./myapp.db \ + on_connect_do='PRAGMA foreign_keys=ON' quote_char='"' -The actual autoloading process will occur when you create a connected instance -of your schema below. +See L for more information on this +helper. -See the L documentation for more information on its -many options. +See the L and L +documentation for more information on the many loader options. =head2 Connecting @@ -225,7 +238,7 @@ second database you want to access: Note that L does not cache connections for you. If you use multiple connections, you need to do this manually. -To execute some sql statements on every connect you can add them as an option in +To execute some SQL statements on every connect you can add them as an option in a special fifth argument to connect: my $another_schema = My::Schema->connect( @@ -236,7 +249,7 @@ a special fifth argument to connect: { on_connect_do => \@on_connect_sql_statments } ); -See L for more information about +See L for more information about this and other special C-time options. =head3 Via a database handle