com.landawn.abacus.util

Class SQLBuilder

java.lang.Object

com.landawn.abacus.util.SQLBuilder

Direct Known Subclasses:

SQLBuilder.E, SQLBuilder.E2, SQLBuilder.E3, SQLBuilder.NE, SQLBuilder.NE2, SQLBuilder.NE3, SQLBuilder.RE, SQLBuilder.RE2, SQLBuilder.RE3, SQLBuilder.SE, SQLBuilder.SE2, SQLBuilder.SE3

public abstract class SQLBuilder
extends java.lang.Object

It's easier to write/maintain the sql by SQLBuilder and more efficient, comparing to write sql in plain text.
The sql() or pair() method must be called to release resources.
Here is a sample:

String sql = NE.insert("gui", "firstName", "lastName").into("account").sql();
// SQL: INSERT INTO account (gui, first_name, last_name) VALUES (:gui, :firstName, :lastName)

Since:

0.8

Author:

Haiyang Li

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLBuilder.E All the property/column names in collection/map/entity/condition will be converted to lower case with underscore.
static class	SQLBuilder.E2 All the property/column names in collection/map/entity/condition will be converted to upper case with underscore.
static class	SQLBuilder.E3 All the property/column names in collection/map/entity/condition will be kept without any change.
static class	SQLBuilder.NE All the property/column names in collection/map/entity/condition will be converted to lower case with underscore and the sql will be parameterized with named parameter with Hibernate/JPA format :parameterName
static class	SQLBuilder.NE2 All the property/column names in collection/map/entity/condition will be converted to upper case with underscore and the sql will be parameterized with named parameter with Hibernate/JPA format :parameterName
static class	SQLBuilder.NE3 All the property/column names in collection/map/entity/condition will be kept without any change and the sql will be parameterized with named parameter with Hibernate/JPA format :parameterName
static class	SQLBuilder.RE All the property/column names in collection/map/entity/condition will be converted to lower case with underscore and the sql will be parameterized with question mark.
static class	SQLBuilder.RE2 All the property/column names in collection/map/entity/condition will be converted to upper case with underscore and the sql will be parameterized with question mark.
static class	SQLBuilder.RE3 All the property/column names in collection/map/entity/condition will be kept without any change and the sql will be parameterized with question mark.
static class	SQLBuilder.SE All the property/column names in collection/map/entity/condition will be converted to lower case with underscore and the sql will be parameterized with named parameter with Ibatis format #{parameterName}.
static class	SQLBuilder.SE2 All the property/column names in collection/map/entity/condition will be converted to upper case with underscore and the sql will be parameterized with named parameter with Ibatis format #{parameterName}.
static class	SQLBuilder.SE3 All the property/column names in collection/map/entity/condition will be kept without any change and the sql will be parameterized with named parameter with Ibatis format #{parameterName}.
static class	SQLBuilder.SP

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_1
static java.util.List<java.lang.String>	_1_list
static java.lang.String	ALL
static java.lang.String	ASTERISK
static java.lang.String	COUNT_ALL
static java.lang.String	DISTINCT
static java.lang.String	DISTINCTROW
static java.lang.String	TOP
static java.lang.String	UNIQUE

Method Summary

Modifier and Type	Method and Description
SQLBuilder	crossJoin(java.lang.Class<?> entityClass)
SQLBuilder	crossJoin(java.lang.String expr)
SQLBuilder	except(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	except(SQLBuilder sqlBuilder)
SQLBuilder	except(java.lang.String... columnNames)
SQLBuilder	except(java.lang.String query)
SQLBuilder	forUpdate()
SQLBuilder	from(java.lang.Class<?> entityClass)
SQLBuilder	from(java.util.Collection<java.lang.String> tableNames)
SQLBuilder	from(java.util.Map<java.lang.String,java.lang.String> tableAliases)
SQLBuilder	from(java.lang.String... tableNames)
SQLBuilder	from(java.lang.String expr)
SQLBuilder	fullJoin(java.lang.Class<?> entityClass)
SQLBuilder	fullJoin(java.lang.String expr)
SQLBuilder	groupBy(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	groupBy(java.util.Collection<java.lang.String> columnNames, com.landawn.abacus.util.SortDirection direction)
SQLBuilder	groupBy(java.util.Map<java.lang.String,com.landawn.abacus.util.SortDirection> orders)
SQLBuilder	groupBy(java.lang.String... columnNames)
SQLBuilder	groupBy(java.lang.String expr)
SQLBuilder	groupBy(java.lang.String columnName, com.landawn.abacus.util.SortDirection direction)
SQLBuilder	having(Condition cond)
SQLBuilder	having(java.lang.String expr)
SQLBuilder	innerJoin(java.lang.Class<?> entityClass)
SQLBuilder	innerJoin(java.lang.String expr)
SQLBuilder	intersect(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	intersect(SQLBuilder sqlBuilder)
SQLBuilder	intersect(java.lang.String... columnNames)
SQLBuilder	intersect(java.lang.String query)
SQLBuilder	into(java.lang.Class<?> entityClass)
SQLBuilder	into(java.lang.String tableName)
SQLBuilder	join(java.lang.Class<?> entityClass)
SQLBuilder	join(java.lang.String expr)
SQLBuilder	leftJoin(java.lang.Class<?> entityClass)
SQLBuilder	leftJoin(java.lang.String expr)
SQLBuilder	limit(int count)
SQLBuilder	limit(int offset, int count)
SQLBuilder	minus(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	minus(SQLBuilder sqlBuilder)
SQLBuilder	minus(java.lang.String... columnNames)
SQLBuilder	minus(java.lang.String query)
SQLBuilder	naturalJoin(java.lang.Class<?> entityClass)
SQLBuilder	naturalJoin(java.lang.String expr)
SQLBuilder	offset(int offset)
SQLBuilder	on(Condition cond)
SQLBuilder	on(java.lang.String expr)
SQLBuilder	orderBy(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	orderBy(java.util.Collection<java.lang.String> columnNames, com.landawn.abacus.util.SortDirection direction)
SQLBuilder	orderBy(java.util.Map<java.lang.String,com.landawn.abacus.util.SortDirection> orders)
SQLBuilder	orderBy(java.lang.String... columnNames)
SQLBuilder	orderBy(java.lang.String expr)
SQLBuilder	orderBy(java.lang.String columnName, com.landawn.abacus.util.SortDirection direction)
SQLBuilder.SP	pair() This SQLBuilder will be closed after pair() is called.
java.util.List<java.lang.Object>	parameters()
static void	registerColumnName(java.lang.String entityTableName, java.util.Map<java.lang.String,java.lang.String> propColumnNameMap) Register the irregular column names which can not be converted from property name by naming policy.
SQLBuilder	rightJoin(java.lang.Class<?> entityClass)
SQLBuilder	rightJoin(java.lang.String expr)
SQLBuilder	set(java.lang.Class<?> entityClass)
SQLBuilder	set(java.lang.Class<?> entityClass, java.util.Set<java.lang.String> excludedPropNames)
SQLBuilder	set(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	set(java.util.Map<java.lang.String,java.lang.Object> props)
SQLBuilder	set(java.lang.Object entity) Only the dirty properties will be set into the result SQL if the specified entity is a dirty marker entity.
SQLBuilder	set(java.lang.Object entity, java.util.Set<java.lang.String> excludedPropNames) Only the dirty properties will be set into the result SQL if the specified entity is a dirty marker entity.
SQLBuilder	set(java.lang.String... columnNames)
SQLBuilder	set(java.lang.String expr)
java.lang.String	sql() This SQLBuilder will be closed after sql() is called.
java.lang.String	toString()
SQLBuilder	union(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	union(SQLBuilder sqlBuilder)
SQLBuilder	union(java.lang.String... columnNames)
SQLBuilder	union(java.lang.String query)
SQLBuilder	unionAll(java.util.Collection<java.lang.String> columnNames)
SQLBuilder	unionAll(SQLBuilder sqlBuilder)
SQLBuilder	unionAll(java.lang.String... columnNames)
SQLBuilder	unionAll(java.lang.String query)
SQLBuilder	using(java.lang.String expr)
SQLBuilder	where(Condition cond)
SQLBuilder	where(java.lang.String expr)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

TOP

public static final java.lang.String TOP

See Also:

Constant Field Values

UNIQUE

public static final java.lang.String UNIQUE

See Also:

Constant Field Values

DISTINCT

public static final java.lang.String DISTINCT

See Also:

Constant Field Values

DISTINCTROW

public static final java.lang.String DISTINCTROW

See Also:

Constant Field Values

ASTERISK

public static final java.lang.String ASTERISK

See Also:

Constant Field Values

COUNT_ALL

public static final java.lang.String COUNT_ALL

See Also:

Constant Field Values

_1

public static final java.lang.String _1

See Also:

Constant Field Values

_1_list

public static final java.util.List<java.lang.String> _1_list

Method Detail

registerColumnName

public static void registerColumnName(java.lang.String entityTableName,
                                      java.util.Map<java.lang.String,java.lang.String> propColumnNameMap)

Register the irregular column names which can not be converted from property name by naming policy.

Parameters:

entityTableName -

propColumnNameMap -

into

public SQLBuilder into(java.lang.String tableName)

into

public SQLBuilder into(java.lang.Class<?> entityClass)

from

public SQLBuilder from(java.lang.String expr)

from

@SafeVarargs
public final SQLBuilder from(java.lang.String... tableNames)

from

public SQLBuilder from(java.util.Collection<java.lang.String> tableNames)

from

public SQLBuilder from(java.util.Map<java.lang.String,java.lang.String> tableAliases)

from

public SQLBuilder from(java.lang.Class<?> entityClass)

join

public SQLBuilder join(java.lang.String expr)

join

public SQLBuilder join(java.lang.Class<?> entityClass)

leftJoin

public SQLBuilder leftJoin(java.lang.String expr)

leftJoin

public SQLBuilder leftJoin(java.lang.Class<?> entityClass)

rightJoin

public SQLBuilder rightJoin(java.lang.String expr)

rightJoin

public SQLBuilder rightJoin(java.lang.Class<?> entityClass)

fullJoin

public SQLBuilder fullJoin(java.lang.String expr)

fullJoin

public SQLBuilder fullJoin(java.lang.Class<?> entityClass)

crossJoin

public SQLBuilder crossJoin(java.lang.String expr)

crossJoin

public SQLBuilder crossJoin(java.lang.Class<?> entityClass)

innerJoin

public SQLBuilder innerJoin(java.lang.String expr)

innerJoin

public SQLBuilder innerJoin(java.lang.Class<?> entityClass)

naturalJoin

public SQLBuilder naturalJoin(java.lang.String expr)

naturalJoin

public SQLBuilder naturalJoin(java.lang.Class<?> entityClass)

on

public SQLBuilder on(java.lang.String expr)

on

public SQLBuilder on(Condition cond)

Parameters:

cond - any literal written in Expression condition won't be formalized

Returns:

using

public SQLBuilder using(java.lang.String expr)

where

public SQLBuilder where(java.lang.String expr)

where

public SQLBuilder where(Condition cond)

Parameters:

cond - any literal written in Expression condition won't be formalized

Returns:

groupBy

public SQLBuilder groupBy(java.lang.String expr)

groupBy

@SafeVarargs
public final SQLBuilder groupBy(java.lang.String... columnNames)

groupBy

public SQLBuilder groupBy(java.lang.String columnName,
                          com.landawn.abacus.util.SortDirection direction)

groupBy

public SQLBuilder groupBy(java.util.Collection<java.lang.String> columnNames)

groupBy

public SQLBuilder groupBy(java.util.Collection<java.lang.String> columnNames,
                          com.landawn.abacus.util.SortDirection direction)

groupBy

public SQLBuilder groupBy(java.util.Map<java.lang.String,com.landawn.abacus.util.SortDirection> orders)

having

public SQLBuilder having(java.lang.String expr)

having

public SQLBuilder having(Condition cond)

Parameters:

cond - any literal written in Expression condition won't be formalized

Returns:

orderBy

public SQLBuilder orderBy(java.lang.String expr)

orderBy

@SafeVarargs
public final SQLBuilder orderBy(java.lang.String... columnNames)

orderBy

public SQLBuilder orderBy(java.lang.String columnName,
                          com.landawn.abacus.util.SortDirection direction)

orderBy

public SQLBuilder orderBy(java.util.Collection<java.lang.String> columnNames)

orderBy

public SQLBuilder orderBy(java.util.Collection<java.lang.String> columnNames,
                          com.landawn.abacus.util.SortDirection direction)

orderBy

public SQLBuilder orderBy(java.util.Map<java.lang.String,com.landawn.abacus.util.SortDirection> orders)

limit

public SQLBuilder limit(int count)

limit

public SQLBuilder limit(int offset,
                        int count)

offset

public SQLBuilder offset(int offset)

union

public SQLBuilder union(SQLBuilder sqlBuilder)

union

public SQLBuilder union(java.lang.String query)

union

@SafeVarargs
public final SQLBuilder union(java.lang.String... columnNames)

union

public SQLBuilder union(java.util.Collection<java.lang.String> columnNames)

unionAll

public SQLBuilder unionAll(SQLBuilder sqlBuilder)

unionAll

public SQLBuilder unionAll(java.lang.String query)

unionAll

@SafeVarargs
public final SQLBuilder unionAll(java.lang.String... columnNames)

unionAll

public SQLBuilder unionAll(java.util.Collection<java.lang.String> columnNames)

intersect

public SQLBuilder intersect(SQLBuilder sqlBuilder)

intersect

public SQLBuilder intersect(java.lang.String query)

intersect

@SafeVarargs
public final SQLBuilder intersect(java.lang.String... columnNames)

intersect

public SQLBuilder intersect(java.util.Collection<java.lang.String> columnNames)

except

public SQLBuilder except(SQLBuilder sqlBuilder)

except

public SQLBuilder except(java.lang.String query)

except

@SafeVarargs
public final SQLBuilder except(java.lang.String... columnNames)

except

public SQLBuilder except(java.util.Collection<java.lang.String> columnNames)

minus

public SQLBuilder minus(SQLBuilder sqlBuilder)

minus

public SQLBuilder minus(java.lang.String query)

minus

@SafeVarargs
public final SQLBuilder minus(java.lang.String... columnNames)

minus

public SQLBuilder minus(java.util.Collection<java.lang.String> columnNames)

forUpdate

public SQLBuilder forUpdate()

set

public SQLBuilder set(java.lang.String expr)

set

@SafeVarargs
public final SQLBuilder set(java.lang.String... columnNames)

set

public SQLBuilder set(java.util.Collection<java.lang.String> columnNames)

set

public SQLBuilder set(java.util.Map<java.lang.String,java.lang.Object> props)

set

public SQLBuilder set(java.lang.Object entity)

Only the dirty properties will be set into the result SQL if the specified entity is a dirty marker entity.

Parameters:

entity -

Returns:

set

public SQLBuilder set(java.lang.Object entity,
                      java.util.Set<java.lang.String> excludedPropNames)

Only the dirty properties will be set into the result SQL if the specified entity is a dirty marker entity.

Parameters:

entity -

excludedPropNames -

Returns:

set

public SQLBuilder set(java.lang.Class<?> entityClass)

set

public SQLBuilder set(java.lang.Class<?> entityClass,
                      java.util.Set<java.lang.String> excludedPropNames)

sql

public java.lang.String sql()

This SQLBuilder will be closed after sql() is called.

Returns:

parameters

public java.util.List<java.lang.Object> parameters()

pair

public SQLBuilder.SP pair()

This SQLBuilder will be closed after pair() is called.

Returns:

the pair of sql and parameters.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object