use proper bullet list in Dialect javadoc

This is Javadoc, not a comment, so I should have
formatted it properly when I originally wrote this.
This commit is contained in:
Gavin King 2020-09-04 08:02:49 +02:00 committed by Christian Beikov
parent 34cb6d50d9
commit 377ca5c073
1 changed files with 89 additions and 61 deletions

View File

@ -270,89 +270,117 @@ public abstract class Dialect implements ConversionContext {
* These required functions include the functions defined by the JPA * These required functions include the functions defined by the JPA
* query language specification: * query language specification:
* *
* * avg(arg) - aggregate function * <ul>
* * count([distinct ]arg) - aggregate function * <li> avg(arg) - aggregate function
* * max(arg) - aggregate function * <li> count([distinct ]arg) - aggregate function
* * min(arg) - aggregate function * <li> max(arg) - aggregate function
* * sum(arg) - aggregate function * <li> min(arg) - aggregate function
* <li> sum(arg) - aggregate function
* </ul>
* *
* * coalesce(arg0, arg1, ...) * <ul>
* * nullif(arg0, arg1) * <li> coalesce(arg0, arg1, ...)
* <li> nullif(arg0, arg1)
* </ul>
* *
* * lower(arg) * <ul>
* * upper(arg) * <li> lower(arg)
* * length(arg) * <li> upper(arg)
* * concat(arg0, arg1, ...) * <li> length(arg)
* * locate(pattern, string[, start]) * <li> concat(arg0, arg1, ...)
* * substring(string, start[, length]) * <li> locate(pattern, string[, start])
* * trim([[spec ][character ]from] string) * <li> substring(string, start[, length])
* <li> trim([[spec ][character ]from] string)
* </ul>
* *
* * abs(arg) * <ul>
* * mod(arg0, arg1) * <li> abs(arg)
* * sqrt(arg) * <li> mod(arg0, arg1)
* <li> sqrt(arg)
* </ul>
* *
* * current date * <ul>
* * current time * <li> current date
* * current timestamp * <li> current time
* <li> current timestamp
* </ul>
* *
* Along with an additional set of functions defined by ANSI SQL: * Along with an additional set of functions defined by ANSI SQL:
* *
* * any(arg) - aggregate function * <ul>
* * every(arg) - aggregate function * <li> any(arg) - aggregate function
* <li> every(arg) - aggregate function
* </ul>
* *
* * cast(arg as Type) * <ul>
* * extract(field from arg) * <li> cast(arg as Type)
* <li> extract(field from arg)
* </ul>
* *
* * ln(arg) * <ul>
* * exp(arg) * <li> ln(arg)
* * power(arg0, arg1) * <li> exp(arg)
* * floor(arg) * <li> power(arg0, arg1)
* * ceiling(arg) * <li> floor(arg)
* <li> ceiling(arg)
* </ul>
* *
* * position(pattern in string) * <ul>
* * substring(string from start[ for length]) * <li> position(pattern in string)
* * overlay(string placing replacement from start[ for length]) * <li> substring(string from start[ for length])
* <li> overlay(string placing replacement from start[ for length])
* </ul>
* *
* And the following functions for working with java.time types: * And the following functions for working with java.time types:
* *
* * local date * <ul>
* * local time * <li> local date
* * local datetime * <li> local time
* * offset datetime * <li> local datetime
* * instant * <li> offset datetime
* <li> instant
* </ul>
* *
* And a number of additional "standard" functions: * And a number of additional "standard" functions:
* *
* * left(string, length) * <ul>
* * right(string, length) * <li> left(string, length)
* * replace(string, pattern, replacement) * <li> right(string, length)
* * pad(string with length spec[ character]) * <li> replace(string, pattern, replacement)
* <li> pad(string with length spec[ character])
* </ul>
* *
* * sign(arg) * <ul>
* * sin(arg) * <li> sign(arg)
* * cos(arg) * <li> sin(arg)
* * tan(arg) * <li> cos(arg)
* * asin(arg) * <li> tan(arg)
* * acos(arg) * <li> asin(arg)
* * atan(arg) * <li> acos(arg)
* * atan2(arg0, arg1) * <li> atan(arg)
* * round(arg0, arg1) * <li> atan2(arg0, arg1)
* * least(arg0, arg1, ...) * <li> round(arg0, arg1)
* * greatest(arg0, arg1, ...) * <li> least(arg0, arg1, ...)
* <li> greatest(arg0, arg1, ...)
* </ul>
* *
* * format(datetime as pattern) * <ul>
* * str(arg) - synonym of cast(a as String) * <li> format(datetime as pattern)
* * ifnull(arg0, arg1) - synonym of coalesce(a, b) * <li> str(arg) - synonym of cast(a as String)
* <li> ifnull(arg0, arg1) - synonym of coalesce(a, b)
* </ul>
* *
* Finally, the following functions are defined as abbreviations * Finally, the following functions are defined as abbreviations
* for extract(), and desugared by the parser: * for extract(), and desugared by the parser:
* *
* * second(arg) - synonym of extract(second from a) * <ul>
* * minute(arg) - synonym of extract(minute from a) * <li> second(arg) - synonym of extract(second from a)
* * hour(arg) - synonym of extract(hour from a) * <li> minute(arg) - synonym of extract(minute from a)
* * day(arg) - synonym of extract(day from a) * <li> hour(arg) - synonym of extract(hour from a)
* * month(arg) - synonym of extract(month from a) * <li> day(arg) - synonym of extract(day from a)
* * year(arg) - synonym of extract(year from a) * <li> month(arg) - synonym of extract(month from a)
* <li> year(arg) - synonym of extract(year from a)
* </ul>
* *
*/ */
public void initializeFunctionRegistry(QueryEngine queryEngine) { public void initializeFunctionRegistry(QueryEngine queryEngine) {