SqlBuilder (pdb 2.0.1 API)

java.lang.Object
- com.feedzai.commons.sql.abstraction.dml.dialect.SqlBuilder

public final class SqlBuilder
extends Object

The SQL Builder that allows representing SQL queries in a similar way they're written.

It is intended to be used like the following.

 import static com.feedzai.commons.sql.abstraction.dml.dialect.SqlBuilder.*;

      (...)

      select(all()).from(table("TABLE_NAME"))

Since:: 2.0.0
Author:: Rui Vilao (rui.vilao@feedzai.com)

Constructor Summary

Constructors
Constructor and Description

SqlBuilder()

Constructors
Constructor and Description
`SqlBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Expression`	`all()` Selects all columns in a row.
`static Expression`	`all(String tableName)` Selects all columns in a table.
`static AlterColumn`	`alterColumn(Expression table, DbColumn dbColumn)` Alter column operator.
`static AlterColumn`	`alterColumn(Expression table, Name column, DbColumnType dbColumnType, DbColumnConstraint... constraints)` Alter column operator.
`static Expression`	`and(Collection<? extends Expression> exps)` The AND operator.
`static Expression`	`and(Expression... exps)` The AND operator.
`static Expression`	`avg(Expression exp)` The AVG operator.
`static Between`	`between(Expression exp1, Expression exp2, Expression exp3)` The BETWEEN operator.
`static Coalesce`	`coalesce(Expression exp, Expression... alternative)` The coalesce operator.
`static Name`	`column(String name)` A column.
`static Name`	`column(String tableName, String name)` A column from a table.
`static Expression`	`count(Expression exp)` The COUNT operator.
`static View`	`createView(String name)` Creates a view.
`static DbColumn.Builder`	`dbColumn()` Creates a Database Column builder.
`static DbColumn.Builder`	`dbColumn(String name, DbColumnType type)` Creates a Database Column builder.
`static DbColumn.Builder`	`dbColumn(String name, DbColumnType type, boolean autoInc)` Creates a Database Column builder.
`static DbColumn.Builder`	`dbColumn(String name, DbColumnType type, int size)` Creates a Database Column builder.
`static DbEntity.Builder`	`dbEntity()` Creates a Database Entity builder.
`static DbFk.Builder`	`dbFk()` Creates a Database Foreign Key builder.
`static DbIndex.Builder`	`dbIndex()` Creates a Database Index builder.
`static Delete`	`delete(Expression table)` The DELETE keyword.
`static Expression`	`div(Collection<? extends Expression> exps)` The DIV operator.
`static Expression`	`div(Expression... exps)` The DIV operator.
`static DropPrimaryKey`	`dropPK(Expression table)` Drop primary key table operator.
`static EntityEntry.Builder`	`entry()` Creates a Database Entry builder.
`static Expression`	`eq(Collection<? extends Expression> e1)` The equals expression.
`static Expression`	`eq(Expression... e1)` The equals expression.
`static Expression`	`f(String function)` An internal function (provided by the engine in place).
`static Expression`	`f(String function, Expression exp)` An internal function (provided by the engine in place).
`static Expression`	`gt(Collection<? extends Expression> exps)` The GT operator.
`static Expression`	`gt(Expression... exps)` The GT operator.
`static Expression`	`gteq(Collection<? extends Expression> exps)` The GTEQ operator.
`static Expression`	`gteq(Expression... exps)` The GTEQ operator.
`static Expression`	`in(Expression e1, Expression e2)` The IN expression.
`static Expression`	`join(Expression e1, Expression e2)` The same of making eq(e1, e2).
`static Expression`	`k(Object o)` A constant.
`static Expression`	`L(Collection<? extends Expression> exps)` A list of expression enclosed.
`static Expression`	`L(Expression... exps)` A list of expressions enclosed.
`static Expression`	`like(Collection<? extends Expression> exps)` The LIKE operator.
`static Expression`	`like(Expression... exps)` The LIKE operator.
`static Literal`	`lit(Object o)` Use this to add literals (strings, etc) when building the SQL statement.
`static Expression`	`lower(Expression exp)` The LOWER operator.
`static Expression`	`lt(Collection<? extends Expression> exps)` The LT operator.
`static Expression`	`lt(Expression... exps)` The LT operator.
`static Expression`	`lteq(Collection<? extends Expression> exps)` The LTEQ operator.
`static Expression`	`lteq(Expression... exps)` The LTEQ operator.
`static Expression`	`max(Expression exp)` The MAX operator.
`static Expression`	`min(Expression exp)` The MIN operator.
`static Expression`	`minus(Collection<? extends Expression> exps)` The MINUS operator.
`static Expression`	`minus(Expression... exps)` The MINUS operator.
`static Expression`	`mod(Expression exp1, Expression exp2)` The MOD operator.
`static Expression`	`mult(Collection<? extends Expression> exps)` The MULT operator.
`static Expression`	`mult(Expression... exps)` The MULT operator.
`static Expression`	`neq(Collection<? extends Expression> exps)` The not equal expression.
`static Expression`	`neq(Expression... exps)` The not equal expression.
`static Between`	`notBetween(Expression exp1, Expression exp2, Expression exp3)` The NOT BETWEEN operator.
`static Expression`	`notIn(Expression e1, Expression e2)` The NOT IN expression.
`static Expression`	`or(Collection<? extends Expression> exps)` The OR operator.
`static Expression`	`or(Expression... exps)` The OR operator.
`static Expression`	`plus(Collection<? extends Expression> exps)` The PLUS operator.
`static Expression`	`plus(Expression... exps)` The PLUS operator.
`static Rename`	`rename(Expression oldName, Expression newName)` Rename table operator.
`static Query`	`select(Collection<? extends Expression> select)` Starts a new query.
`static Query`	`select(Expression... select)` Starts a new query.
`static Expression`	`stddev(Expression exp)` The STDDEV operator.
`static Expression`	`sum(Expression exp)` The SUM operator.
`static Name`	`table(String name)` A table.
`static Truncate`	`truncate(Expression table)` The TRUNCATE keyword.
`static Expression`	`udf(String udf)` The Used Defined Function operator.
`static Expression`	`udf(String udf, Expression exp)` The Used Defined Function operator.
`static Update`	`update(Expression table)` The UPDATE operator.
`static Expression`	`upper(Expression exp)` The UPPER operator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SqlBuilder
```
public SqlBuilder()
```
- Method Detail
  - select
```
public static Query select(Expression... select)
```
    Starts a new query.
    
    Parameters:
    select - The objects.
    
    Returns:
    A new query.
  - select
```
public static Query select(Collection<? extends Expression> select)
```
    Starts a new query.
    
    Parameters:
    select - The collection of select columns.
    
    Returns:
    A new query.
  - all
```
public static Expression all()
```
    Selects all columns in a row.
    
    Returns:
    The expression.
  - all
```
public static Expression all(String tableName)
```
    Selects all columns in a table.
    
    Parameters:
    tableName - The table.
    
    Returns:
    The expression.
  - column
```
public static Name column(String name)
```
    A column.
    
    Parameters:
    name - The column name.
    
    Returns:
    The expression.
  - column
```
public static Name column(String tableName,
          String name)
```
    A column from a table.
    
    Parameters:
    tableName - The table name.
    name - The column name.
    
    Returns:
    The expression.
  - table
```
public static Name table(String name)
```
    A table.
    
    Parameters:
    name - The table name.
    
    Returns:
    The expression.
  - eq
```
public static Expression eq(Expression... e1)
```
    The equals expression.
    
    Parameters:
    e1 - The expressions.
    
    Returns:
    The expression.
  - eq
```
public static Expression eq(Collection<? extends Expression> e1)
```
    The equals expression.
    
    Parameters:
    e1 - The expressions.
    
    Returns:
    The expression.
  - k
```
public static Expression k(Object o)
```
    A constant.
    
    Parameters:
    o - The constant.
    
    Returns:
    The expression.
  - and
```
public static Expression and(Expression... exps)
```
    The AND operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The AND representation.
  - and
```
public static Expression and(Collection<? extends Expression> exps)
```
    The AND operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The AND representation.
  - or
```
public static Expression or(Expression... exps)
```
    The OR operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The OR representation.
  - or
```
public static Expression or(Collection<? extends Expression> exps)
```
    The OR operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The OR representation.
  - div
```
public static Expression div(Expression... exps)
```
    The DIV operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The DIV representation.
  - div
```
public static Expression div(Collection<? extends Expression> exps)
```
    The DIV operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The DIV representation.
  - mod
```
public static Expression mod(Expression exp1,
             Expression exp2)
```
    The MOD operator.
    
    Parameters:
    exp1 - The dividend.
    exp2 - The divisor.
    
    Returns:
    The DIV representation.
  - gt
```
public static Expression gt(Expression... exps)
```
    The GT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The GT representation.
  - gt
```
public static Expression gt(Collection<? extends Expression> exps)
```
    The GT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The GT representation.
  - gteq
```
public static Expression gteq(Expression... exps)
```
    The GTEQ operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The GTEQ representation.
  - gteq
