added some doc to CCJSqlParserUtil

JSQLParser · Nov 13, 2019 · 5242a18 · 5242a18
1 parent 3cdea6b
commit 5242a18
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/main/java/net/sf/jsqlparser/parser/CCJSqlParserUtil.java b/src/main/java/net/sf/jsqlparser/parser/CCJSqlParserUtil.java
@@ -40,6 +40,20 @@ public static Statement parse(String sql) throws JSQLParserException {
         return parse(sql, null);
     }
 
+    /**
+     * Parses an sql statement while allowing via consumer to configure the used parser before.
+     * 
+     * For instance to activate SQLServer bracket quotation on could use:
+     * 
+     * {@code 
+     * CCJSqlParserUtil.parse("select * from [mytable]", parser -> parser.withSquareBracketQuotation(true));
+     * }
+     * 
+     * @param sql
+     * @param consumer
+     * @return
+     * @throws JSQLParserException 
+     */
     public static Statement parse(String sql, Consumer<CCJSqlParser> consumer) throws JSQLParserException {
         CCJSqlParser parser = new CCJSqlParser(new StringProvider(sql));
         if (consumer != null) {