docs: add documentation about second argument to escapeId

dougwilson · dougwilson · commit 1056978bccea · 2016-10-06T23:58:10.000-04:00
diff --git a/README.md b/README.md
@@ -96,13 +96,24 @@ provided by a user, you should escape it with `SqlString.escapeId(identifier)` l
 ```js
 var sorter = 'date';
 var sql    = 'SELECT * FROM posts ORDER BY ' + SqlString.escapeId(sorter);
+// -> SELECT * FROM posts ORDER BY `date`
 ```
 
 It also supports adding qualified identifiers. It will escape both parts.
 
 ```js
 var sorter = 'date';
 var sql    = 'SELECT * FROM posts ORDER BY ' + SqlString.escapeId('posts.' + sorter);
+// -> SELECT * FROM posts ORDER BY `posts`.`date`
+```
+
+If you do not want to treat `.` as qualified identifiers, you can set the second
+argument to `true` in order to keep the string as a literal identifier:
+
+```js
+var sorter = 'date.2';
+var sql    = 'SELECT * FROM posts ORDER BY ' + connection.escapeId(sorter, true);
+// -> SELECT * FROM posts ORDER BY `date.2`
 ```
 
 Alternatively, you can use `??` characters as placeholders for identifiers you would
