Finding Composite Primary Key Columns

You never know when the idea for a script will make an appearance.

I had to work with composite primary keys recently while working on a project for a client.  More specifically, I had to create a process that would dynamically (dynamic SQL?! Say it isn’t so?!) handle composite keys in an efficient manner.

Usually, a primary key is just a single column that uniquely identifies a row within a table.  However, a composite primary key consisting of 2 or more columns can be created.  Regardless if the primary key is singular or composite, it provides identical functionality.  In this particular instance, this process would perform data modifications based on the columns that composed the primary key.  Thus I needed to be able to determine what columns are in the key.

There is a limit to the number of columns you can have in a composite key.  In SQL Server 2016 and newer, the limit is 32 columns and prior to that a primary key could have up to 16 columns.   Keep in mind, neither limit is a goal but it’s there if you need it.

The Parts & Pieces

As I started to work on this, my first thought was that it would be helpful to know how many tables had a composite primary key.  This would give me an idea on how many tables I was dealing with.  Thankfully, SQL Server has this information by using system DMVs (dynamic management views) along with the COL_NAME function.

Note: the COL_NAME function will only work with SQL Server 2008 and newer.  

Below is my attempt to get a result of how many columns compose the primary key:

-- how many columns make up the primary key
SELECT SCHEMA_NAME(o.schema_id) AS 'Schema'
 , OBJECT_NAME(i.object_id) AS 'TableName'
 , COUNT(COL_NAME(ic.object_id,ic.column_id)) AS 'Primary_Key_Column_Count'
FROM sys.indexes i 
    INNER JOIN sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id
    INNER JOIN sys.objects o ON i.object_id = o.object_ID
    INNER JOIN sys.schemas s ON o.schema_id = s.schema_id
WHERE i.is_primary_key = 1
    AND o.type_desc = 'USER_TABLE'
GROUP BY OBJECT_NAME(i.object_id), o.schema_id
HAVING COUNT(1) > 1
ORDER BY 1

In looking at the AdventureWorks2014 database, the above script will give you an output that looks like this:

Cool!  Now I knew which tables had a primary key comprised of multiple columns as well as how many columns were in the key definition.

Taking things a step further, I thought that it would be useful to see what columns the primary key is composed of in that same output.  This part becomes a little more complicated to gather as we need to get the list of columns, which could be 1 – 32 columns (or 1-16 columns depending on the version of SQL Server) into a comma delimited list.

Using the STUFF function along with XML PATH is a quick and efficient way to generate a comma delimited list of string values.

Thus this script was born:

SELECT SCHEMA_NAME(o.schema_id) AS 'Schema' 
 , OBJECT_NAME(i2.object_id) AS 'TableName'
 , STUFF(
 (SELECT ',' + COL_NAME(ic.object_id,ic.column_ID) 
 FROM sys.indexes i1
 INNER JOIN sys.index_columns ic ON i1.object_id = ic.object_id AND i1.index_id = ic.index_id
 WHERE i1.is_primary_key = 1
 AND i1.object_id = i2.object_id AND i1.index_id = i2.index_id
 FOR XML PATH('')),1,1,'') AS PK
FROM sys.indexes i2
 INNER JOIN sys.objects o ON i2.object_id = o.object_id
WHERE i2.is_primary_key = 1
 AND o.type_desc = 'USER_TABLE'

We can see the output of this query below:

Note that this output has the schema and table name just like the first result set.

Using a CTE, we can tie these two result sets together and get a clean unified look.

-- Let's get the columns of the Primary key into a CTE
;WITH mycte AS (SELECT SCHEMA_NAME(o.schema_id) AS 'Schema'
					, OBJECT_NAME(i2.object_id) AS 'TableName'
					, STUFF(
						(SELECT ',' + COL_NAME(ic.object_id,ic.column_id) 
						FROM sys.indexes i1
							INNER JOIN sys.index_columns ic ON i1.object_id = ic.object_id AND i1.index_id = ic.index_id
						WHERE i1.is_primary_key = 1
							AND i1.object_id = i2.object_id	AND i1.index_id = i2.index_id
						FOR XML PATH('')),1,1,'') AS PK
FROM sys.indexes i2
	INNER JOIN sys.objects o ON i2.object_id = o.object_id
WHERE i2.is_primary_key = 1
	AND o.type_desc = 'USER_TABLE'
)
-- Use this select to get the count, join to the CTE and get the column list
SELECT SCHEMA_NAME(o.schema_id) AS 'Schema'
	, OBJECT_NAME(i.object_id) AS 'TableName'
	, COUNT(COL_NAME(ic.object_id,ic.column_id)) AS 'Primary_Key_Column_Count'
	, mycte.PK AS 'Primary_Key_Columns'
FROM sys.indexes i 
	INNER JOIN sys.index_columns ic ON i.object_id = ic.object_id AND i.index_id = ic.index_id
	INNER JOIN sys.objects o ON i.object_id = o.object_id
	INNER JOIN mycte ON mycte.TableName = OBJECT_NAME(i.object_id)
WHERE i.is_primary_key = 1
		AND o.type_desc = 'USER_TABLE'
GROUP BY SCHEMA_NAME(o.schema_id)
		, OBJECT_NAME(i.object_id)
		, mycte.PK
HAVING COUNT('Primay_Key_Column_Count') > 1
ORDER BY 'TableName' ASC

We can see from below that now we have a nice result set that tells use not only how many columns are in the primary key but also what those keys are.

 

Summary

When working with composite primary keys, it’s a good idea to know how many columns as well as what columns are in the key.  This query helped me in creating the process my client needed. It just might help you to figure out some logic when writing dynamic SQL!

You can download the full script from here.

Enjoy!

 

© 2018, John Morehouse. All rights reserved.