ADO.NET Provider for Excel

Build 20.0.7655

Calling Stored Procedures

You can invoke a stored procedure using ExcelCommand in the same way as any other SQL stored procedure. To instantiate a ExcelCommand object, provide the name of the stored procedure and a ExcelConnection instance as arguments to the constructor. Set the value of the CommandType property to "StoredProcedure" and add the parameters as key-value pairs to the Parameters collection of the ExcelCommand instance.

C#

string connectionString = "Excel File=C:\MyExcelWorkbooks\SampleWorkbook.xlsx;";

using (ExcelConnection connection = new ExcelConnection(connectionString)) {
  ExcelCommand cmd = new ExcelCommand("CreateWorksheet", connection);
  cmd.CommandType = CommandType.StoredProcedure; 
  cmd.Parameters.Add(new ExcelParameter("@sheet", "MyNewWorksheet"));
  // Add other parameters as needed ...

  ExcelDataReader rdr = cmd.ExecuteReader();
  while (rdr.Read()) {
    for (int i = 0; i < rdr.FieldCount; i++) {
      Console.WriteLine(rdr.GetName(i) + " --> " + rdr[i]);
    }
    Console.WriteLine();
  }
}

VB.NET

Dim connectionString As String = "Excel File=C:\MyExcelWorkbooks\SampleWorkbook.xlsx;"

Using connection As New ExcelConnection(connectionString)
  Dim cmd As New ExcelCommand("CreateWorksheet", connection)
  cmd.CommandType = CommandType.StoredProcedure
  cmd.Parameters.Add(New ExcelParameter("@sheet", "MyNewWorksheet"))
  ' Add other parameters as needed ...

  Dim rdr As ExcelDataReader = cmd.ExecuteReader()
  While rdr.Read()
	  For i As Integer = 0 To rdr.FieldCount - 1
		  Console.WriteLine(rdr.GetName(i) + " --> " + rdr(i))
	  Next
	  Console.WriteLine()
  End While
End Using

Alternatively, you can set the parameters of a stored procedure in the text of the command. The support for stored procedure statements follows the standard form shown below:

"EXECUTE my_proc @first = 1, @second = 2, @third = 3;"

"EXEC my_proc @first = 1, @second = 2, @third = 3;"

To execute a parameterized query, add parameters as key-value pairs to the Parameters collection of the ExcelCommand instance.

C#

string connectionString = "Excel File=C:\MyExcelWorkbooks\SampleWorkbook.xlsx;";

using (ExcelConnection connection = new ExcelConnection(connectionString)) {
  ExcelCommand cmd = new ExcelCommand("EXECUTE CreateWorksheet sheet = @sheet;", connection); 
  cmd.Parameters.Add(new ExcelParameter("@sheet", "MyNewWorksheet"));
  // Add other parameters as needed ...

  ExcelDataReader rdr = cmd.ExecuteReader();
  while (rdr.Read()) {
    for (int i = 0; i < rdr.FieldCount; i++) {
      Console.WriteLine(rdr.GetName(i) + " --> " + rdr[i]);
    }
    Console.WriteLine();
  }
}

VB.NET

Dim connectionString As String = "Excel File=C:\MyExcelWorkbooks\SampleWorkbook.xlsx;"

Using connection As New ExcelConnection(connectionString)
  Dim cmd As New ExcelCommand("EXECUTE CreateWorksheet sheet = @sheet;", connection)
  cmd.Parameters.Add(New ExcelParameter("@sheet", "MyNewWorksheet"))
  ' Add other parameters as needed ...

  Dim rdr As ExcelDataReader = cmd.ExecuteReader()
  While rdr.Read()
	  For i As Integer = 0 To rdr.FieldCount - 1
		  Console.WriteLine(rdr.GetName(i) + " --> " + rdr(i))
	  Next
	  Console.WriteLine()
  End While
End Using

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7655