Merge pull request #1064 from jeffgbutler/deprecate-old-where-stuff

Remove Independently Renderable Where Clauses

Author: jeffgbutler

CHANGELOG.md

@@ -105,6 +105,10 @@ library or in migrating to the new DSLs, please let us know by opening an issue
   useful in a variety of circumstances. If you follow the patterns shown on the
   [Extending the Library](https://mybatis.org/mybatis-dynamic-sql/docs/extending.html) page, the change should be
   limited to changing the private constructor to accept `BasicColumn` rather than `BindableColumn`.
+- Remove support for independently renderable where clauses. This was a holdover from the earliest days of building the
+  library. The idea was to build where clauses that would render and could then be inserted into hand-coded SQL.
+  As far as I know, this was only used for some internal testing. If you have a use case for this feature, please
+  let us know and we will revisit this decision.
 
 ### Adoption of JSpecify (https://jspecify.dev/)
 

src/main/java/org/mybatis/dynamic/sql/SqlBuilder.java

@@ -24,6 +24,8 @@
 import org.jspecify.annotations.Nullable;
 import org.mybatis.dynamic.sql.delete.DeleteDSL;
 import org.mybatis.dynamic.sql.delete.DeleteModel;
+import org.mybatis.dynamic.sql.dsl.HavingDSL;
+import org.mybatis.dynamic.sql.dsl.WhereDSL;
 import org.mybatis.dynamic.sql.insert.BatchInsertDSL;
 import org.mybatis.dynamic.sql.insert.GeneralInsertDSL;
 import org.mybatis.dynamic.sql.insert.InsertDSL;
@@ -36,7 +38,6 @@
 import org.mybatis.dynamic.sql.select.SelectDSL;
 import org.mybatis.dynamic.sql.select.SelectModel;
 import org.mybatis.dynamic.sql.select.SimpleSortSpecification;
-import org.mybatis.dynamic.sql.select.StandaloneHavingBuilder;
 import org.mybatis.dynamic.sql.select.aggregate.Avg;
 import org.mybatis.dynamic.sql.select.aggregate.Count;
 import org.mybatis.dynamic.sql.select.aggregate.CountAll;
@@ -60,7 +61,6 @@
 import org.mybatis.dynamic.sql.update.UpdateDSL;
 import org.mybatis.dynamic.sql.update.UpdateModel;
 import org.mybatis.dynamic.sql.util.Buildable;
-import org.mybatis.dynamic.sql.where.StandaloneWhereBuilder;
 import org.mybatis.dynamic.sql.where.condition.IsBetween;
 import org.mybatis.dynamic.sql.where.condition.IsBetweenWhenPresent;
 import org.mybatis.dynamic.sql.where.condition.IsEqualTo;
@@ -262,37 +262,37 @@ static UpdateDSL<UpdateModel> update(SqlTable table, String tableAlias) {
         return UpdateDSL.update(table, tableAlias);
     }
 
-    static StandaloneWhereBuilder where() {
-        return new StandaloneWhereBuilder();
+    static WhereDSL where() {
+        return new WhereDSL();
     }
 
-    static <T> StandaloneWhereBuilder where(BindableColumn<T> column, RenderableCondition<T> condition,
-                                            AndOrCriteriaGroup... subCriteria) {
+    static <T> WhereDSL where(BindableColumn<T> column, RenderableCondition<T> condition,
+                              AndOrCriteriaGroup... subCriteria) {
         ColumnAndConditionCriterion<T> initialCriterion = ColumnAndConditionCriterion.withColumn(column)
                 .withCondition(condition)
                 .build();
 
         return where(initialCriterion, subCriteria);
     }
 
-    static StandaloneWhereBuilder where(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria) {
-        return new StandaloneWhereBuilder(initialCriterion, Arrays.asList(subCriteria));
+    static WhereDSL where(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria) {
+        return new WhereDSL(initialCriterion, Arrays.asList(subCriteria));
     }
 
-    static StandaloneWhereBuilder where(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria) {
+    static WhereDSL where(ExistsPredicate existsPredicate, AndOrCriteriaGroup... subCriteria) {
         ExistsCriterion existsCriterion = new ExistsCriterion.Builder()
                 .withExistsPredicate(existsPredicate).build();
         return where(existsCriterion, subCriteria);
     }
 
-    static <T> StandaloneHavingBuilder having(BindableColumn<T> column, RenderableCondition<T> condition,
-                                              AndOrCriteriaGroup... subCriteria) {
+    static <T> HavingDSL having(BindableColumn<T> column, RenderableCondition<T> condition,
+                                AndOrCriteriaGroup... subCriteria) {
         SqlCriterion initialCriterion = ColumnAndConditionCriterion.withColumn(column).withCondition(condition).build();
         return having(initialCriterion, subCriteria);
     }
 
-    static StandaloneHavingBuilder having(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria) {
-        return new StandaloneHavingBuilder(initialCriterion, Arrays.asList(subCriteria));
+    static HavingDSL having(SqlCriterion initialCriterion, AndOrCriteriaGroup... subCriteria) {
+        return new HavingDSL(initialCriterion, Arrays.asList(subCriteria));
     }
 
     // where condition connectors

src/main/java/org/mybatis/dynamic/sql/common/CommonBuilder.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2025 the original author or authors.
+ *    Copyright 2016-2026 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.
@@ -18,7 +18,7 @@
 import org.jspecify.annotations.Nullable;
 import org.mybatis.dynamic.sql.SqlTable;
 import org.mybatis.dynamic.sql.configuration.StatementConfiguration;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 /**
  * Builder class shared between the delete and update model builders.
@@ -28,7 +28,7 @@
 public abstract class CommonBuilder<T extends CommonBuilder<T>> {
     private @Nullable SqlTable table;
     private @Nullable String tableAlias;
-    private @Nullable EmbeddedWhereModel whereModel;
+    private @Nullable WhereModel whereModel;
     private @Nullable Long limit;
     private @Nullable OrderByModel orderByModel;
     private @Nullable StatementConfiguration statementConfiguration;
@@ -41,7 +41,7 @@ public abstract class CommonBuilder<T extends CommonBuilder<T>> {
         return tableAlias;
     }
 
-    public @Nullable EmbeddedWhereModel whereModel() {
+    public @Nullable WhereModel whereModel() {
         return whereModel;
     }
 
@@ -67,7 +67,7 @@ public T withTableAlias(@Nullable String tableAlias) {
         return getThis();
     }
 
-    public T withWhereModel(@Nullable EmbeddedWhereModel whereModel) {
+    public T withWhereModel(@Nullable WhereModel whereModel) {
         this.whereModel = whereModel;
         return getThis();
     }

src/main/java/org/mybatis/dynamic/sql/delete/DeleteModel.java

@@ -27,12 +27,12 @@
 import org.mybatis.dynamic.sql.delete.render.DeleteRenderer;
 import org.mybatis.dynamic.sql.delete.render.DeleteStatementProvider;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class DeleteModel {
     private final SqlTable table;
     private final @Nullable String tableAlias;
-    private final @Nullable EmbeddedWhereModel whereModel;
+    private final @Nullable WhereModel whereModel;
     private final @Nullable Long limit;
     private final @Nullable OrderByModel orderByModel;
     private final StatementConfiguration statementConfiguration;
@@ -54,7 +54,7 @@ public Optional<String> tableAlias() {
         return Optional.ofNullable(tableAlias);
     }
 
-    public Optional<EmbeddedWhereModel> whereModel() {
+    public Optional<WhereModel> whereModel() {
         return Optional.ofNullable(whereModel);
     }
 

src/main/java/org/mybatis/dynamic/sql/delete/render/DeleteRenderer.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2016-2025 the original author or authors.
+ *    Copyright 2016-2026 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.
@@ -30,7 +30,7 @@
 import org.mybatis.dynamic.sql.render.TableAliasCalculator;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class DeleteRenderer {
     private final DeleteModel deleteModel;
@@ -75,7 +75,7 @@ private Optional<FragmentAndParameters> calculateWhereClause() {
         return deleteModel.whereModel().flatMap(this::renderWhereClause);
     }
 
-    private Optional<FragmentAndParameters> renderWhereClause(EmbeddedWhereModel whereModel) {
+    private Optional<FragmentAndParameters> renderWhereClause(WhereModel whereModel) {
         return whereModel.render(renderingContext);
     }
 

src/main/java/org/mybatis/dynamic/sql/dsl/AbstractCountDSL.java

@@ -34,8 +34,8 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.util.ConfigurableStatement;
 import org.mybatis.dynamic.sql.util.Validator;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
 import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 /**
  * DSL for building count queries. Count queries are specializations of select queries. They have joins and where
@@ -217,8 +217,8 @@ public M build() {
             return AbstractCountDSL.this.build();
         }
 
-        protected EmbeddedWhereModel buildWhereModel() {
-            return new EmbeddedWhereModel.Builder()
+        protected WhereModel buildWhereModel() {
+            return new WhereModel.Builder()
                     .withInitialCriterion(initialCriterion)
                     .withSubCriteria(subCriteria)
                     .build();

src/main/java/org/mybatis/dynamic/sql/dsl/AbstractDeleteDSL.java

@@ -34,8 +34,8 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.util.ConfigurableStatement;
 import org.mybatis.dynamic.sql.util.Validator;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
 import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public abstract class AbstractDeleteDSL<M, D extends AbstractDeleteDSL<M, D>>
         implements WhereOperations<AbstractDeleteDSL<M, D>.DeleteWhereBuilder>,
@@ -161,8 +161,8 @@ public M build() {
             return AbstractDeleteDSL.this.build();
         }
 
-        protected EmbeddedWhereModel buildWhereModel() {
-            return new EmbeddedWhereModel.Builder()
+        protected WhereModel buildWhereModel() {
+            return new WhereModel.Builder()
                     .withInitialCriterion(initialCriterion)
                     .withSubCriteria(subCriteria)
                     .build();

src/main/java/org/mybatis/dynamic/sql/dsl/AbstractUpdateDSL.java

@@ -47,8 +47,8 @@
 import org.mybatis.dynamic.sql.util.ValueMapping;
 import org.mybatis.dynamic.sql.util.ValueOrNullMapping;
 import org.mybatis.dynamic.sql.util.ValueWhenPresentMapping;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
 import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public abstract class AbstractUpdateDSL<M, D extends AbstractUpdateDSL<M, D>>
         implements WhereOperations<AbstractUpdateDSL<M, D>.UpdateWhereBuilder>,
@@ -242,8 +242,8 @@ public M build() {
             return AbstractUpdateDSL.this.build();
         }
 
-        protected EmbeddedWhereModel buildWhereModel() {
-            return new EmbeddedWhereModel.Builder()
+        protected WhereModel buildWhereModel() {
+            return new WhereModel.Builder()
                     .withInitialCriterion(initialCriterion)
                     .withSubCriteria(subCriteria)
                     .build();

…/sql/select/StandaloneHavingBuilder.java …g/mybatis/dynamic/sql/dsl/HavingDSL.javasrc/main/java/org/mybatis/dynamic/sql/select/StandaloneHavingBuilder.java renamed to src/main/java/org/mybatis/dynamic/sql/dsl/HavingDSL.java src/main/java/org/mybatis/dynamic/sql/select/StandaloneHavingBuilder.java renamed to src/main/java/org/mybatis/dynamic/sql/dsl/HavingDSL.java

@@ -13,39 +13,30 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-package org.mybatis.dynamic.sql.select;
+package org.mybatis.dynamic.sql.dsl;
 
 import java.util.ArrayList;
 import java.util.List;
 
 import org.mybatis.dynamic.sql.AndOrCriteriaGroup;
 import org.mybatis.dynamic.sql.SqlCriterion;
-import org.mybatis.dynamic.sql.dsl.BooleanOperations;
-import org.mybatis.dynamic.sql.util.Buildable;
+import org.mybatis.dynamic.sql.select.HavingApplier;
 
-public class StandaloneHavingBuilder implements BooleanOperations<StandaloneHavingBuilder>, Buildable<HavingModel> {
+public class HavingDSL implements BooleanOperations<HavingDSL> {
     private final SqlCriterion initialCriterion;
     private final List<AndOrCriteriaGroup> subCriteria = new ArrayList<>();
 
-    public StandaloneHavingBuilder(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria) {
+    public HavingDSL(SqlCriterion initialCriterion, List<AndOrCriteriaGroup> subCriteria) {
         this.initialCriterion = initialCriterion;
         this.subCriteria.addAll(subCriteria);
     }
 
     @Override
-    public StandaloneHavingBuilder addSubCriterion(AndOrCriteriaGroup subCriterion) {
+    public HavingDSL addSubCriterion(AndOrCriteriaGroup subCriterion) {
         subCriteria.add(subCriterion);
         return this;
     }
 
-    @Override
-    public HavingModel build() {
-        return new HavingModel.Builder()
-                .withInitialCriterion(initialCriterion)
-                .withSubCriteria(subCriteria)
-                .build();
-    }
-
     public HavingApplier toHavingApplier() {
         return new HavingApplier(initialCriterion, subCriteria);
     }

src/main/java/org/mybatis/dynamic/sql/dsl/SelectDSL.java

@@ -42,8 +42,8 @@
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.util.ConfigurableStatement;
 import org.mybatis.dynamic.sql.util.Validator;
-import org.mybatis.dynamic.sql.where.EmbeddedWhereModel;
 import org.mybatis.dynamic.sql.where.WhereApplier;
+import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class SelectDSL implements
         JoinOperations<SelectDSL.JoinSpecificationFinisher>,
@@ -303,8 +303,8 @@ public SelectModel build() {
             return SelectDSL.this.build();
         }
 
-        protected EmbeddedWhereModel buildWhereModel() {
-            return new EmbeddedWhereModel.Builder()
+        protected WhereModel buildWhereModel() {
+            return new WhereModel.Builder()
                     .withInitialCriterion(initialCriterion)
                     .withSubCriteria(subCriteria)
                     .build();