com.jn.sqlhelper.dialect

接口 Dialect

所有超级接口:

com.jn.langx.escape.Escaper, LikeEscaper

所有已知实现类:

AbstractDialect, AbstractTransactSQLDialect, AccessDialect, ActorDBDialect, AgensGraphDialect, AltibaseDialect, AntDBDialect, AuroraDialect, AzureDialect, BigObjectDialect, BrytlytDialect, CacheDialect, CirroDBDialect, CitusDialect, ClickHouseDialect, ClustrixDialect, CobolDialect, CockroachDialect, ComDB2Dialect, CovenantSQLDialect, CrateDialect, CTreeDialect, CubridDialect, DB2Dialect, DbfDialect, DerbyDialect, DmDialect, DorisDialect, DrillDialect, ElasticsearchDialect, EsgynDBDialect, FileMakerDialect, FirebirdDialect, GaussDbDialect, GBase8sDialect, GBaseDialect, GoldenDBDialect, GreenplumDialect, H2Dialect, HANADialect, HawqDialect, HerdDBDialect, HhDbDialect, HighGoDialect, HiveDialect, HSQLDialect, IgniteDialect, ImpalaDialect, InformixDialect, IngresDialect, InterbaseDialect, IrisDialect, JDataStoreDialect, KarelDBDialect, KDBDialect, KineticaDialect, KingbaseDialect, KognitioDialect, LeanXcaleDialect, LinterDialect, MariaDBDialect, MaxComputeDialect, MaxDBDialect, MckoiDialect, MemSQLDialect, MimerSQLDialect, MonetDialect, MSQLDialect, MySQLDialect, Neo4jDialect, NetezzaDialect, NexusDBDialect, NuodbDialect, OBaseDialect, OmnisciDialect, OpenbaseDialect, OpenEdgeDialect, OracleDialect, OrientDBDialect, OscarDialect, ParadoxDialect, PerconaMysqlDialect, PhoenixDialect, PointbaseDialect, PostgreSQLDialect, PrestoDialect, RadonDBDialect, RaimaDialect, RBaseDialect, RDMSOS2200Dialect, RedshiftDialect, SadasDialect, SequoiaDBDialect, SinoDBDialect, SmallDialect, SnappyDataDialect, SnowflakeDialect, SpliceMachineDialect, SQLiteDialect, SQLServerDialect, SQLServerDialect.SQLServer2000Dialect, SQLServerDialect.SQLServer2005Dialect, SQLServerDialect.SQLServer2008Dialect, SQLServerDialect.SQLServer2012Dialect, SQLServerDialect.SQLServer2014Dialect, SQLServerDialect.SQLServer2016Dialect, SQLServerDialect.SQLServer2017Dialect, SQReamDialect, SybaseDialect, TajoDialect, TeradataDialect, TiDBDialect, TimesTenDialect, TrafodionDialect, TransbaseDialect, UxDBDialect, ValentinaDialect, VerticaDialect, VirtuosoDialect, VistaDBDialect, VoltDBDialect, XmlDialect, XtremeSQLDialect, YaacomoDialect, YugabyteDBDialect

public interface Dialect
extends LikeEscaper

方法概要

限定符和类型	方法和说明
int	bindLimitParametersAtEndOfQuery(RowSelection paramRowSelection, PreparedStatement paramPreparedStatement, int paramInt)
int	bindLimitParametersAtStartOfQuery(RowSelection paramRowSelection, PreparedStatement paramPreparedStatement, int paramInt)
String	generateTableDDL(DatabaseDescription database, String catalog, String schema, String tableName)
char	getAfterQuote() Get quote for symbol (e.g. table name, field name)
char	getBeforeQuote() Get quote for symbol (e.g. table name, field name)
String	getDatabaseId()
String	getLimitSql(String query, RowSelection rowSelection) Given a limit and an offset, apply the limit clause to the query.
String	getQuotedIdentifier(String identifier) Database identifier: tableName, columnName, schema, keyword.
UrlParser	getUrlParser()
boolean	isBindLimitParametersFirst() limit parameter will be bind in the first or not, if first ,the bindLimitParametersAtStartOfQuery(RowSelection, PreparedStatement, int) will be execute else the bindLimitParametersAtEndOfQuery(RowSelection, PreparedStatement, int) will be execute
boolean	isBindLimitParametersInReverseOrder() Whether bind parameter in reverse or not.
boolean	isForceLimitUsage() Generally if there is no, limit applied to a query we do not apply any limits to the sql query.
boolean	isSupportsBatchSql()
boolean	isSupportsBatchUpdates()
boolean	isSupportsDistinct() Whether supports distinct keyword
boolean	isSupportsLimit() Does this dialect support some form of limiting query results via a sql clause?
boolean	isSupportsLimitOffset() Does this dialect's LIMIT support (if any) additionally support specifying an offset?
boolean	isSupportsVariableLimit() Does this dialect support bind variables (i.e., prepared statement parameters) for its limit/offset?
boolean	isUseLimitInVariableMode() Whether set limit or offset with placeholder '?'
boolean	isUseMaxForLimit()
int	registerResultSetOutParameter(CallableStatement paramCallableStatement, int paramInt)
void	setMaxRows(RowSelection paramRowSelection, PreparedStatement paramPreparedStatement)
void	setUseLimitInVariableMode(boolean variableMode) Whether set limit or offset with placeholder '?'

