SqlDialect (JavaDocs for mmm-all dev-SNAPSHOT)

All Known Implementing Classes:

DefaultSqlDialect, JpqlDialect, OrientDbDialect, UnquotedJpqlDialect
```
public interface SqlDialect
```
This is the interface for an SQL dialect.

Since:

8.0.0

Author:

hohwille

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default String`	`alias(EntityAlias<?> alias, boolean space)`
`default String`	`and()`
`default String`	`as()`
`default String`	`as(EntityAlias<?> alias, boolean space)`
`default Object`	`assignment()`
`default String`	`conjuction(Conjunction conjunction)`
`default String`	`countAll(EntityAlias<?> alias)`
`default String`	`delete()`
`default String`	`deleteFrom()`
`default String`	`distinct()`
`default String`	`empty()`
`default String`	`endConjunction(Conjunction conjunction)`
`default String`	`endExpression()`
`default String`	`escape()`
`default String`	`escape(char escape)`
`default String`	`fetch()`
`default String`	`forUpdate()`
`default String`	`from()`
`default String`	`groupBy()`
`default String`	`having()`
`default String`	`in()`
`default String`	`innerJoin()`
`default String`	`insert()`
`default String`	`insertInto()`
`default String`	`into()`
`default String`	`is()`
`default String`	`isEmpty()`
`default String`	`isNotEmpty()`
`default String`	`isNotNull()`
`default String`	`isNull()`
`default String`	`join()`
`default String`	`leftJoin()`
`default String`	`leftOuterJoin()`
`default String`	`let()`
`default String`	`like()`
`default String`	`limit()`
`default String`	`literalFalse()`
`default String`	`literalNull()`
`default String`	`literalTrue()`
`default String`	`not()`
`default String`	`offset()`
`default String`	`operator(SqlOperator<?,?> operator)`
`default String`	`or()`
`default Object`	`order(SortOrder order)`
`default String`	`orderBy()`
`default String`	`parameter(int index)`
`default String`	`parameter(String name)`
`default String`	`property(ReadableProperty<?> property)`
`default String`	`quoteReference()`
`default String`	`ref(String reference)`
`default String`	`select()`
`default String`	`selectCountAll(EntityAlias<?> alias)`
`default String`	`selectDistinct()`
`default String`	`separator()`
`default String`	`set()`
`default String`	`startConjunction(Conjunction conjunction)`
`default String`	`startExpression()`
`default String`	`update()`
`default String`	`upsert()`
`default String`	`variable(Variable<?> variable)`
`default String`	`where()`

- Method Detail
  - select
```
default String select()
```
    Returns:
    
    the SELECT statement keyword.
  - selectDistinct
```
default String selectDistinct()
```
    Returns:
    
    select() #distinct() (as supported by dialect or regular select).
  - selectCountAll
```
default String selectCountAll(EntityAlias<?> alias)
```
    Parameters:
    
    alias - the EntityAlias.
    
    Returns:
    
    select() countAll(EntityAlias).
  - countAll
```
default String countAll(EntityAlias<?> alias)
```
    Parameters:
    
    alias - the EntityAlias.
    
    Returns:
    
    the COUNT(*) selector.
  - insertInto
```
default String insertInto()
```
    Returns:
    
    insert() into().
  - insert
```
default String insert()
```
    Returns:
    
    the INSERT statement keyword.
  - into
```
default String into()
```
    Returns:
    
    the INTO keyword.
  - update
```
default String update()
```
    Returns:
    
    the UPDATE statement keyword.
  - delete
```
default String delete()
```
    Returns:
    
    the DELETE statement keyword.
  - deleteFrom
```
default String deleteFrom()
```
    Returns:
    
    delete() from().
  - from
```
default String from()
```
    Returns:
    
    the FROM selector keyword.
  - as
```
default String as()
```
    Returns:
    
    the AS keyword to define an alias for a FROM source.
    
    See Also:
    
    as(EntityAlias, boolean)
  - as
```
default String as(EntityAlias<?> alias,
                  boolean space)
```
    Parameters:
    
    alias - the EntityAlias.
    
    space - true if a space should be appended at the end of the alias, false otherwise.
    
    Returns:
    
    as() alias.name.
  - alias
```
default String alias(EntityAlias<?> alias,
                     boolean space)
```
    Parameters:
    
    alias - the EntityAlias.
    
    space - true if a space should be appended at the end of the alias, false otherwise.
    
    Returns:
    
    the EntityAlias.getName(). In case EntityAlias.getName() is null according to the dialect either the empty string or the source is used as fallback.
  - upsert
```
default String upsert()
               throws UnsupportedOperationException
```
    Returns:
    
    the UPSERT keyword.
    
    Throws:
    
    UnsupportedOperationException - if not supported by this dialect.
    
    See Also:
    
    FeatureUpsert
  - distinct
```
default String distinct()
```
    Returns:
    
    the DISTINCT keyword.
  - where
```
default String where()
```
    Returns:
    
    the WHERE clause keyword.
  - orderBy
```
default String orderBy()
```
    Returns:
    
    the ORDER BY clause keyword.
  - groupBy
```
default String groupBy()
```
    Returns:
    
    the GROUP BY clause keyword.
  - having
```
default String having()
```
    Returns:
    
    the HAVING clause keyword.
  - forUpdate
```
default String forUpdate()
```
    Returns:
    
    the FOR UPDATE keyword.
  - set
```
default String set()
```
    Returns:
    
    the SET keyword.
  - let
```
default String let()
```
    Returns:
    
    the LET keyword.
  - assignment
```
default Object assignment()
```
    Returns:
    
    the assignment of a SET or LET expression.
  - like
```
default String like()
```
    Returns:
    
    the LIKE condition keyword to match a pattern.
  - not
```
default String not()
```
    Returns:
    
    the NOT keyword to negate expressions or conditions.
  - is
```
default String is()
```
    Returns:
    
    the IS condition keyword.
  - isNull
```
default String isNull()
```
    Returns:
    
    the IS NULL condition.
  - isNotNull
```
default String isNotNull()
```
    Returns:
    
    the IS NOT NULL condition.
  - isEmpty
```
default String isEmpty()
```
    Returns:
    
    the IS EMPTY condition.
  - isNotEmpty
```
default String isNotEmpty()
```
    Returns:
    
    the IS NOT EMPTY condition.
  - escape
```
default String escape()
```
    Returns:
    
    the ESCAPE keyword to supply an escape character for like() expressions. Will be the empty String if NOT support via this SqlDialect (maybe only via query metadata).
  - escape
```
default String escape(char escape)
```
    Parameters:
    
    escape - the character to escape like() wildcards such as '%' and '_'.
    
    Returns:
    
    the ESCAPE clause to supply an escape character for like() expressions. Will be the empty String if NOT support via this SqlDialect (maybe only via query metadata).
  - limit
```
default String limit()
```
    Returns:
    
    the LIMIT keyword to supply the maximum number of results. Will be the empty String if NOT supported via this SqlDialect (maybe only via query metadata).
  - offset
```
default String offset()
```
    Returns:
    
    the OFFSET (or SKIP) keyword to supply an offset. Will be the empty String if NOT support via SQL (maybe only via query metadata).
  - empty
```
default String empty()
```
    Returns:
    
    the EMPTY condition keyword.
  - in
```
default String in()
```
    Returns:
    
    the IN expression keyword.
  - literalTrue
```
default String literalTrue()
```
    Returns:
    
    the SQL literal for Boolean.TRUE.
  - literalFalse
```
default String literalFalse()
```
    Returns:
    
    the SQL literal for Boolean.FALSE.
  - literalNull
```
default String literalNull()
```
    Returns:
    
    the SQL literal for null.
  - and
```
default String and()
```
    Returns:
    
    the SQL keyword for logical AND.
  - or
```
default String or()
```
    Returns:
    
    the SQL keyword for logical OR.
  - quoteReference
```
default String quoteReference()
```
    Returns:
    
    the optional quote used to escape references such as selection source, paths, etc. to prevent keyword collisions. Will be the empty String for no quoting of references.
  - ref
```
default String ref(String reference)
```
    Parameters:
    
    reference - the reference such as selection source, paths, etc.
    
    Returns:
    
    the potentially quoted reference to prevent keyword collisions.
  - startExpression
```
default String startExpression()
```
    Returns:
    
    the SQL to start an expression.
  - endExpression
```
default String endExpression()
```
    Returns:
    
    the SQL to end an expression.
  - startConjunction
```
default String startConjunction(Conjunction conjunction)
```
    Parameters:
    
    conjunction - the Conjunction.
    
    Returns:
    
    the SQL to start a Conjunction expression.
  - endConjunction
```
default String endConjunction(Conjunction conjunction)
```
    Parameters:
    
    conjunction - the Conjunction.
    
    Returns:
    
    the SQL to end a Conjunction expression.
  - conjuction
```
default String conjuction(Conjunction conjunction)
```
    Parameters:
    
    conjunction - the Conjunction.
    
    Returns:
    
    the SQL for the Conjunction such as and().
  - operator
```
default String operator(SqlOperator<?,?> operator)
```
    Parameters:
    
    operator - the SqlOperator.
    
    Returns:
    
    the SQL for the given SqlOperator.
  - parameter
```
default String parameter(int index)
```
    Parameters:
    
    index - the zero-based index of the current parameter.
    
    Returns:
    
    the SQL for the indexed parameter as bind variable.
  - parameter
```
default String parameter(String name)
```
    Parameters:
    
    name - the name of the parameter.
    
    Returns:
    
    the SQL for the named parameter as bind variable.
  - variable
```
default String variable(Variable<?> variable)
```
    Parameters:
    
    variable - the Variable.
    
    Returns:
    
    the SQL for the Variable.
  - separator
```
default String separator()
```
    Returns:
    
    the SQL separator for paths in GROUP BY clause, ORDER BY expressions, etc. or aliases in FROM, JOIN, etc.
  - fetch
```
default String fetch()
```
    Returns:
    
    the FETCH keyword.
  - join
```
default String join()
```
    Returns:
    
    the JOIN keyword.
  - leftJoin
```
default String leftJoin()
```
    Returns:
    
    the LEFT join() keyword.
  - leftOuterJoin
```
default String leftOuterJoin()
```
    Returns:
    
    the LEFT OUTER join() keyword.
  - innerJoin
```
default String innerJoin()
```
    Returns:
    
    the INNER join() keyword.
  - order
```
default Object order(SortOrder order)
```
    Parameters:
    
    order - the SortOrder. May be null.
    
    Returns:
    
    the corresponding SQL.
  - property
```
default String property(ReadableProperty<?> property)
```
    Parameters:
    
    property - the property to format.
    
    Returns:
    
    the formatter property name.

Interface SqlDialect

Method Summary

Method Detail

select

selectDistinct

selectCountAll

countAll

insertInto

insert

into

update

delete

deleteFrom

from

as

as

alias

upsert

distinct

where

orderBy

groupBy

having

forUpdate

set

let

assignment

like

not

is

isNull

isNotNull

isEmpty

isNotEmpty

escape

escape

limit

offset

empty

in

literalTrue

literalFalse

literalNull

and

or

quoteReference

ref

startExpression

endExpression

startConjunction

endConjunction

conjuction

operator

parameter

parameter

variable

separator

fetch

join

leftJoin

leftOuterJoin

innerJoin

order

property