Introduction to Dynamic SQL
Dynamic SQL is a programming technique that allows you to construct SQL statements dynamically at runtime. It allows you to create more general purpose and flexible SQL statement because the full text of the SQL statements may be unknown at compilation. For example, you can use the dynamic SQL to create a stored procedure that queries data against a table whose name is not known until runtime.
Creating a dynamic SQL is simple, you just need to make it a string as follows:
1 | ‘SELECT * FROM production.products’; |
To execute a dynamic SQL statement, you call the stored procedure sp_executesql
as shown in the following statement:
1 | EXEC sp_executesql N’SELECT * FROM production.products’; |
Because the sp_executesql
accepts the dynamic SQL as a Unicode string, you need to prefix it with an N
.
Though this dynamic SQL is not very useful, it illustrates a dynamic SQL very well.
Using dynamic SQL to query from any table example
First, declare two variables, @table
for holding the name of the table from which you want to query and @sql
for holding the dynamic SQL.
123 | DECLARE @table NVARCHAR(128), @sql NVARCHAR(MAX); |
Second, set the value of the @table
variable to production.products
.
1 | SET @table = N’production.products’; |
Third, construct the dynamic SQL by concatenating the SELECT
statement with the table name parameter:
1 | SET @sql = N’SELECT * FROM ‘ + @table; |
Fourth, call the sp_executesql
stored procedure by passing the @sql
parameter.
1 | EXEC sp_executesql @sql; |
Putting it all together:
123456789 | DECLARE @table NVARCHAR(128), @sql NVARCHAR(MAX); SET @table = N’production.products’; SET @sql = N’SELECT * FROM ‘ + @table; EXEC sp_executesql @sql; |
The code block above produces the exact result set as the following statement:
1 | SELECT * FROM production.products; |
To query data from another table, you change the value of the @table
variable. However, it’s more practical if we wrap the above T-SQL block in a stored procedure.
SQL Server dynamic SQL and stored procedures
This stored procedure accepts any table and returns the result set from a specified table by using the dynamic SQL:
12345678910111213 | CREATE PROC usp_query ( @table NVARCHAR(128))ASBEGIN DECLARE @sql NVARCHAR(MAX); — construct SQL SET @sql = N’SELECT * FROM ‘ + @table; — execute the SQL EXEC sp_executesql @sql; END; |
The following statement calls the usp_query
stored procedure to return all rows from the production.brands
table:
1 | EXEC usp_query ‘production.brands’; |
This stored procedure returns the top 10 rows from a table by the values of a specified column:
123456789101112131415161718192021 | CREATE OR ALTER PROC usp_query_topn( @table NVARCHAR(128), @topN INT, @byColumn NVARCHAR(128))ASBEGIN DECLARE @sql NVARCHAR(MAX), @topNStr NVARCHAR(MAX); SET @topNStr = CAST(@topN as nvarchar(max)); — construct SQL SET @sql = N’SELECT TOP ‘ + @topNStr + ‘ * FROM ‘ + @table + ‘ ORDER BY ‘ + @byColumn + ‘ DESC’; — execute the SQL EXEC sp_executesql @sql; END; |
For example, you can get the top 10 most expensive products from the production.products
table:
1234 | EXEC usp_query_topn ‘production.products’, 10, ‘list_price’; |
This statement returns the top 10 products with the highest quantity in stock:
1234 | EXEC usp_query_topn ‘production.tocks’, 10, ‘quantity’; |
SQL Server Dynamic SQL and SQL Injection
Let’s create a new table named sales.tests
for the demonstration:
1 | CREATE TABLE sales.tests(id INT); |
This statement returns all rows from the production.brands
table:
1 | EXEC usp_query ‘production.brands’; |
But it does not prevent users from passing the table name as follows:
1 | EXEC usp_query ‘production.brands;DROP TABLE sales.tests’; |
This technique is called SQL injection. Once the statement is executed, the sales.tests
table is dropped, because the stored procedure usp_query
executes both statements:
1 | SELECT * FROM production.brands;DROP TABLE sales.tests |
To prevent this SQL injection, you can use the QUOTENAME()
function as shown in the following query:
1234567891011121314151617 | CREATE OR ALTER PROC usp_query( @schema NVARCHAR(128), @table NVARCHAR(128))AS BEGIN DECLARE @sql NVARCHAR(MAX); — construct SQL SET @sql = N’SELECT * FROM ‘ + QUOTENAME(@schema) + ‘.’ + QUOTENAME(@table); — execute the SQL EXEC sp_executesql @sql; END; |
Now, if you pass the schema and table name to the stored procedure, it will work:
1 | EXEC usp_query ‘production’,’brands’; |
However, if you try to inject another statement such as:
123 | EXEC usp_query ‘production’, ‘brands;DROP TABLE sales.tests’; |
It will issue the following error:
1 | Invalid object name ‘production.brands;DROP TABLE sales.tests’. |
More on sp_executesql
stored procedure
The sp_executesql
has the following syntax:
123456 | EXEC sp_executesql sql_statement parameter_definition @param1 = value1, @param2 = value2, … |
In this syntax:
sql_statement
is a Unicode string that contains a T-SQL statement. Thesql_statement
can contain parameters such asSELECT * FROM table_name WHERE id=@id
parameter_definition
is a string that contains the definition of all parameters embedded in thesql_statement
. Each parameter definition consists of a parameter name and its data type e.g.,@id INT
. The parameter definitions are separated by a comma (,).@param1 = value1
,@param2 = value2
,… specify a value for every parameter defined in theparameter_definition
string.
This example uses the sp_executesql
stored procedure to find products which have list price greater than 100 and category 1:
12345678910111213 | EXEC sp_executesqlN’SELECT * FROM production.products WHERE list_price> @listPrice AND category_id = @categoryId ORDER BY list_price DESC’, N’@listPrice DECIMAL(10,2),@categoryId INT’,@listPrice = 100,@categoryId = 1; |