WITH Common_table_expression (Transact-SQL) - SQL Server Microsoft Learn
WITH Common_table_expression (Transact-SQL) - SQL Server Microsoft Learn
Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics
Analytics Platform System (PDW) SQL analytics endpoint in Microsoft Fabric Warehouse in Microsoft Fabric
Specifies a temporary named result set, known as a common table expression (CTE). This is derived from a simple query and
defined within the execution scope of a single SELECT, INSERT, UPDATE, DELETE or MERGE statement. This clause can also be
used in a CREATE VIEW statement as part of its defining SELECT statement. A common table expression can include references
to itself. This is referred to as a recursive common table expression.
Syntax
syntaxsql
<common_table_expression>::=
expression_name [ ( column_name [ ,...n ] ) ]
AS
( CTE_query_definition )
7 Note
To view Transact-SQL syntax for SQL Server 2014 (12.x) and earlier versions, see Previous versions documentation.
Arguments
expression_name
A valid identifier for the common table expression. expression_name must be different from the name of any other common
table expression defined in the same WITH <common_table_expression> clause, but expression_name can be the same as the
name of a base table or view. Any reference to expression_name in the query uses the common table expression and not the
base object.
column_name
Specifies a column name in the common table expression. Duplicate names within a single CTE definition aren't allowed. The
number of column names specified must match the number of columns in the result set of the CTE_query_definition. The list of
column names is optional only if distinct names for all resulting columns are supplied in the query definition.
CTE_query_definition
Specifies a SELECT statement whose result set populates the common table expression. The SELECT statement for
CTE_query_definition must meet the same requirements as for creating a view, except a CTE can't define another CTE. For more
information, see the Remarks section and CREATE VIEW (Transact-SQL).
If more than one CTE_query_definition is defined, the query definitions must be joined by one of these set operators: UNION
ALL, UNION, EXCEPT, or INTERSECT.
• A CTE must be followed by a single SELECT , INSERT , UPDATE , or DELETE statement that references some or all the CTE
columns. A CTE can also be specified in a CREATE VIEW statement as part of the defining SELECT statement of the view.
• Multiple CTE query definitions can be defined in a nonrecursive CTE. The definitions must be combined by one of these set
operators: UNION ALL , UNION , INTERSECT , or EXCEPT .
• A CTE can reference itself and previously defined CTEs in the same WITH clause. Forward referencing isn't allowed.
• Specifying more than one WITH clause in a CTE isn't allowed. For example, if a CTE_query_definition contains a subquery,
that subquery can't contain a nested WITH clause that defines another CTE.
◦ INTO
◦ FOR BROWSE
• When a CTE is used in a statement that is part of a batch, the statement before it must be followed by a semicolon.
• When executing a CTE, any hints that reference a CTE may conflict with other hints that are discovered when the CTE
accesses its underlying tables, in the same manner as hints that reference views in queries. When this occurs, the query
returns an error.
• The recursive CTE definition must contain at least two CTE query definitions, an anchor member and a recursive member.
Multiple anchor members and recursive members can be defined; however, all anchor member query definitions must be
put before the first recursive member definition. All CTE query definitions are anchor members unless they reference the
CTE itself.
• Anchor members must be combined by one of these set operators: UNION ALL, UNION, INTERSECT, or EXCEPT. UNION
ALL is the only set operator allowed between the last anchor member and first recursive member, and when combining
multiple recursive members.
• The number of columns in the anchor and recursive members must be the same.
• The data type of a column in the recursive member must be the same as the data type of the corresponding column in the
anchor member.
• The FROM clause of a recursive member must refer only one time to the CTE expression_name.
◦ SELECT DISTINCT
◦ GROUP BY
◦ PIVOT (When the database compatibility level is 110 or higher. See Breaking Changes to Database Engine Features in
SQL Server 2016.)
◦ HAVING
◦ Scalar aggregation
◦ TOP
◦ Subqueries
• All columns returned by the recursive CTE are nullable regardless of the nullability of the columns returned by the
participating SELECT statements.
• An incorrectly composed recursive CTE may cause an infinite loop. For example, if the recursive member query definition
returns the same values for both the parent and child columns, an infinite loop is created. To prevent an infinite loop, you
can limit the number of recursion levels allowed for a particular statement by using the MAXRECURSION hint and a value
between 0 and 32,767 in the OPTION clause of the INSERT , UPDATE , DELETE , or SELECT statement. This lets you control the
execution of the statement until you resolve the code problem that is creating the loop. The server-wide default is 100.
When 0 is specified, no limit is applied. Only one MAXRECURSION value can be specified per statement. For more
information, see Query Hints (Transact-SQL).
• A view that contains a recursive common table expression can't be used to update data.
• Cursors may be defined on queries using CTEs. The CTE is the select_statement argument that defines the result set of the
cursor. Only fast forward-only and static (snapshot) cursors are allowed for recursive CTEs. If another cursor type is
specified in a recursive CTE, the cursor type is converted to static.
• Tables on remote servers may be referenced in the CTE. If the remote server is referenced in the recursive member of the
CTE, a spool is created for each remote table so the tables can be repeatedly accessed locally. If it is a CTE query, Index
Spool/Lazy Spools are displayed in the query plan, and will have the additional WITH STACK predicate. This is one way to
confirm proper recursion.
• Analytic and aggregate functions in the recursive part of the CTE are applied to the set for the current recursion level and
not to the set for the CTE. Functions like ROW_NUMBER operate only on the subset of data passed to them by the current
recursion level and not the entire set of data passed to the recursive part of the CTE. For more information, see example I.
Use analytical functions in a recursive CTE that follows.
• A CTE must be followed by a single SELECT statement. INSERT , UPDATE , DELETE , and MERGE statements aren't supported.
• A common table expression that includes references to itself (a recursive common table expression) isn't supported.
• Specifying more than one WITH clause in a CTE isn't allowed. For example, if a CTE query definition contains a subquery,
that subquery can't contain a nested WITH clause that defines another CTE.
• An ORDER BY clause can't be used in the CTE_query_definition, except when a TOP clause is specified.
• When a CTE is used in a statement that is part of a batch, the statement before it must be followed by a semicolon.
• When used in statements prepared by sp_prepare , CTEs will behave the same way as other SELECT statements in PDW.
However, if CTEs are used as part of CETAS prepared by sp_prepare , the behavior can defer from SQL Server and other
PDW statements because of the way binding is implemented for sp_prepare . If SELECT that references CTE is using a
wrong column that doesn't exist in CTE, the sp_prepare will pass without detecting the error, but the error will be thrown
during sp_execute instead.
Examples
SQL
SQL
SQL
)
, -- Use a comma to separate multiple CTE definitions.
-- Define the second CTE query, which returns sales quota data by year for each sales person.
Sales_Quota_CTE (BusinessEntityID, SalesQuota, SalesQuotaYear)
AS
(
SELECT BusinessEntityID, SUM(SalesQuota)AS SalesQuota, YEAR(QuotaDate) AS SalesQuotaYear
FROM Sales.SalesPersonQuotaHistory
GROUP BY BusinessEntityID, YEAR(QuotaDate)
)
Output
SQL
SQL
SQL
SQL
intentionally creates an infinite loop and uses the MAXRECURSION hint to limit the number of recursion levels to two.
SQL
After the coding error is corrected, MAXRECURSION is no longer required. The following example shows the corrected code.
SQL
The following example shows the hierarchy of product assemblies and components that are required to build the bicycle for
ProductAssemblyID = 800 .
SQL
USE AdventureWorks2022;
GO
WITH Parts(AssemblyID, ComponentID, PerAssemblyQty, EndDate, ComponentLevel) AS
(
SELECT b.ProductAssemblyID, b.ComponentID, b.PerAssemblyQty,
b.EndDate, 0 AS ComponentLevel
FROM Production.BillOfMaterials AS b
WHERE b.ProductAssemblyID = 800
AND b.EndDate IS NULL
UNION ALL
SELECT bom.ProductAssemblyID, bom.ComponentID, p.PerAssemblyQty,
bom.EndDate, ComponentLevel + 1
FROM Production.BillOfMaterials AS bom
INNER JOIN Parts AS p
ON bom.ProductAssemblyID = p.ComponentID
AND bom.EndDate IS NULL
)
SELECT AssemblyID, ComponentID, Name, PerAssemblyQty, EndDate,
ComponentLevel
FROM Parts AS p
INNER JOIN Production.Product AS pr
ON p.ComponentID = pr.ProductID
ORDER BY ComponentLevel, AssemblyID, ComponentID;
SQL
USE AdventureWorks2022;
GO
WITH Parts(AssemblyID, ComponentID, PerAssemblyQty, EndDate, ComponentLevel) AS
(
SELECT b.ProductAssemblyID, b.ComponentID, b.PerAssemblyQty,
b.EndDate, 0 AS ComponentLevel
FROM Production.BillOfMaterials AS b
WHERE b.ProductAssemblyID = 800
AND b.EndDate IS NULL
UNION ALL
SELECT bom.ProductAssemblyID, bom.ComponentID, p.PerAssemblyQty,
bom.EndDate, ComponentLevel + 1
FROM Production.BillOfMaterials AS bom
INNER JOIN Parts AS p
ON bom.ProductAssemblyID = p.ComponentID
AND bom.EndDate IS NULL
)
UPDATE Production.BillOfMaterials
SET PerAssemblyQty = c.PerAssemblyQty * 2
FROM Production.BillOfMaterials AS c
JOIN Parts AS d ON c.ProductAssemblyID = d.AssemblyID
WHERE d.ComponentLevel = 0;
SQL
-- Genealogy table
IF OBJECT_ID('dbo.Person','U') IS NOT NULL DROP TABLE dbo.Person;
GO
CREATE TABLE dbo.Person(ID int, Name VARCHAR(30), Mother INT, Father INT);
GO
INSERT dbo.Person
VALUES(1, 'Sue', NULL, NULL)
,(2, 'Ed', NULL, NULL)
,(3, 'Emma', 1, 2)
,(4, 'Jack', 1, 2)
,(5, 'Jane', NULL, NULL)
,(6, 'Bonnie', 5, 4)
,(7, 'Bill', 5, 4);
GO
-- Create the recursive CTE to find all of Bonnie's ancestors.
WITH Generation (ID) AS
(
-- First anchor member returns Bonnie's mother.
SELECT Mother
FROM dbo.Person
WHERE Name = 'Bonnie'
UNION
-- Second anchor member returns Bonnie's father.
SELECT Father
FROM dbo.Person
WHERE Name = 'Bonnie'
UNION ALL
-- First recursive member returns male ancestors of the previous generation.
SELECT Person.Father
FROM Generation, Person
WHERE Generation.ID=Person.ID
UNION ALL
-- Second recursive member returns female ancestors of the previous generation.
SELECT Person.Mother
FROM Generation, dbo.Person
WHERE Generation.ID=Person.ID
)
SELECT Person.ID, Person.Name, Person.Mother, Person.Father
FROM Generation, dbo.Person
WHERE Generation.ID = Person.ID;
GO
SQL
WITH vw AS
(
SELECT itmIDComp, itmID
FROM @t1
UNION ALL
UNION ALL
SELECT t.itmIDComp
, t.itmID
, ROW_NUMBER() OVER(PARTITION BY t.itmIDComp ORDER BY t.itmIDComp, t.itmID) AS N
, Lvl + 1
FROM r
JOIN vw AS t ON t.itmID = r.itmIDComp
)
The following results are the expected results for the query.
Output
Lvl N
1 0
1 0
1 0
1 0
2 4
2 3
2 2
2 1
The following results are the actual results for the query.
Output
Lvl N
1 0
1 0
1 0
1 0
2 1
2 1
2 1
2 1
N returns 1 for each pass of the recursive part of the CTE because only the subset of data for that recursion level is passed to
ROWNUMBER . For each of the iterations of the recursive part of the query, only one row is passed to ROWNUMBER .
SQL
USE AdventureWorks2022;
GO
CREATE TABLE SalesOrdersPerYear
WITH
(
DISTRIBUTION = HASH(SalesPersonID)
)
AS
-- Define the CTE expression name and column list.
WITH Sales_CTE (SalesPersonID, SalesOrderID, SalesYear)
AS
-- Define the CTE query.
(
SELECT SalesPersonID, SalesOrderID, YEAR(OrderDate) AS SalesYear
FROM Sales.SalesOrderHeader
WHERE SalesPersonID IS NOT NULL
)
-- Define the outer query referencing the CTE name.
SELECT SalesPersonID, COUNT(SalesOrderID) AS TotalSales, SalesYear
FROM Sales_CTE
GROUP BY SalesYear, SalesPersonID
ORDER BY SalesPersonID, SalesYear;
GO
SQL
USE AdventureWorks2022;
GO
CREATE EXTERNAL TABLE SalesOrdersPerYear
WITH
(
LOCATION = 'hdfs://xxx.xxx.xxx.xxx:5000/files/Customer',
FORMAT_OPTIONS ( FIELD_TERMINATOR = '|' )
)
AS
-- Define the CTE expression name and column list.
WITH Sales_CTE (SalesPersonID, SalesOrderID, SalesYear)
AS
-- Define the CTE query.
(
SELECT SalesPersonID, SalesOrderID, YEAR(OrderDate) AS SalesYear
FROM Sales.SalesOrderHeader
WHERE SalesPersonID IS NOT NULL
)
-- Define the outer query referencing the CTE name.
SELECT SalesPersonID, COUNT(SalesOrderID) AS TotalSales, SalesYear
FROM Sales_CTE
GROUP BY SalesYear, SalesPersonID
ORDER BY SalesPersonID, SalesYear;
GO
SQL
WITH
CountDate (TotalCount, TableName) AS
(
SELECT COUNT(datekey), 'DimDate' FROM DimDate
) ,
CountCustomer (TotalAvg, TableName) AS
(
SELECT COUNT(CustomerKey), 'DimCustomer' FROM DimCustomer
)
SELECT TableName, TotalCount FROM CountDate
UNION ALL
SELECT TableName, TotalAvg FROM CountCustomer;
See also
• CREATE VIEW (Transact-SQL)
• DELETE (Transact-SQL)
• EXCEPT and INTERSECT (Transact-SQL)
• INSERT (Transact-SQL)
• SELECT (Transact-SQL)
• UPDATE (Transact-SQL)
Feedback
Was this page helpful? Yes No