Changeset 491

Timestamp:

06/10/08 00:17:20 (5 months ago)

Author:

sekimura

Message:

added a doc for add_index_hint()

Files:

• trunk/lib/Data/ObjectDriver/SQL.pm (modified) (1 diff)

trunk/lib/Data/ObjectDriver/SQL.pm

@@ -568 +568 @@
-be any of the structures described above for the C<add_where()> method.
-
+=head2 C<$sql-E<gt>add_index_hint($table, \@hints)>
+
+Addes the index hint into a C<SELECT> query. The structure for the set of 
+C<\@hints> are arrayref of hashrefs containing these members:
+
+=over 4
+
+=item * C<type> (scalar)
+
+The name of the type. "USE", "IGNORE or "FORCE".
+
+=item * C<list> (arrayref)
+
+The list of name of indexes which to use.
+
+=back
+
-=head2 C<$sql-E<gt>as_sql()>
-