Merge 'trunk' into 'DBIx-Class-current'
Ash Berlin [Tue, 23 May 2006 13:36:07 +0000 (06:36 -0700)]
r1762@moss (orig r1761):  ash | 2006-05-23 08:36:07 -0700
Added docs for quote_char, name_sep and offset RS attrib.

1  2 
lib/DBIx/Class/ResultSet.pm
lib/DBIx/Class/Storage/DBI.pm

Simple merge
@@@ -297,10 -283,28 +297,28 @@@ C<quote_char>, and C<name_sep>.  Exampl
  
  Executes the sql statements given as a listref on every db connect.
  
+ =head2 quote_char
+ Specifies what characters to use to quote table and column names. If 
+ you use this you will want to specify L<name_sep> as well.
+ quote_char expectes either a single character, in which case is it is placed
+ on either side of the table/column, or an array of length 2 in which case the
+ table/column name is placed between the elements.
+ For example under MySQL you'd use C<quote_char('`')>, and user SQL Server you'd 
+ use C<quote_char(qw/[ ]/)>.
+ =head2 name_sep
+ This only needs to be used in conjunction with L<quote_char>, and is used to 
+ specify the charecter that seperates elements (schemas, tables, columns) from 
+ each other. In most cases this is simply a C<.>.
  =head2 debug
  
 -Causes SQL trace information to be emitted on C<debugfh> filehandle
 -(or C<STDERR> if C<debugfh> has not specifically been set).
 +Causes SQL trace information to be emitted on the C<debugobj> object.
 +(or C<STDERR> if C<debugobj> has not specifically been set).
  
  =head2 debugfh