```
public static Expression gteq(Collection<? extends Expression> exps)
```
    The GTEQ operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The GTEQ representation.
  - like
```
public static Expression like(Expression... exps)
```
    The LIKE operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LIKE representation.
  - like
```
public static Expression like(Collection<? extends Expression> exps)
```
    The LIKE operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LIKE representation.
  - lt
```
public static Expression lt(Expression... exps)
```
    The LT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LT representation.
  - lt
```
public static Expression lt(Collection<? extends Expression> exps)
```
    The LT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LT representation.
  - lteq
```
public static Expression lteq(Expression... exps)
```
    The LTEQ operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LTEQ representation.
  - lteq
```
public static Expression lteq(Collection<? extends Expression> exps)
```
    The LTEQ operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The LTEQ representation.
  - minus
```
public static Expression minus(Expression... exps)
```
    The MINUS operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The MINUS representation.
  - minus
```
public static Expression minus(Collection<? extends Expression> exps)
```
    The MINUS operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The MINUS representation.
  - mult
```
public static Expression mult(Expression... exps)
```
    The MULT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The MULT representation.
  - mult
```
public static Expression mult(Collection<? extends Expression> exps)
```
    The MULT operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The MULT representation.
  - plus
```
public static Expression plus(Expression... exps)
```
    The PLUS operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The PLUS representation.
  - plus
```
public static Expression plus(Collection<? extends Expression> exps)
```
    The PLUS operator.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The PLUS representation.
  - max
```
public static Expression max(Expression exp)
```
    The MAX operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The MAX representation.
  - min
```
public static Expression min(Expression exp)
```
    The MIN operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The MIN representation.
  - stddev
```
public static Expression stddev(Expression exp)
```
    The STDDEV operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The STDDEV representation.
  - avg
```
public static Expression avg(Expression exp)
```
    The AVG operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The AVG representation.
  - count
```
public static Expression count(Expression exp)
```
    The COUNT operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The COUNT representation.
  - sum
```
public static Expression sum(Expression exp)
```
    The SUM operator.
    
    Parameters:
    exp - The expression.
    
    Returns:
    The SUM representation.
  - udf
```
public static Expression udf(String udf)
```
    The Used Defined Function operator.
    
    Parameters:
    udf - The UDF name.
    
    Returns:
    The UDF representation.
  - udf
```
public static Expression udf(String udf,
             Expression exp)
```
    The Used Defined Function operator.
    
    Parameters:
    udf - The UDF name.
    exp - The expression.
    
    Returns:
    The UDF representation.
  - upper
```
public static Expression upper(Expression exp)
```
    The UPPER operator.
    
    Parameters:
    exp - The expression inside the operator.
    
    Returns:
    The UPPER representation.
  - lower
```
public static Expression lower(Expression exp)
```
    The LOWER operator.
    
    Parameters:
    exp - The expression inside the operator.
    
    Returns:
    The LOWER representation.
  - f
```
public static Expression f(String function)
```
    An internal function (provided by the engine in place).
    
    Parameters:
    function - The function.
    
    Returns:
    The function representation.
  - f
```
public static final Expression f(String function,
           Expression exp)
```
    An internal function (provided by the engine in place).
    
    Parameters:
    function - The function.
    exp - The expression.
    
    Returns:
    The function representation.
  - join
```
public static Expression join(Expression e1,
              Expression e2)
```
    The same of making eq(e1, e2).
    
    Parameters:
    e1 - The first expression.
    e2 - The second expression.
    
    Returns:
    A join representation using the equal operator.
  - createView
```
public static View createView(String name)
```
    Creates a view.
    
    Parameters:
    name - The name of the view.
    
    Returns:
    The view representation.
  - neq
```
public static Expression neq(Expression... exps)
```
    The not equal expression.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The expression.
  - neq
```
public static Expression neq(Collection<? extends Expression> exps)
```
    The not equal expression.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The expression.
  - L
```
public static Expression L(Expression... exps)
```
    A list of expressions enclosed.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The expression.
  - L
```
public static Expression L(Collection<? extends Expression> exps)
```
    A list of expression enclosed.
    
    Parameters:
    exps - The expressions.
    
    Returns:
    The expression.
  - in
```
public static Expression in(Expression e1,
            Expression e2)
```
    The IN expression.
    
    Parameters:
    e1 - The first expression.
    e2 - The second expression.
    
    Returns:
    The expression.
  - notIn
```
public static Expression notIn(Expression e1,
               Expression e2)
```
    The NOT IN expression.
    
    Parameters:
    e1 - The first expression.
    e2 - The second expression.
    
    Returns:
    The expression.
  - coalesce
```
public static Coalesce coalesce(Expression exp,
                Expression... alternative)
```
    The coalesce operator.
    
    Parameters:
    exp - The expression to test if is NULL.
    alternative - The alternative expressions to use.
    
    Returns:
    The coalesce operator.
  - between
```
public static Between between(Expression exp1,
              Expression exp2,
              Expression exp3)
```
    The BETWEEN operator.
    
    Parameters:
    exp1 - The column.
    exp2 - The first bound.
    exp3 - The second bound.
    
    Returns:
    The between expression.
  - notBetween
```
public static Between notBetween(Expression exp1,
                 Expression exp2,
                 Expression exp3)
```
    The NOT BETWEEN operator.
    
    Parameters:
    exp1 - The column.
    exp2 - The first bound.
    exp3 - The second bound.
    
    Returns:
    The between expression.
  - update
```
public static Update update(Expression table)
```
    The UPDATE operator.
    
    Parameters:
    table - The table.
    
    Returns:
    The UPDATE expression.
  - delete
```
public static Delete delete(Expression table)
```
    The DELETE keyword.
    
    Parameters:
    table - The table.
    
    Returns:
    The DELETE expression.
  - lit
```
public static Literal lit(Object o)
```
    Use this to add literals (strings, etc) when building the SQL statement.
    
    Parameters:
    o - The literal.
    
    Returns:
    The literal object.
  - truncate
```
public static Truncate truncate(Expression table)
```
    The TRUNCATE keyword.
    
    Parameters:
    table - The table.
    
    Returns:
    The TRUNCATE object.
  - rename
```
public static Rename rename(Expression oldName,
            Expression newName)
```
    Rename table operator.
    
    Parameters:
    oldName - The table.
    
    Returns:
    The rename instance.
  - dropPK
```
public static DropPrimaryKey dropPK(Expression table)
```
    Drop primary key table operator.
    
    Parameters:
    table - The table.
    
    Returns:
    The drop primary key instance.
  - alterColumn
```
public static AlterColumn alterColumn(Expression table,
                      Name column,
                      DbColumnType dbColumnType,
                      DbColumnConstraint... constraints)
```
    Alter column operator.
    
    Parameters:
    table - The table containing the column.
    column - The column of the table.
    dbColumnType - The db column type.
    constraints - The constraints of the column.
    
    Returns:
    The alter column operator.
  - alterColumn
```
public static AlterColumn alterColumn(Expression table,
                      DbColumn dbColumn)
```
    Alter column operator.
    
    Parameters:
    table - The table containing the column.
    dbColumn - The database column definition.
    
    Returns:
    The alter column operator.
  - dbFk
```
public static DbFk.Builder dbFk()
```
    Creates a Database Foreign Key builder.
    
    Returns:
    A Database Foreign Key builder.
  - dbEntity
```
public static DbEntity.Builder dbEntity()
```
    Creates a Database Entity builder.
    
    Returns:
    A Database Entity Key builder.
  - dbIndex
```
public static DbIndex.Builder dbIndex()
```
    Creates a Database Index builder.
    
    Returns:
    A Database Index Key builder.
  - dbColumn
```
public static DbColumn.Builder dbColumn()
```
    Creates a Database Column builder.
    
    Returns:
    A Database Column Key builder.
  - dbColumn
```
public static DbColumn.Builder dbColumn(String name,
                        DbColumnType type,
                        boolean autoInc)
```
    Creates a Database Column builder.
    
    Returns:
    A Database Column Key builder.
  - dbColumn
```
public static DbColumn.Builder dbColumn(String name,
                        DbColumnType type)
```
    Creates a Database Column builder.
    
    Returns:
    A Database Column Key builder.
  - dbColumn
```
public static DbColumn.Builder dbColumn(String name,
                        DbColumnType type,
                        int size)
```
    Creates a Database Column builder.
    
    Returns:
    A Database Column Key builder.
  - entry
```
public static EntityEntry.Builder entry()
```
    Creates a Database Entry builder.
    
    Returns:
    A Database Entry Key builder.

Class SqlBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlBuilder

Method Detail

select

select

all

all

column

column

table

eq

eq

k

and

and

or

or

div

div

mod

gt

gt

gteq

gteq

like

like

lt

lt

lteq

lteq

minus

minus

mult

mult

plus

plus

max

min

stddev

avg

count

sum

udf

udf

upper

lower

f

f

join

createView

neq

neq

L

L

in

notIn

coalesce

between

notBetween

update

delete

lit

truncate

rename

dropPK

alterColumn

alterColumn

dbFk

dbEntity

dbIndex

dbColumn

dbColumn

dbColumn

dbColumn

entry