io.seata.sqlparser

Interface EscapeHandler

All Known Implementing Classes:

DmEscapeHandler, MariadbEscapeHandler, MySQLEscapeHandler, OracleEscapeHandler, PolarDBXEscapeHandler, PostgresqlEscapeHandler, SqlServerEscapeHandler

public interface EscapeHandler

The interface Keyword checker.

Field Summary

Fields

Modifier and Type	Field and Description
static EscapeSymbol	DEFAULT_ESCAPE_SYMBOL
static String	DOT

Method Summary

Modifier and Type	Method and Description
default String	addColNameEscape(String colName) add escape if colName is keywords
default String	addColNameEscape(String colName, TableMeta tableMeta) add escape if colName is keywords
boolean	checkIfKeyWords(String fieldOrTableName) check whether given field name and table name use keywords
boolean	checkIfNeedEscape(String columnName, TableMeta tableMeta) check whether given field or table name use keywords. the method has database special logic.
default boolean	containsEscape(String fieldOrTableName) check fieldOrTableName if contains escape
default String	delColNameEscape(String colName) https://db.apache.org/derby/docs/10.1/ref/crefsqlj1003454.html https://docs.oracle.com/javadb/10.8.3.0/ref/crefsqlj1003454.html https://www.informit.com/articles/article.aspx?
default EscapeSymbol	getEscapeSymbol()

Field Detail

DOT

static final String DOT

See Also:

Constant Field Values

DEFAULT_ESCAPE_SYMBOL

static final EscapeSymbol DEFAULT_ESCAPE_SYMBOL

Method Detail

checkIfKeyWords

boolean checkIfKeyWords(String fieldOrTableName)

check whether given field name and table name use keywords

Parameters:

fieldOrTableName - the field or table name

Returns:

boolean

checkIfNeedEscape

boolean checkIfNeedEscape(String columnName,
                          TableMeta tableMeta)

check whether given field or table name use keywords. the method has database special logic.

Parameters:

columnName - the column or table name

tableMeta - the tableMeta

Returns:

true: need to escape. false: no need to escape.

getEscapeSymbol

default EscapeSymbol getEscapeSymbol()

containsEscape

default boolean containsEscape(String fieldOrTableName)

check fieldOrTableName if contains escape

Parameters:

fieldOrTableName - fieldOrTableName

Returns:

true if contains,otherwise return false

addColNameEscape

default String addColNameEscape(String colName)

add escape if colName is keywords

Parameters:

colName - colName

Returns:

colName

addColNameEscape

default String addColNameEscape(String colName,
                                TableMeta tableMeta)

add escape if colName is keywords

Parameters:

colName - colName

tableMeta - tableMeta

Returns:

colName

delColNameEscape

default String delColNameEscape(String colName)

https://db.apache.org/derby/docs/10.1/ref/crefsqlj1003454.html https://docs.oracle.com/javadb/10.8.3.0/ref/crefsqlj1003454.html https://www.informit.com/articles/article.aspx?p=2036581&seqNum=2

Parameters:

colName -

Returns: