org.dbflute.cbean.sqlclause.SqlClauseMySql Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation
Show all versions of dbflute-runtime Show documentation
The runtime library of DBFlute
/*
* Copyright 2014-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.dbflute.cbean.sqlclause;
import java.util.List;
import org.dbflute.cbean.sqlclause.orderby.OrderByClause;
import org.dbflute.cbean.sqlclause.query.QueryClauseArranger;
import org.dbflute.dbmeta.info.ColumnInfo;
import org.dbflute.dbmeta.name.ColumnRealName;
import org.dbflute.dbmeta.name.ColumnSqlName;
import org.dbflute.dbway.DBDef;
import org.dbflute.dbway.DBWay;
import org.dbflute.dbway.WayOfMySQL.FullTextSearchModifier;
import org.dbflute.util.Srl;
/**
* SqlClause for MySQL.
* @author jflute
*/
public class SqlClauseMySql extends AbstractSqlClause {
// ===================================================================================
// Definition
// ==========
/** The serial version UID for object serialization. (Default) */
private static final long serialVersionUID = 1L;
// ===================================================================================
// Attribute
// =========
/** String of fetch-scope as sql-suffix. */
protected String _fetchScopeSqlSuffix = "";
/** String of lock as sql-suffix. */
protected String _lockSqlSuffix = "";
/** The binding value for paging as 'limit'. */
protected Integer _pagingBindingLimit;
/** The binding value for paging as 'offset'. */
protected Integer _pagingBindingOffset;
/** Does it suppress bind variable for paging? */
protected boolean _suppressPagingBinding;
// ===================================================================================
// Constructor
// ===========
/**
* Constructor.
* @param tableDbName The DB name of table. (NotNull)
**/
public SqlClauseMySql(String tableDbName) {
super(tableDbName);
}
// ===================================================================================
// Main Override
// =============
// -----------------------------------------------------
// Complete Clause
// ---------------
@Override
public String getClause() {
if (canFoundRows()) {
return "select found_rows()";
// and sql_calc_found_rows is implemented at select-hint process
}
return super.getClause();
}
protected boolean canFoundRows() {
return canPagingCountLater() && isSelectClauseTypeNonUnionCount();
}
// ===================================================================================
// OrderBy Override
// ================
@Override
protected OrderByClause.OrderByNullsSetupper createOrderByNullsSetupper() {
return createOrderByNullsSetupperByCaseWhen();
}
// ===================================================================================
// FetchScope Override
// ===================
/**
* {@inheritDoc}
*/
protected void doFetchFirst() {
doFetchPage();
}
/**
* {@inheritDoc}
*/
protected void doFetchPage() {
if (_suppressPagingBinding) {
_fetchScopeSqlSuffix = " limit " + getPageStartIndex() + ", " + getFetchSize();
} else { // mainly here
_pagingBindingLimit = getFetchSize();
_pagingBindingOffset = getPageStartIndex();
_fetchScopeSqlSuffix = " limit /*pmb.sqlClause.pagingBindingOffset*/0, /*pmb.sqlClause.pagingBindingLimit*/0";
}
}
/**
* {@inheritDoc}
*/
protected void doClearFetchPageClause() {
_fetchScopeSqlSuffix = "";
}
// ===================================================================================
// Lock Override
// =============
/**
* {@inheritDoc}
*/
public void lockForUpdate() {
_lockSqlSuffix = " for update";
}
// ===================================================================================
// Hint Override
// =============
/**
* {@inheritDoc}
*/
protected String createSelectHint() {
final StringBuilder sb = new StringBuilder();
if (canSqlCalcFoundRows()) {
sb.append(" sql_calc_found_rows"); // and found_rows() is implemented at getClause override
}
return sb.toString();
}
protected boolean canSqlCalcFoundRows() {
return isFetchNarrowingEffective() && canPagingCountLater() && isSelectClauseNonUnionSelect();
}
/**
* {@inheritDoc}
*/
protected String createFromBaseTableHint() {
return "";
}
/**
* {@inheritDoc}
*/
protected String createFromHint() {
return "";
}
/**
* {@inheritDoc}
*/
protected String createSqlSuffix() {
return _fetchScopeSqlSuffix + _lockSqlSuffix;
}
// [DBFlute-0.7.5]
// ===================================================================================
// Query Update Override
// =====================
@Override
protected boolean isUpdateSubQueryUseLocalTableSupported() {
return false;
}
@Override
protected boolean isUpdateDirectJoinSupported() {
return true; // MySQL can use 'update MEMBER dfloc inner join ...'
}
@Override
protected boolean isUpdateTableAliasNameSupported() {
return true; // MySQL needs 'update MEMBER dfloc ...' when it has relation
}
@Override
protected boolean isDeleteTableAliasHintSupported() {
return true; // MySQL needs 'delete dfloc from MEMBER dfloc ...' when it has relation
}
// [DBFlute-0.9.9.1C]
// ===================================================================================
// Collate Clause
// ==============
public static class CollateUTF8UnicodeArranger implements QueryClauseArranger {
public String arrange(ColumnRealName columnRealName, String operand, String bindExpression, String rearOption) {
return columnRealName + " collate utf8_unicode_ci " + operand + " " + bindExpression + rearOption;
}
}
public static class CollateUTF8GeneralArranger implements QueryClauseArranger {
public String arrange(ColumnRealName columnRealName, String operand, String bindExpression, String rearOption) {
return columnRealName + " collate utf8_general_ci " + operand + " " + bindExpression + rearOption;
}
}
public static class CollateUTF8MB4UnicodeArranger implements QueryClauseArranger {
public String arrange(ColumnRealName columnRealName, String operand, String bindExpression, String rearOption) {
return columnRealName + " collate utf8mb4_unicode_520_ci " + operand + " " + bindExpression + rearOption;
}
}
// [DBFlute-0.9.5]
// ===================================================================================
// Full-Text Search
// ================
/**
* Build a condition string of match statement for full-text search.
* Bind variable is unused because the condition value should be literal in MySQL.
* @param textColumnList The list of text column. (NotNull, NotEmpty, StringColumn, TargetTableColumn)
* @param conditionValue The condition value embedded without binding (by MySQL restriction) but escaped. (NotNull)
* @param modifier The modifier of full-text search. (NullAllowed: If the value is null, No modifier specified)
* @param tableDbName The DB name of the target table. (NotNull)
* @param aliasName The alias name of the target table. (NotNull)
* @return The condition string of match statement. (NotNull)
*/
public String buildMatchCondition(List textColumnList, String conditionValue, FullTextSearchModifier modifier,
String tableDbName, String aliasName) {
assertTextColumnList(textColumnList);
assertVariousTextSearchResource(conditionValue, modifier, tableDbName, aliasName);
final StringBuilder sb = new StringBuilder();
int index = 0;
for (ColumnInfo columnInfo : textColumnList) {
if (columnInfo == null) {
continue;
}
assertTextColumnTable(tableDbName, columnInfo);
assertTextColumnType(tableDbName, columnInfo);
final ColumnSqlName columnSqlName = columnInfo.getColumnSqlName();
if (index > 0) {
sb.append(",");
}
sb.append(aliasName).append(".").append(columnSqlName);
++index;
}
sb.insert(0, "match(").append(") against ('");
sb.append(escapeMatchConditionValue(conditionValue)).append("'");
if (modifier != null) {
sb.append(" ").append(modifier.code());
}
sb.append(")");
return sb.toString();
}
protected String escapeMatchConditionValue(String conditionValue) {
conditionValue = Srl.replace(conditionValue, "\\", "\\\\");
conditionValue = Srl.replace(conditionValue, "'", "''");
return conditionValue;
}
protected void assertTextColumnList(List textColumnList) {
if (textColumnList == null) {
String msg = "The argument 'textColumnList' should not be null.";
throw new IllegalArgumentException(msg);
}
if (textColumnList.isEmpty()) {
String msg = "The argument 'textColumnList' should not be empty list.";
throw new IllegalArgumentException(msg);
}
}
protected void assertVariousTextSearchResource(String conditionValue, FullTextSearchModifier modifier, String tableDbName,
String aliasName) {
if (conditionValue == null || conditionValue.length() == 0) {
String msg = "The argument 'conditionValue' should not be null or empty: " + conditionValue;
throw new IllegalArgumentException(msg);
}
if (tableDbName == null || tableDbName.trim().length() == 0) {
String msg = "The argument 'tableDbName' should not be null or trimmed-empty: " + tableDbName;
throw new IllegalArgumentException(msg);
}
if (aliasName == null || aliasName.trim().length() == 0) {
String msg = "The argument 'aliasName' should not be null or trimmed-empty: " + aliasName;
throw new IllegalArgumentException(msg);
}
}
protected void assertTextColumnTable(String tableDbName, ColumnInfo columnInfo) {
final String tableOfColumn = columnInfo.getDBMeta().getTableDbName();
if (!tableOfColumn.equalsIgnoreCase(tableDbName)) {
String msg = "The table of the text column should be '" + tableDbName + "'";
msg = msg + " but the table is '" + tableOfColumn + "': column=" + columnInfo;
throw new IllegalArgumentException(msg);
}
}
protected void assertTextColumnType(String tableDbName, ColumnInfo columnInfo) {
if (!columnInfo.isObjectNativeTypeString()) {
String msg = "The text column should be String type: column=" + columnInfo;
throw new IllegalArgumentException(msg);
}
}
// [DBFlute-1.0.3.1]
// ===================================================================================
// CursorSelect Option
// ===================
public boolean isCursorSelectByPagingAllowed() {
// MySQL's cursor select has problems so allowed
// (RepeatableRead is default on MySQL so safety relatively)
return true;
}
// [DBFlute-0.9.8.4]
// ===================================================================================
// DBWay
// =====
public DBWay dbway() {
return DBDef.MySQL.dbway();
}
// [DBFlute-1.0.4D]
// ===================================================================================
// Accessor
// ========
public Integer getPagingBindingLimit() { // for parameter comment
return _pagingBindingLimit;
}
public Integer getPagingBindingOffset() { // for parameter comment
return _pagingBindingOffset;
}
public SqlClauseMySql suppressPagingBinding() { // for compatible? anyway, just in case
_suppressPagingBinding = true;
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy