12 July 2018

1 Comment

12 July 2018

1 Comment

SQL Prompt code analysis: avoiding the old-style TOP clause (ST006)

If you want to use TOP with an expression or subquery, or in INSERT, UPDATE, MERGE, and DELETE statements, then use of brackets is required, so it's a good habit to adopt everywhere.

Guest post

This is a guest post from Phil Factor. Phil Factor (real name withheld to protect the guilty), aka Database Mole, has 30 years of experience with database-intensive applications.

Despite having once been shouted at by a furious Bill Gates at an exhibition in the early 1980s, he has remained resolutely anonymous throughout his career.

He is a regular contributor to Simple Talk and SQLServerCentral.

The syntax of the TOP clause insists on a bracketed, or parenthesized, expression as its first argument, so that TOP 34 should, strictly speaking be TOP (34), although if you are just supplying a numeric constant, such as 34, as an argument then either style will work. Early incarnations of TOP could use only a constant value, so the parentheses weren’t necessary, and the old, bracket-less style is still supported so that code written in previous versions of SQL Server will still work.

However, TOP has come a long way since then, and now supports use of an expression, such as (@Rows*2), or a subquery. In these cases, the brackets are necessary. They are also required when TOP is used in INSERT, UPDATE, MERGE, and DELETE statements, so it is a habit worth adopting everywhere. SQL Prompt will raise one of its ‘code style violation’ warnings (ST006) when it spots use of the old-style syntax.

SQL Prompt code analysis style rule ST006

TOP examples

Imagine we want the top ten best performing customers at AdventureWorks.

Listing 1: TOP 10 WITH TIES

This old-style TOP 10 WITH TIES syntax will run quite happily, even though strictly we should be using (10).

results from a top 10 with ties query

However, if you are using a constant scalar subquery, the top 0.1% of all customers in this example, then the parentheses are required.

Listing 2: TOP 0.1% of customers

Using OFFSET and FETCH NEXT as an alternative

If you don’t like being nagged about doing brackets you can happily use OFFSET and FETCH NEXT instead, which don’t require them, although it’s a bit more long-winded.

Listing 3: Using OFFESET and FETCH NEXT

You can’t do ties, but you can specify a variable, parameter, or even constant scalar subquery as an argument to the OFFSET and FETCH NEXT, and you don’t need brackets unless you use a subquery.

Listing 4: Using FETCH NEXT with a subquery

Conclusions

There are worse sins in SQL that leaving out brackets in the parameter to a TOP statement. Strangely, I’ve always felt a bit uncomfortable about leaving them out because it is useful to be reminded of the power of the TOP clause nowadays. It is a long way from the old days of having to temporarily set the ROWCOUNT to the number of rows you wanted returned!

Guest post

This is a guest post from Phil Factor. Phil Factor (real name withheld to protect the guilty), aka Database Mole, has 30 years of experience with database-intensive applications.

Despite having once been shouted at by a furious Bill Gates at an exhibition in the early 1980s, he has remained resolutely anonymous throughout his career.

He is a regular contributor to Simple Talk and SQLServerCentral.

Share this post.

Share on FacebookShare on Google+Share on LinkedInTweet about this on Twitter

You may also like

  • Article

    Quick SQL Prompt tip – why you should expand the wildcard

    One of the great things about SQL Prompt is that it quickly removes the need to use so many keystrokes. That’s helpful and handy, but to become a really efficient T-SQL coder, you’ll want to practice incorporating a few tricks into your routine. Here’s a good one. Often I run into tables and can’t remember

  • Article

    Cleaning up common T-SQL coding issues with SQL Prompt

    Some SQL coding habits are just annoying. Commas in front of column names? No way! Others are actively harmful; they’ll make your code error prone, harder for others to read and understand, and even harder to edit without making mistakes. This article covers five harmful problems that I see regularly in T-SQL code, and shows

  • Article

    The SQL Prompt Functionality Finder

    You have SQL Prompt, but are you aware of all the things it can do and how to get it to do it? Phil Factor provides a handy table to make it obvious.

  • Article

    Quickly rename variables all at once with SQL Prompt

    You’re going to run into situations where someone has made poor choices in naming objects, or maybe the business logic has changed and the object name no longer makes sense. Either way, easily and quickly taking care of renaming the objects within scripts can be a pain. Let’s take this code as an example: The

  • University

    Take the SQL Toolbelt course

    SQL Toolbelt includes all of the components that enable Database DevOps. This step-by-step guide takes you through the process right from being able to analyze the impact of database changes through to making those changes, source controlling them, deploying them out to your target environments, and finally monitoring and documenting those environments.

    Here you will see an overview of each tool and how it can benefit your organization, but be sure to check in the module description whether there is a full course available for the tool you are learning.

  • Forums

    SQL Prompt Forum

    Write, format, and refactor SQL effortlessly

  • Another great post Phil! Even learned some new things myself. 🙂