Further improvement in the bind value column names in the SQL literal + bind examples.

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual / FAQ.pod

diff --git a/lib/DBIx/Class/Manual/FAQ.pod b/lib/DBIx/Class/Manual/FAQ.pod
index b21fd3a..4a5d7ba 100644 (file)
--- a/lib/DBIx/Class/Manual/FAQ.pod
+++ b/lib/DBIx/Class/Manual/FAQ.pod
@@ -247,12 +247,13 @@ documentation for details.
 
 To use an SQL function on the left hand side of a comparison:
 
- ->search({ -nest => \[ 'YEAR(date_of_birth) = ?', [ date_of_birth => 1979 ] ] });
+ ->search({ -nest => \[ 'YEAR(date_of_birth) = ?', [ plain_value => 1979 ] ] });
 
-Note: the C<date_of_birth> string in the C<< [ date_of_birth => 1979 ] >> part
-should be the same as the name of the column. It is used by L<DBIx::Class> to
-handle special column types. (If no column is involved in your expression, just
-invent a column name.)
+Note: the C<plain_value> string in the C<< [ plain_value => 1979 ] >> part
+should be either the same as the name of the column (do this if the type of the
+return value of the function is the same as the type of the column) or
+otherwise it's essentially a dummy string currently (use C<plain_value> as a
+habit). It is used by L<DBIx::Class> to handle special column types.
 
 Or, if you have quoting off: