Add support for sqlserver TOP syntax as custom SQL. fixes issue #18

jahlborn · jahlborn · commit b8836617802a · 2016-03-16T02:33:36.000Z
git-svn-id: https://svn.code.sf.net/p/openhms/code/sqlbuilder/trunk@499 f9ba57bc-9804-47c6-9de9-2f2ff8aac994
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -4,6 +4,14 @@
     <author email="jahlborn@users.sf.net">James Ahlborn</author>
   </properties>
   <body>
+    <release version="2.1.3" date="TBD">
+      <action dev="jahlborn" type="update" issue="18">
+        Add support for sqlserver TOP syntax as custom SQL.
+      </action>
+      <action dev="jahlborn" type="update">
+        Add support for SQL 2008 OFFSET and FETCH NEXT clauses in SELECT queries.
+      </action>
+    </release>
     <release version="2.1.2" date="2016-01-30">
       <action dev="jahlborn" type="update">
         New site style!
diff --git a/src/main/java/com/healthmarketscience/sqlbuilder/CustomizableSqlObject.java b/src/main/java/com/healthmarketscience/sqlbuilder/CustomizableSqlObject.java
@@ -81,7 +81,8 @@ protected void maybeAppendTo(AppendableExt app, HookAnchor anchor,
   }
 
   /**
-   * Appends any {@link HookType#BEFORE} customizations for the given anchor.
+   * Appends any {@link HookType#BEFORE} or {@link HookType#AFTER}
+   * customizations for the given anchor.
    */
   protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor)
     throws IOException
@@ -90,6 +91,7 @@ protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor)
     if((_customizations != null) &&
        ((custs = findCustomizations(anchor)) != null)) {
       appendCustomizations(app, custs, HookType.BEFORE);
+      appendCustomizations(app, custs, HookType.AFTER);
     }
     return app;
   }
@@ -113,6 +115,7 @@ protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor,
       app.append(str);
     }
     appendCustomizations(app, custs, HookType.SUFFIX);
+    appendCustomizations(app, custs, HookType.AFTER);
     return app;
   }
 
diff --git a/src/main/java/com/healthmarketscience/sqlbuilder/custom/HookType.java b/src/main/java/com/healthmarketscience/sqlbuilder/custom/HookType.java
@@ -26,10 +26,10 @@
  * REPLACEMENT} type is used, the anchor text itself will <i>not</i> be
  * inserted.
  * <p/>
- * The {@code BEFORE} type, while similar in location to the {@code PREFIX}
- * type, is included regardless of whether or not the anchor clause itself is
- * included (it is more related to the surrounding clause than the anchor
- * clause itself).
+ * The {@code BEFORE} and {@code AFTER} types, while similar in location to
+ * the {@code PREFIX} and {@code SUFFIX} types (respectively), are included
+ * regardless of whether or not the anchor clause itself is included (they are
+ * more related to the surrounding clause than the anchor clause itself).
  * <p>
  * Note that customizable queries support multiple instances of each type for
  * a given anchor.  Multiple customizations of the same type will be inserted
@@ -61,5 +61,12 @@ public enum HookType
    * Customization which is inserted after the anchor clause, but only if the
    * anchor clause itself is included in the query.
    */
-  SUFFIX;
+  SUFFIX,
+  /**
+   * Customization which is inserted after the anchor clause.  Unlike the
+   * {@code SUFFIX} type, this type of customization will <i>always</i> be
+   * inserted regardless of whether or not the related anchor clause itself is
+   * included in the query.
+   */
+  AFTER;
 }
diff --git a/src/main/java/com/healthmarketscience/sqlbuilder/custom/package-info.java b/src/main/java/com/healthmarketscience/sqlbuilder/custom/package-info.java
@@ -68,6 +68,7 @@
  * <li>Oracle {@link com.healthmarketscience.sqlbuilder.custom.oracle}</li>
  * <li>MySQL {@link com.healthmarketscience.sqlbuilder.custom.mysql}</li>
  * <li>PostreSQL {@link com.healthmarketscience.sqlbuilder.custom.postgresql}</li>
+ * <li>SQLServer {@link com.healthmarketscience.sqlbuilder.custom.sqlserver}</li>
  * </ul>
  * <p/>
  * <h3>Customizable Queries</h3>
