Package com.alibaba.druid.sql

Class SQLUtils

java.lang.Object

com.alibaba.druid.sql.SQLUtils

public class SQLUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SQLUtils.FormatOption

Field Summary

Fields

Modifier and Type	Field	Description
static SQLUtils.FormatOption	DEFAULT_FORMAT_OPTION
static SQLUtils.FormatOption	DEFAULT_LCASE_FORMAT_OPTION

Constructor Summary

Constructors

Constructor	Description
SQLUtils()

Method Summary

Modifier and Type	Method	Description
static void	acceptAggregateFunction(String sql, DbType dbType, Consumer<SQLAggregateExpr> consumer, Predicate<SQLAggregateExpr> filter)
static void	acceptBinaryOpExpr(String sql, DbType dbType, Consumer<SQLBinaryOpExpr> consumer, Predicate<SQLBinaryOpExpr> filter)
static void	acceptBinaryOpExprGroup(String sql, DbType dbType, Consumer<SQLBinaryOpExprGroup> consumer, Predicate<SQLBinaryOpExprGroup> filter)
static void	acceptBooleanOr(String sql, DbType dbType, Consumer<SQLBinaryOpExprGroup> consumer)
static void	acceptFunction(String sql, DbType dbType, Consumer<SQLMethodInvokeExpr> consumer, Predicate<SQLMethodInvokeExpr> filter)
static void	acceptInsertInto(String sql, DbType dbType, Consumer<SQLInsertInto> consumer, Predicate<SQLInsertInto> filter)
static void	acceptSelectQueryBlock(String sql, DbType dbType, Consumer<SQLSelectQueryBlock> consumer, Predicate<SQLSelectQueryBlock> filter)
static void	acceptTableSource(String sql, DbType dbType, Consumer<SQLTableSource> consumer, Predicate<SQLTableSource> filter)
static void	addCondition(SQLStatement stmt, SQLBinaryOperator op, SQLExpr condition, boolean left)
static String	addCondition(String sql, String condition, DbType dbType)
static String	addCondition(String sql, String condition, SQLBinaryOperator op, boolean left, DbType dbType)
static void	addSelectItem(SQLStatement stmt, SQLExpr expr, String alias, boolean first)
static void	addSelectItem(SQLSelectQueryBlock queryBlock, SQLExpr expr, String alias, boolean first)
static String	addSelectItem(String selectSql, String expr, String alias, boolean first, DbType dbType)
static String	addSelectItem(String selectSql, String expr, String alias, DbType dbType)
static SQLExpr	buildCondition(SQLBinaryOperator op, SQLExpr condition, boolean left, SQLExpr where)
static String	buildToDate(String columnName, String tableAlias, String pattern, DbType dbType)	Builds a SQL expression to convert a column's value to a date format based on the provided pattern and database type.
static Object[]	clearLimit(String query, DbType dbType)	Clears the LIMIT clause from the provided SQL query and returns the modified query and the extracted LIMIT information.
static SQLStatement	convertTimeZone(SQLStatement stmt, TimeZone from, TimeZone to)
static String	convertTimeZone(String sql, TimeZone from, TimeZone to)
static SQLASTOutputVisitor	createFormatOutputVisitor(StringBuilder out, List<SQLStatement> statementList, DbType dbType)
static SQLASTOutputVisitor	createOutputVisitor(StringBuilder out, DbType dbType)
static SchemaStatVisitor	createSchemaStatVisitor(DbType dbType)
static SchemaStatVisitor	createSchemaStatVisitor(SchemaRepository repository)
static SchemaStatVisitor	createSchemaStatVisitor(SchemaRepository repository, DbType dbType)
static SchemaStatVisitor	createSchemaStatVisitor(List<SQLStatement> statementList, DbType dbType)	Deprecated.
static String	desensitizeTable(String tableName)
static String	forcedNormalize(String name, DbType dbType)
static String	format(String sql, DbType dbType)
static String	format(String sql, DbType dbType, SQLUtils.FormatOption option)
static String	format(String sql, DbType dbType, List<Object> parameters)
static String	format(String sql, DbType dbType, List<Object> parameters, SQLUtils.FormatOption option)
static String	format(String sql, DbType dbType, List<Object> parameters, SQLUtils.FormatOption option, SQLParserFeature[] features)
static String	format(String sql, String dbType)
static String	formatHive(String sql)
static String	formatHive(String sql, SQLUtils.FormatOption option)
static String	formatMySql(String sql)
static String	formatMySql(String sql, SQLUtils.FormatOption option)
static String	formatOdps(String sql)
static String	formatOdps(String sql, SQLUtils.FormatOption option)
static String	formatOracle(String sql)
static String	formatOracle(String sql, SQLUtils.FormatOption option)
static String	formatPGSql(String sql, SQLUtils.FormatOption option)
static String	formatPresto(String sql)
static String	formatPresto(String sql, SQLUtils.FormatOption option)
static String	formatSQLServer(String sql)
static SQLLimit	getLimit(SQLStatement statement, DbType dbType)
static SQLLimit	getLimit(String query, DbType dbType)
static long	hash(String sql, DbType dbType)
static boolean	isValue(SQLExpr expr)
static boolean	nameEquals(SQLName a, SQLName b)
static boolean	nameEquals(String a, String b)
static String	normalize(String name)
static String	normalize(String name, boolean isTrimmed)
static String	normalize(String name, DbType dbType)
static SQLExpr	not(SQLExpr expr)
static SQLStatement	parseSingleMysqlStatement(String sql)
static SQLStatement	parseSingleStatement(String sql, DbType dbType, boolean keepComments)
static SQLStatement	parseSingleStatement(String sql, DbType dbType, SQLParserFeature... features)
static SQLStatement	parseSingleStatement(String sql, String dbType, SQLParserFeature... features)
static List<SQLStatement>	parseStatements(String sql, DbType dbType)
static List<SQLStatement>	parseStatements(String sql, DbType dbType, boolean keepComments)
static List<SQLStatement>	parseStatements(String sql, DbType dbType, SQLParserFeature... features)
static List<SQLStatement>	parseStatements(String sql, String dbType)
static List<SQLStatement>	parseStatements(String sql, String dbType, SQLParserFeature... features)
static String	refactor(String sql, DbType dbType, Map<String,String> tableMapping)
static boolean	replaceInParent(SQLExpr expr, SQLExpr target)
static boolean	replaceInParent(SQLSelectQuery cmp, SQLSelectQuery dest)
static boolean	replaceInParent(SQLTableSource cmp, SQLTableSource dest)
static String	sort(String sql, DbType dbType)	Sorts the SQL statements in the provided SQL query string based on the specified database type.
static List<SQLExpr>	split(SQLBinaryOpExpr x)
static List<SQLInsertStatement>	splitInsertValues(DbType dbType, String insertSql, int size)
static String	toAntsparkString(SQLObject sqlObject)
static String	toAntsparkString(SQLObject sqlObject, SQLUtils.FormatOption option)
static String	toDB2String(SQLObject sqlObject)
static String	toDB2String(SQLObject sqlObject, SQLUtils.FormatOption option)
static String	toHiveString(SQLObject sqlObject)
static SQLExpr	toMySqlExpr(String sql)
static String	toMySqlString(SQLObject sqlObject)
static String	toMySqlString(SQLObject sqlObject, SQLUtils.FormatOption option)
static String	toMySqlString(SQLObject sqlObject, VisitorFeature... features)
static String	toMySqlStringIfNotNull(SQLObject sqlObject, String defaultStr)
static String	toNormalizeMysqlString(SQLObject sqlObject)
static String	toOdpsString(SQLObject sqlObject)
static String	toOdpsString(SQLObject sqlObject, SQLUtils.FormatOption option)
static String	toOracleString(SQLObject sqlObject)
static String	toOracleString(SQLObject sqlObject, SQLUtils.FormatOption option)
static SQLSelectOrderByItem	toOrderByItem(String sql, DbType dbType)
static String	toPGString(SQLObject sqlObject)
static String	toPGString(SQLObject sqlObject, SQLUtils.FormatOption option)
static SQLSelectItem	toSelectItem(String sql, DbType dbType)
static SQLExpr	toSQLExpr(String sql)
static SQLExpr	toSQLExpr(String sql, DbType dbType)
static String	toSQLServerString(SQLObject sqlObject)
static String	toSQLServerString(SQLObject sqlObject, SQLUtils.FormatOption option)
static String	toSQLString(SQLObject obj)
static String	toSQLString(SQLObject sqlObject, DbType dbType)
static String	toSQLString(SQLObject sqlObject, DbType dbType, SQLUtils.FormatOption option)
static String	toSQLString(SQLObject sqlObject, DbType dbType, SQLUtils.FormatOption option, VisitorFeature... features)
static String	toSQLString(SQLObject sqlObject, String dbType)
static String	toSQLString(List<SQLStatement> statementList, DbType dbType)
static String	toSQLString(List<SQLStatement> statementList, DbType dbType, SQLUtils.FormatOption option)
static String	toSQLString(List<SQLStatement> statementList, DbType dbType, List<Object> parameters)
static String	toSQLString(List<SQLStatement> statementList, DbType dbType, List<Object> parameters, SQLUtils.FormatOption option)
static String	toSQLString(List<SQLStatement> statementList, DbType dbType, List<Object> parameters, SQLUtils.FormatOption option, Map<String,String> tableMapping)
static List<SQLStatement>	toStatementList(String sql, DbType dbType)
static SQLUpdateSetItem	toUpdateSetItem(String sql, DbType dbType)
static String	translateOracleToMySql(String sql)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_FORMAT_OPTION

public static SQLUtils.FormatOption DEFAULT_FORMAT_OPTION

DEFAULT_LCASE_FORMAT_OPTION

public static SQLUtils.FormatOption DEFAULT_LCASE_FORMAT_OPTION

Constructor Details

SQLUtils

public SQLUtils()

Method Details

toSQLString

public static String toSQLString(SQLObject sqlObject,
 String dbType)

toSQLString

public static String toSQLString(SQLObject sqlObject,
 DbType dbType)

toSQLString

public static String toSQLString(SQLObject sqlObject,
 DbType dbType,
 SQLUtils.FormatOption option)

toSQLString

public static String toSQLString(SQLObject sqlObject,
 DbType dbType,
 SQLUtils.FormatOption option,
 VisitorFeature... features)

toSQLString

public static String toSQLString(SQLObject obj)

toOdpsString

public static String toOdpsString(SQLObject sqlObject)

toHiveString

public static String toHiveString(SQLObject sqlObject)

toOdpsString

public static String toOdpsString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toAntsparkString

public static String toAntsparkString(SQLObject sqlObject)

toAntsparkString

public static String toAntsparkString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toMySqlString

public static String toMySqlString(SQLObject sqlObject)

toMySqlStringIfNotNull

public static String toMySqlStringIfNotNull(SQLObject sqlObject,
 String defaultStr)

toMySqlString

public static String toMySqlString(SQLObject sqlObject,
 VisitorFeature... features)

toNormalizeMysqlString

public static String toNormalizeMysqlString(SQLObject sqlObject)

toMySqlString

public static String toMySqlString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toMySqlExpr

public static SQLExpr toMySqlExpr(String sql)

formatMySql

public static String formatMySql(String sql)

formatMySql

public static String formatMySql(String sql,
 SQLUtils.FormatOption option)

formatOracle

public static String formatOracle(String sql)

formatOracle

public static String formatOracle(String sql,
 SQLUtils.FormatOption option)

formatOdps

public static String formatOdps(String sql)

formatPresto

public static String formatPresto(String sql)

formatPresto

public static String formatPresto(String sql,
 SQLUtils.FormatOption option)

formatHive

public static String formatHive(String sql)

formatOdps

public static String formatOdps(String sql,
 SQLUtils.FormatOption option)

formatHive

public static String formatHive(String sql,
 SQLUtils.FormatOption option)

formatSQLServer

public static String formatSQLServer(String sql)

toOracleString

public static String toOracleString(SQLObject sqlObject)

toOracleString

public static String toOracleString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toPGString

public static String toPGString(SQLObject sqlObject)

toPGString

public static String toPGString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toDB2String

public static String toDB2String(SQLObject sqlObject)

toDB2String

public static String toDB2String(SQLObject sqlObject,
 SQLUtils.FormatOption option)

toSQLServerString

public static String toSQLServerString(SQLObject sqlObject)

toSQLServerString

public static String toSQLServerString(SQLObject sqlObject,
 SQLUtils.FormatOption option)

formatPGSql

public static String formatPGSql(String sql,
 SQLUtils.FormatOption option)

toSQLExpr

public static SQLExpr toSQLExpr(String sql,
 DbType dbType)

toOrderByItem

public static SQLSelectOrderByItem toOrderByItem(String sql,
 DbType dbType)

toUpdateSetItem

public static SQLUpdateSetItem toUpdateSetItem(String sql,
 DbType dbType)

toSelectItem

public static SQLSelectItem toSelectItem(String sql,
 DbType dbType)

toStatementList

public static List<SQLStatement> toStatementList(String sql,
 DbType dbType)

toSQLExpr

public static SQLExpr toSQLExpr(String sql)

format

public static String format(String sql,
 String dbType)

format

public static String format(String sql,
 DbType dbType)

format

public static String format(String sql,
 DbType dbType,
 SQLUtils.FormatOption option)

format

public static String format(String sql,
 DbType dbType,
 List<Object> parameters)

format

public static String format(String sql,
 DbType dbType,
 List<Object> parameters,
 SQLUtils.FormatOption option)

format

public static String format(String sql,
 DbType dbType,
 List<Object> parameters,
 SQLUtils.FormatOption option,
 SQLParserFeature[] features)

toSQLString

public static String toSQLString(List<SQLStatement> statementList,
 DbType dbType)

toSQLString

public static String toSQLString(List<SQLStatement> statementList,
 DbType dbType,
 SQLUtils.FormatOption option)

toSQLString

public static String toSQLString(List<SQLStatement> statementList,
 DbType dbType,
 List<Object> parameters)

toSQLString

public static String toSQLString(List<SQLStatement> statementList,
 DbType dbType,
 List<Object> parameters,
 SQLUtils.FormatOption option)

toSQLString

public static String toSQLString(List<SQLStatement> statementList,
 DbType dbType,
 List<Object> parameters,
 SQLUtils.FormatOption option,
 Map<String,String> tableMapping)

createOutputVisitor

public static SQLASTOutputVisitor createOutputVisitor(StringBuilder out,
 DbType dbType)

createFormatOutputVisitor

public static SQLASTOutputVisitor createFormatOutputVisitor(StringBuilder out,
 List<SQLStatement> statementList,
 DbType dbType)

createSchemaStatVisitor

@Deprecated
public static SchemaStatVisitor createSchemaStatVisitor(List<SQLStatement> statementList,
 DbType dbType)

Deprecated.

createSchemaStatVisitor

public static SchemaStatVisitor createSchemaStatVisitor(DbType dbType)

createSchemaStatVisitor

public static SchemaStatVisitor createSchemaStatVisitor(SchemaRepository repository)

createSchemaStatVisitor

public static SchemaStatVisitor createSchemaStatVisitor(SchemaRepository repository,
 DbType dbType)

parseStatements

public static List<SQLStatement> parseStatements(String sql,
 String dbType,
 SQLParserFeature... features)

parseStatements

public static List<SQLStatement> parseStatements(String sql,
 DbType dbType,
 SQLParserFeature... features)

parseStatements

public static List<SQLStatement> parseStatements(String sql,
 DbType dbType,
 boolean keepComments)

parseStatements

public static List<SQLStatement> parseStatements(String sql,
 String dbType)

parseStatements

public static List<SQLStatement> parseStatements(String sql,
 DbType dbType)

parseSingleStatement

public static SQLStatement parseSingleStatement(String sql,
 DbType dbType,
 boolean keepComments)

parseSingleStatement

public static SQLStatement parseSingleStatement(String sql,
 String dbType,
 SQLParserFeature... features)

parseSingleStatement

public static SQLStatement parseSingleStatement(String sql,
 DbType dbType,
 SQLParserFeature... features)

parseSingleMysqlStatement

public static SQLStatement parseSingleMysqlStatement(String sql)

buildToDate

public static String buildToDate(String columnName,
 String tableAlias,
 String pattern,
 DbType dbType)

Builds a SQL expression to convert a column's value to a date format based on the provided pattern and database type.

Parameters:

columnName - the name of the column to be converted

tableAlias - the alias of the table containing the column (optional)

pattern - the date format pattern to be used for the conversion (optional)

dbType - the database type for determining the appropriate conversion function

Returns:

a SQL expression representing the converted date value, or an empty string if unable to build the expression

split

public static List<SQLExpr> split(SQLBinaryOpExpr x)

translateOracleToMySql

public static String translateOracleToMySql(String sql)

addCondition

public static String addCondition(String sql,
 String condition,
 DbType dbType)

addCondition

public static String addCondition(String sql,
 String condition,
 SQLBinaryOperator op,
 boolean left,
 DbType dbType)

addCondition

public static void addCondition(SQLStatement stmt,
 SQLBinaryOperator op,
 SQLExpr condition,
 boolean left)

buildCondition

public static SQLExpr buildCondition(SQLBinaryOperator op,
 SQLExpr condition,
 boolean left,
 SQLExpr where)