从接口继承的方法 com.jn.sqlhelper.dialect.likeescaper.LikeEscaper

appendmentAfterLikeClause, getLikeKeyChars

从接口继承的方法 com.jn.langx.escape.Escaper

escape

方法详细资料

getDatabaseId

String getDatabaseId()

isSupportsLimit

boolean isSupportsLimit()

Does this dialect support some form of limiting query results via a sql clause?

返回:

True if this dialect supports some form of LIMIT.

isForceLimitUsage

boolean isForceLimitUsage()

Generally if there is no, limit applied to a query we do not apply any limits to the sql query. This option forces that the limit be written to the sql query.

返回:

True to force limit into soL query even if none specified in query, false otherwise

isSupportsLimitOffset

boolean isSupportsLimitOffset()

Does this dialect's LIMIT support (if any) additionally support specifying an offset?

返回:

True if the dialect supports an offset within the limit support

isSupportsVariableLimit

boolean isSupportsVariableLimit()

Does this dialect support bind variables (i.e., prepared statement parameters) for its limit/offset?

返回:

True if bind variables can be used; false otherwise.

isUseLimitInVariableMode

boolean isUseLimitInVariableMode()

Whether set limit or offset with placeholder '?'

返回:

true if use '?' for limit or offset variable, else false

setUseLimitInVariableMode

void setUseLimitInVariableMode(boolean variableMode)

Whether set limit or offset with placeholder '?'

getLimitSql

String getLimitSql(String query,
                   RowSelection rowSelection)

Given a limit and an offset, apply the limit clause to the query.

参数:

query - The query to which to apply the limit.

返回:

The modified query statement with the limit applied.

isBindLimitParametersInReverseOrder

boolean isBindLimitParametersInReverseOrder()

Whether bind parameter in reverse or not.

Here assume the normal order is: $offset, $limit so the reverse order is: $limit, $offset

Based on the assume, case 1: limit $offset, $limit ==> reverse = false case 2: limit $limit offset $offset ==> reverse = true

isBindLimitParametersFirst

boolean isBindLimitParametersFirst()

limit parameter will be bind in the first or not, if first ,the bindLimitParametersAtStartOfQuery(RowSelection, PreparedStatement, int) will be execute else the bindLimitParametersAtEndOfQuery(RowSelection, PreparedStatement, int) will be execute

bindLimitParametersAtStartOfQuery

int bindLimitParametersAtStartOfQuery(RowSelection paramRowSelection,
                                      PreparedStatement paramPreparedStatement,
                                      int paramInt)
                               throws SQLException

抛出:

SQLException

bindLimitParametersAtEndOfQuery

int bindLimitParametersAtEndOfQuery(RowSelection paramRowSelection,
                                    PreparedStatement paramPreparedStatement,
                                    int paramInt)
                             throws SQLException

抛出:

SQLException

isUseMaxForLimit

boolean isUseMaxForLimit()

registerResultSetOutParameter

int registerResultSetOutParameter(CallableStatement paramCallableStatement,
                                  int paramInt)
                           throws SQLException

抛出:

SQLException

setMaxRows

void setMaxRows(RowSelection paramRowSelection,
                PreparedStatement paramPreparedStatement)
         throws SQLException

抛出:

SQLException

getQuotedIdentifier

String getQuotedIdentifier(String identifier)

Database identifier: tableName, columnName, schema, keyword.

参数:

identifier - the name can be one of them: tableName, columnName, schemaName etc..

返回:

`identifier`

getBeforeQuote

char getBeforeQuote()

Get quote for symbol (e.g. table name, field name)

返回:

the quote

getAfterQuote

char getAfterQuote()

Get quote for symbol (e.g. table name, field name)

返回:

the quote

isSupportsDistinct

boolean isSupportsDistinct()

Whether supports distinct keyword

isSupportsBatchUpdates

boolean isSupportsBatchUpdates()

isSupportsBatchSql

boolean isSupportsBatchSql()

generateTableDDL

String generateTableDDL(@NonNull
                        DatabaseDescription database,
                        String catalog,
                        String schema,
                        @NonNull
                        String tableName)
                 throws SQLException

抛出:

SQLException

getUrlParser

UrlParser getUrlParser()