Add order by on delete statement

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/select/OrderByModel.java renamed to src/main/java/org/mybatis/dynamic/sql/common/OrderByModel.java

@@ -13,7 +13,7 @@
  *    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.common;
 
 import java.util.ArrayList;
 import java.util.Collection;

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

@@ -0,0 +1,37 @@
+/*
+ *    Copyright 2016-2022 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
+ *
+ *       https://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.mybatis.dynamic.sql.common;
+
+import java.util.stream.Collectors;
+
+import org.mybatis.dynamic.sql.SortSpecification;
+import org.mybatis.dynamic.sql.util.FragmentAndParameters;
+
+public class OrderByRenderer {
+    public FragmentAndParameters render(OrderByModel orderByModel) {
+        String phrase = orderByModel.mapColumns(this::calculateOrderByPhrase)
+                .collect(Collectors.joining(", ", "order by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+        return FragmentAndParameters.withFragment(phrase).build();
+    }
+
+    private String calculateOrderByPhrase(SortSpecification column) {
+        String phrase = column.orderByName();
+        if (column.isDescending()) {
+            phrase = phrase + " DESC"; //$NON-NLS-1$
+        }
+        return phrase;
+    }
+}

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

@@ -15,13 +15,17 @@
  */
 package org.mybatis.dynamic.sql.delete;
 
+import java.util.Arrays;
+import java.util.Collection;
 import java.util.Objects;
 import java.util.function.Consumer;
 import java.util.function.Function;
 
 import org.jetbrains.annotations.NotNull;
+import org.mybatis.dynamic.sql.SortSpecification;
 import org.mybatis.dynamic.sql.SqlTable;
 import org.mybatis.dynamic.sql.configuration.StatementConfiguration;
+import org.mybatis.dynamic.sql.common.OrderByModel;
 import org.mybatis.dynamic.sql.util.Buildable;
 import org.mybatis.dynamic.sql.where.AbstractWhereDSL;
 import org.mybatis.dynamic.sql.where.AbstractWhereSupport;
@@ -36,6 +40,7 @@ public class DeleteDSL<R> extends AbstractWhereSupport<DeleteDSL<R>.DeleteWhereB
     private DeleteWhereBuilder whereBuilder;
     private final StatementConfiguration statementConfiguration = new StatementConfiguration();
     private Long limit;
+    private OrderByModel orderByModel;
 
     private DeleteDSL(SqlTable table, String tableAlias, Function<DeleteModel, R> adapterFunction) {
         this.table = Objects.requireNonNull(table);
@@ -56,6 +61,15 @@ public DeleteDSL<R> limit(long limit) {
         return this;
     }
 
+    public DeleteDSL<R> orderBy(SortSpecification... columns) {
+        return orderBy(Arrays.asList(columns));
+    }
+
+    public DeleteDSL<R> orderBy(Collection<SortSpecification> columns) {
+        orderByModel = OrderByModel.of(columns);
+        return this;
+    }
+
     /**
      * WARNING! Calling this method could result in a delete statement that deletes
      * all rows in a table.
@@ -67,7 +81,8 @@ public DeleteDSL<R> limit(long limit) {
     public R build() {
         DeleteModel.Builder deleteModelBuilder = DeleteModel.withTable(table)
                 .withTableAlias(tableAlias)
-                .withLimit(limit);
+                .withLimit(limit)
+                .withOrderByModel(orderByModel);
         if (whereBuilder != null) {
             deleteModelBuilder.withWhereModel(whereBuilder.buildWhereModel());
         }
@@ -104,6 +119,15 @@ public DeleteDSL<R> limit(long limit) {
             return DeleteDSL.this.limit(limit);
         }
 
+        public DeleteDSL<R> orderBy(SortSpecification... columns) {
+            return orderBy(Arrays.asList(columns));
+        }
+
+        public DeleteDSL<R> orderBy(Collection<SortSpecification> columns) {
+            orderByModel = OrderByModel.of(columns);
+            return DeleteDSL.this;
+        }
+
         @NotNull
         @Override
         public R build() {

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

@@ -23,19 +23,22 @@
 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.common.OrderByModel;
 import org.mybatis.dynamic.sql.where.WhereModel;
 
 public class DeleteModel {
     private final SqlTable table;
     private final String tableAlias;
     private final WhereModel whereModel;
     private final Long limit;
+    private final OrderByModel orderByModel;
 
     private DeleteModel(Builder builder) {
         table = Objects.requireNonNull(builder.table);
         whereModel = builder.whereModel;
         tableAlias = builder.tableAlias;
         limit = builder.limit;
+        orderByModel = builder.orderByModel;
     }
 
     public SqlTable table() {
@@ -54,6 +57,10 @@ public Optional<Long> limit() {
         return Optional.ofNullable(limit);
     }
 
+    public Optional<OrderByModel> orderByModel() {
+        return Optional.ofNullable(orderByModel);
+    }
+
     @NotNull
     public DeleteStatementProvider render(RenderingStrategy renderingStrategy) {
         return DeleteRenderer.withDeleteModel(this)
@@ -71,6 +78,7 @@ public static class Builder {
         private String tableAlias;
         private WhereModel whereModel;
         private Long limit;
+        private OrderByModel orderByModel;
 
         public Builder withTable(SqlTable table) {
             this.table = table;
@@ -92,6 +100,11 @@ public Builder withLimit(Long limit) {
             return this;
         }
 
+        public Builder withOrderByModel(OrderByModel orderByModel) {
+            this.orderByModel = orderByModel;
+            return this;
+        }
+
         public DeleteModel build() {
             return new DeleteModel(this);
         }

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

@@ -21,10 +21,12 @@
 import java.util.stream.Collectors;
 
 import org.mybatis.dynamic.sql.SqlTable;
+import org.mybatis.dynamic.sql.common.OrderByRenderer;
 import org.mybatis.dynamic.sql.delete.DeleteModel;
 import org.mybatis.dynamic.sql.render.ExplicitTableAliasCalculator;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.render.TableAliasCalculator;
+import org.mybatis.dynamic.sql.common.OrderByModel;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 import org.mybatis.dynamic.sql.where.WhereModel;
@@ -49,6 +51,7 @@ public DeleteStatementProvider render() {
 
         fragmentCollector.add(calculateDeleteStatementStart());
         calculateWhereClause().ifPresent(fragmentCollector::add);
+        calculateOrderByClause().ifPresent(fragmentCollector::add);
         calculateLimitClause().ifPresent(fragmentCollector::add);
 
         return toDeleteStatementProvider(fragmentCollector);
@@ -98,6 +101,15 @@ private FragmentAndParameters renderLimitClause(Long limit) {
                 .build();
     }
 
+    private Optional<FragmentAndParameters> calculateOrderByClause() {
+        return deleteModel.orderByModel().map(this::renderOrderByClause);
+    }
+
+    private FragmentAndParameters renderOrderByClause(OrderByModel orderByModel) {
+        OrderByRenderer renderer = new OrderByRenderer();
+        return renderer.render(orderByModel);
+    }
+
     public static Builder withDeleteModel(DeleteModel deleteModel) {
         return new Builder().withDeleteModel(deleteModel);
     }

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

@@ -29,6 +29,7 @@
 import org.mybatis.dynamic.sql.SortSpecification;
 import org.mybatis.dynamic.sql.SqlTable;
 import org.mybatis.dynamic.sql.TableExpression;
+import org.mybatis.dynamic.sql.common.OrderByModel;
 import org.mybatis.dynamic.sql.configuration.StatementConfiguration;
 import org.mybatis.dynamic.sql.select.QueryExpressionDSL.FromGatherer;
 import org.mybatis.dynamic.sql.util.Buildable;

src/main/java/org/mybatis/dynamic/sql/select/SelectModel.java

@@ -23,6 +23,7 @@
 import java.util.stream.Stream;
 
 import org.jetbrains.annotations.NotNull;
+import org.mybatis.dynamic.sql.common.OrderByModel;
 import org.mybatis.dynamic.sql.exception.InvalidSqlException;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.select.render.SelectRenderer;

src/main/java/org/mybatis/dynamic/sql/select/render/QueryExpressionRenderer.java

@@ -32,7 +32,6 @@
 import org.mybatis.dynamic.sql.select.GroupByModel;
 import org.mybatis.dynamic.sql.select.QueryExpressionModel;
 import org.mybatis.dynamic.sql.select.join.JoinModel;
-import org.mybatis.dynamic.sql.util.CustomCollectors;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 import org.mybatis.dynamic.sql.where.WhereModel;
@@ -194,7 +193,7 @@ private Optional<FragmentAndParameters> calculateGroupByClause() {
 
     private FragmentAndParameters renderGroupBy(GroupByModel groupByModel) {
         String groupBy = groupByModel.mapColumns(this::applyTableAlias)
-                .collect(CustomCollectors.joining(", ", "group by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+                .collect(Collectors.joining(", ", "group by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
         return FragmentAndParameters.withFragment(groupBy).build();
     }
 

src/main/java/org/mybatis/dynamic/sql/select/render/SelectRenderer.java

@@ -20,14 +20,13 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.stream.Collectors;
 
-import org.mybatis.dynamic.sql.SortSpecification;
+import org.mybatis.dynamic.sql.common.OrderByRenderer;
 import org.mybatis.dynamic.sql.render.RenderingStrategy;
 import org.mybatis.dynamic.sql.render.TableAliasCalculator;
-import org.mybatis.dynamic.sql.select.OrderByModel;
+import org.mybatis.dynamic.sql.common.OrderByModel;
 import org.mybatis.dynamic.sql.select.PagingModel;
 import org.mybatis.dynamic.sql.select.QueryExpressionModel;
 import org.mybatis.dynamic.sql.select.SelectModel;
-import org.mybatis.dynamic.sql.util.CustomCollectors;
 import org.mybatis.dynamic.sql.util.FragmentAndParameters;
 import org.mybatis.dynamic.sql.util.FragmentCollector;
 
@@ -80,17 +79,8 @@ private Optional<FragmentAndParameters> renderOrderBy() {
     }
 
     private FragmentAndParameters renderOrderBy(OrderByModel orderByModel) {
-        String phrase = orderByModel.mapColumns(this::calculateOrderByPhrase)
-                .collect(CustomCollectors.joining(", ", "order by ", "")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
-        return FragmentAndParameters.withFragment(phrase).build();
-    }
-
-    private String calculateOrderByPhrase(SortSpecification column) {
-        String phrase = column.orderByName();
-        if (column.isDescending()) {
-            phrase = phrase + " DESC"; //$NON-NLS-1$
-        }
-        return phrase;
+        OrderByRenderer renderer = new OrderByRenderer();
+        return renderer.render(orderByModel);
     }
 
     private Optional<FragmentAndParameters> renderPagingModel() {