Read Excel worksheet data for a cell range

Gets data from an Excel worksheet for a specified cell range. Supply the range (e.g. A1:D10). For auto-detect range use the get_excel_worksheet_autodetect endpoint.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT * FROM get_excel_worksheet
WITH (
         DriveId='me'
      --OR-- Use Shared Drive Id or other User's Drive Id
      --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'
	  
	    ,FileId='root:/MyFolder/Book1.xlsx:' --Path must end with colon
		
		--OR Use File Id
  	    --,FileId='01SUOJPFXXXXXXXXXXXXXXXXXX'
	   
	    ,SheetId='Sheet1'
	  --OR-- Use Sheet ID - Using ID is good idea if Sheet ever renamed (Id doesnt change)
	  --,SheetId='{00000000-0001-0000-0000-000000000000}'
	  
	   ,Range='A1:K10000'
	   ,ArrayTransEnableCustomColumns='True' --set this to False if No header in first row
	   )
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.
--SheetId can be retrieved by downloading Excel file and discovering what sheets exist or by selecting from 'list_excel_worksheets' endpoint.
--Range should be set to Excel-type of range where data is located.

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_ONEDRIVE_IN_GATEWAY], 'SELECT * FROM get_excel_worksheet
WITH (
         DriveId=''me''
      --OR-- Use Shared Drive Id or other User''s Drive Id
      --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
	  
	    ,FileId=''root:/MyFolder/Book1.xlsx:'' --Path must end with colon
		
		--OR Use File Id
  	    --,FileId=''01SUOJPFXXXXXXXXXXXXXXXXXX''
	   
	    ,SheetId=''Sheet1''
	  --OR-- Use Sheet ID - Using ID is good idea if Sheet ever renamed (Id doesnt change)
	  --,SheetId=''{00000000-0001-0000-0000-000000000000}''
	  
	   ,Range=''A1:K10000''
	   ,ArrayTransEnableCustomColumns=''True'' --set this to False if No header in first row
	   )
--DriveId can be retrieved by selecting from ''Drives'' table.
--FileId can be retrieved by selecting from ''list_files'' endpoint.
--SheetId can be retrieved by downloading Excel file and discovering what sheets exist or by selecting from ''list_excel_worksheets'' endpoint.
--Range should be set to Excel-type of range where data is located.')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_ONEDRIVE_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_excel_worksheet
WITH (
         DriveId=''me''
      --OR-- Use Shared Drive Id or other User''s Drive Id
      --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''
	  
	    ,FileId=''root:/MyFolder/Book1.xlsx:'' --Path must end with colon
		
		--OR Use File Id
  	    --,FileId=''01SUOJPFXXXXXXXXXXXXXXXXXX''
	   
	    ,SheetId=''Sheet1''
	  --OR-- Use Sheet ID - Using ID is good idea if Sheet ever renamed (Id doesnt change)
	  --,SheetId=''{00000000-0001-0000-0000-000000000000}''
	  
	   ,Range=''A1:K10000''
	   ,ArrayTransEnableCustomColumns=''True'' --set this to False if No header in first row
	   )
--DriveId can be retrieved by selecting from ''Drives'' table.
--FileId can be retrieved by selecting from ''list_files'' endpoint.
--SheetId can be retrieved by downloading Excel file and discovering what sheets exist or by selecting from ''list_excel_worksheets'' endpoint.
--Range should be set to Excel-type of range where data is located.'
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY]