From: Jonathan Yu <frequency@cpan.org>
Date: Fri, 9 Jan 2009 04:18:06 +0000 (+0000)
Subject: - Minor documentation changes. Namely, noted that the index types are stored internal... 
X-Git-Tag: v0.11008~261
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=19ad0ceea09ce162e4e9c1ae7c465e7989f04a26;p=dbsrgits%2FSQL-Translator.git

- Minor documentation changes. Namely, noted that the index types are stored internally as uppercase; this is the only way to ensure the Producer modules still work properly.
- Cosmetic change to avoid bareword 'NORMAL' for index types - simply surrounded the return value with single quotes
---

diff --git a/lib/SQL/Translator/Schema/Index.pm b/lib/SQL/Translator/Schema/Index.pm
index 6c75361..bf1010d 100644
--- a/lib/SQL/Translator/Schema/Index.pm
+++ b/lib/SQL/Translator/Schema/Index.pm
@@ -56,10 +56,10 @@ use vars qw($VERSION $TABLE_COUNT $VIEW_COUNT);
 $VERSION = sprintf "%d.%02d", q$Revision: 1.18 $ =~ /(\d+)\.(\d+)/;
 
 my %VALID_INDEX_TYPE = (
-    UNIQUE,    1,
-    NORMAL,    1,
-    FULL_TEXT, 1, # MySQL only (?)
-    SPATIAL,   1, # MySQL only (?)
+  UNIQUE         => 1,
+  NORMAL         => 1,
+  FULL_TEXT      => 1, # MySQL only (?)
+  SPATIAL        => 1, # MySQL only (?)
 );
 
 # ----------------------------------------------------------------------
@@ -221,17 +221,24 @@ Get or set the index's type.
 
   my $type = $index->type('unique');
 
+Get or set the index's options (e.g., "using" or "where" for PG).  Returns
+
+Currently there are only four acceptable types: UNIQUE, NORMAL, FULL_TEXT,
+and SPATIAL. The latter two might be MySQL-specific. While both lowercase
+and uppercase types are acceptable input, this method returns the type in
+uppercase.
+
 =cut
 
     my $self = shift;
 
-    if ( my $type = shift ) {
+    if ( my $type = uc shift ) {
         return $self->error("Invalid index type: $type") 
             unless $VALID_INDEX_TYPE{ $type };
         $self->{'type'} = $type;
     }
 
-    return $self->{'type'} || NORMAL;
+    return $self->{'type'} || 'NORMAL';
 }
 
 # ----------------------------------------------------------------------