diff --git a/src/main/java/com/healthmarketscience/sqlbuilder/custom/sqlserver/MssTopClause.java b/src/main/java/com/healthmarketscience/sqlbuilder/custom/sqlserver/MssTopClause.java
@@ -0,0 +1,73 @@
+/*
+Copyright (c) 2016 James Ahlborn
+
+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 com.healthmarketscience.sqlbuilder.custom.sqlserver;
+
+import java.io.IOException;
+
+import com.healthmarketscience.common.util.AppendableExt;
+import com.healthmarketscience.sqlbuilder.Converter;
+import com.healthmarketscience.sqlbuilder.SelectQuery;
+import com.healthmarketscience.sqlbuilder.SqlObject;
+import com.healthmarketscience.sqlbuilder.ValidationContext;
+import com.healthmarketscience.sqlbuilder.custom.CustomSyntax;
+import com.healthmarketscience.sqlbuilder.custom.HookType;
+
+/**
+ * Appends a SQLServer TOP clause like {@code " TOP <count> [PERCENT]"} for
+ * use in {@link SelectQuery}s.
+ *
+ * @see SelectQuery#addCustomization(CustomSyntax)
+ * 
+ * @author James Ahlborn
+ */
+public class MssTopClause extends CustomSyntax
+{
+  private SqlObject _count;
+  private boolean _isPercent;
+
+  public MssTopClause(Object count) {
+    this(count, false);
+  }
+
+  public MssTopClause(Object count, boolean isPercent) {
+    _count = Converter.toValueSqlObject(count);
+    _isPercent = isPercent;
+  }
+
+  public MssTopClause setIsPercent(boolean isPercent) {
+    _isPercent = isPercent;
+    return this;
+  }
+
+  @Override
+  public void apply(SelectQuery query) {
+    query.addCustomization(SelectQuery.Hook.DISTINCT, HookType.AFTER, this);
+  }
+
+  @Override
+  public void appendTo(AppendableExt app) throws IOException {
+    app.append("TOP ").append(_count).append(" ");
+    if(_isPercent) {
+      app.append("PERCENT ");
+    }
+  }
+
+  @Override
+  protected void collectSchemaObjects(ValidationContext vContext) {
+    collectSchemaObjects(_count, vContext);
+  }
+}
diff --git a/src/test/java/com/healthmarketscience/sqlbuilder/custom/CustomSyntaxTest.java b/src/test/java/com/healthmarketscience/sqlbuilder/custom/CustomSyntaxTest.java
@@ -29,6 +29,7 @@
 import com.healthmarketscience.sqlbuilder.custom.postgresql.PgLimitClause;
 import com.healthmarketscience.sqlbuilder.custom.postgresql.PgOffsetClause;
 import com.healthmarketscience.sqlbuilder.custom.postgresql.PgObjects;
+import com.healthmarketscience.sqlbuilder.custom.sqlserver.MssTopClause;
 import com.healthmarketscience.sqlbuilder.dbspec.basic.DbIndex;
 
 /**
@@ -205,4 +206,21 @@ public void testOracleLimitClause()
                 "SELECT t0.col1 FROM Schema1.Table1 t0 WHERE (ROWNUM < 100)");
   }
 
+  public void testSQLServerTopClause()
+  {
+    String selectQuery1 = new SelectQuery()
+      .addColumns(_table1_col1)
+      .addCustomization(new MssTopClause(10))
+      .validate().toString();
+    checkResult(selectQuery1,
+                "SELECT TOP 10 t0.col1 FROM Schema1.Table1 t0");
+
+    String selectQuery2 = new SelectQuery()
+      .addColumns(_table1_col1)
+      .setIsDistinct(true)
+      .addCustomization(new MssTopClause(30, true))
+      .validate().toString();
+    checkResult(selectQuery2,
+                "SELECT DISTINCT TOP 30 PERCENT t0.col1 FROM Schema1.Table1 t0");
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,8 @@ protected void maybeAppendTo(AppendableExt app, HookAnchor anchor,`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`/**`
`84`		`- * Appends any {@link HookType#BEFORE} customizations for the given anchor.`
	`84`	`+ * Appends any {@link HookType#BEFORE} or {@link HookType#AFTER}`
	`85`	`+ * customizations for the given anchor.`
`85`	`86`	`*/`
`86`	`87`	`protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor)`
`87`	`88`	`throws IOException`
`@@ -90,6 +91,7 @@ protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor)`
`90`	`91`	`if((_customizations != null) &&`
`91`	`92`	`((custs = findCustomizations(anchor)) != null)) {`
`92`	`93`	`appendCustomizations(app, custs, HookType.BEFORE);`
	`94`	`+ appendCustomizations(app, custs, HookType.AFTER);`
`93`	`95`	`}`
`94`	`96`	`return app;`
`95`	`97`	`}`
`@@ -113,6 +115,7 @@ protected AppendableExt customAppendTo(AppendableExt app, HookAnchor anchor,`
`113`	`115`	`app.append(str);`
`114`	`116`	`}`
`115`	`117`	`appendCustomizations(app, custs, HookType.SUFFIX);`
	`118`	`+ appendCustomizations(app, custs, HookType.AFTER);`
`116`	`119`	`return app;`
`117`	`120`	`}`
`118`	`121`