addSelectItem

public static String addSelectItem(String selectSql,
 String expr,
 String alias,
 DbType dbType)

acceptBooleanOr

public static void acceptBooleanOr(String sql,
 DbType dbType,
 Consumer<SQLBinaryOpExprGroup> consumer)

acceptBinaryOpExprGroup

public static void acceptBinaryOpExprGroup(String sql,
 DbType dbType,
 Consumer<SQLBinaryOpExprGroup> consumer,
 Predicate<SQLBinaryOpExprGroup> filter)

acceptBinaryOpExpr

public static void acceptBinaryOpExpr(String sql,
 DbType dbType,
 Consumer<SQLBinaryOpExpr> consumer,
 Predicate<SQLBinaryOpExpr> filter)

acceptTableSource

public static void acceptTableSource(String sql,
 DbType dbType,
 Consumer<SQLTableSource> consumer,
 Predicate<SQLTableSource> filter)

acceptSelectQueryBlock

public static void acceptSelectQueryBlock(String sql,
 DbType dbType,
 Consumer<SQLSelectQueryBlock> consumer,
 Predicate<SQLSelectQueryBlock> filter)

acceptAggregateFunction

public static void acceptAggregateFunction(String sql,
 DbType dbType,
 Consumer<SQLAggregateExpr> consumer,
 Predicate<SQLAggregateExpr> filter)

acceptFunction

public static void acceptFunction(String sql,
 DbType dbType,
 Consumer<SQLMethodInvokeExpr> consumer,
 Predicate<SQLMethodInvokeExpr> filter)

acceptInsertInto

public static void acceptInsertInto(String sql,
 DbType dbType,
 Consumer<SQLInsertInto> consumer,
 Predicate<SQLInsertInto> filter)

addSelectItem

public static String addSelectItem(String selectSql,
 String expr,
 String alias,
 boolean first,
 DbType dbType)

addSelectItem

public static void addSelectItem(SQLStatement stmt,
 SQLExpr expr,
 String alias,
 boolean first)

addSelectItem

public static void addSelectItem(SQLSelectQueryBlock queryBlock,
 SQLExpr expr,
 String alias,
 boolean first)

refactor

public static String refactor(String sql,
 DbType dbType,
 Map<String,String> tableMapping)

hash

public static long hash(String sql,
 DbType dbType)

not

public static SQLExpr not(SQLExpr expr)

normalize

public static String normalize(String name)

normalize

public static String normalize(String name,
 boolean isTrimmed)

normalize

public static String normalize(String name,
 DbType dbType)

forcedNormalize

public static String forcedNormalize(String name,
 DbType dbType)

nameEquals

public static boolean nameEquals(SQLName a,
 SQLName b)

nameEquals

public static boolean nameEquals(String a,
 String b)

isValue

public static boolean isValue(SQLExpr expr)

replaceInParent

public static boolean replaceInParent(SQLExpr expr,
 SQLExpr target)

replaceInParent

public static boolean replaceInParent(SQLTableSource cmp,
 SQLTableSource dest)

replaceInParent

public static boolean replaceInParent(SQLSelectQuery cmp,
 SQLSelectQuery dest)

desensitizeTable

public static String desensitizeTable(String tableName)

sort

public static String sort(String sql,
 DbType dbType)

Sorts the SQL statements in the provided SQL query string based on the specified database type.

Parameters:

sql - the SQL query string to be sorted

dbType - the database type for parsing and sorting the SQL statements

Returns:

a sorted SQL query string, or an empty string if the input is invalid

clearLimit

public static Object[] clearLimit(String query,
 DbType dbType)

Clears the LIMIT clause from the provided SQL query and returns the modified query and the extracted LIMIT information.

Parameters:

query - the SQL query string to be modified

dbType - the database type for parsing the SQL statements

Returns:

an array containing the modified SQL query string and the extracted LIMIT information, or null if no LIMIT clause is found

getLimit

public static SQLLimit getLimit(SQLStatement statement,
 DbType dbType)

getLimit

public static SQLLimit getLimit(String query,
 DbType dbType)

convertTimeZone

public static String convertTimeZone(String sql,
 TimeZone from,
 TimeZone to)

convertTimeZone

public static SQLStatement convertTimeZone(SQLStatement stmt,
 TimeZone from,
 TimeZone to)

splitInsertValues

public static List<SQLInsertStatement> splitInsertValues(DbType dbType,
 String insertSql,
 int size)