How to pass an array into a SQL Server stored procedure

Question

How to pass an array into a SQL Server stored procedure?

For example, I have a list of employees. I want to use this list as a table and join it with another table. But the list of employees should be passed as parameter from C#.

Answer 1

SQL Server 2008 (or newer)

First, in your database, create the following two objects:

CREATE TYPE dbo.IDList AS TABLE (   ID INT ); GO  CREATE PROCEDURE dbo.DoSomethingWithEmployees   @List AS dbo.IDList READONLY AS BEGIN   SET NOCOUNT ON;    SELECT ID FROM @List;  END GO 

Now in your C# code:

// Obtain your list of ids to send, this is just an example call to a helper utility function int[] employeeIds = GetEmployeeIds();  DataTable tvp = new DataTable(); tvp.Columns.Add(new DataColumn("ID", typeof(int)));  // populate DataTable from your List here foreach(var id in employeeIds)     tvp.Rows.Add(id);  using (conn) {     SqlCommand cmd = new SqlCommand("dbo.DoSomethingWithEmployees", conn);     cmd.CommandType = CommandType.StoredProcedure;     SqlParameter tvparam = cmd.Parameters.AddWithValue("@List", tvp);     // these next lines are important to map the C# DataTable object to the correct SQL User Defined Type     tvparam.SqlDbType = SqlDbType.Structured;     tvparam.TypeName = "dbo.IDList";     // execute query, consume results, etc. here } 

SQL Server 2005

If you are using SQL Server 2005, I would still recommend a split function over XML. First, create a function:

CREATE FUNCTION dbo.SplitInts (    @List      VARCHAR(MAX),    @Delimiter VARCHAR(255) ) RETURNS TABLE AS   RETURN ( SELECT Item = CONVERT(INT, Item) FROM       ( SELECT Item = x.i.value('(./text())[1]', 'varchar(max)')         FROM ( SELECT [XML] = CONVERT(XML, '<i>'         + REPLACE(@List, @Delimiter, '</i><i>') + '</i>').query('.')           ) AS a CROSS APPLY [XML].nodes('i') AS x(i) ) AS y       WHERE Item IS NOT NULL   ); GO 

Now your stored procedure can just be:

CREATE PROCEDURE dbo.DoSomethingWithEmployees   @List VARCHAR(MAX) AS BEGIN   SET NOCOUNT ON;    SELECT EmployeeID = Item FROM dbo.SplitInts(@List, ',');  END GO 

And in your C# code you just have to pass the list as '1,2,3,12'...

---

I find the method of passing through table valued parameters simplifies the maintainability of a solution that uses it and often has increased performance compared to other implementations including XML and string splitting.

The inputs are clearly defined (no one has to guess if the delimiter is a comma or a semi-colon) and we do not have dependencies on other processing functions that are not obvious without inspecting the code for the stored procedure.

Compared to solutions involving user defined XML schema instead of UDTs, this involves a similar number of steps but in my experience is far simpler code to manage, maintain and read.

In many solutions you may only need one or a few of these UDTs (User defined Types) that you re-use for many stored procedures. As with this example, the common requirement is to pass through a list of ID pointers, the function name describes what context those Ids should represent, the type name should be generic.