SQL Server guide

Read Excel worksheet (auto-detect range)


Reads an Excel file without supplying a cell address range. It auto-detects the range based on the first and last cell.

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_autodetect
WITH (
		 -- Drive (SharePoint Document Library)
		 DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX'

	    ,FileId='root:/myfolder/dump.xlsx:' --Path must end with colon
  	    --,FileId='01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX'  --By Id (preferred)

	    ,SheetId='Sheet1' --Id or Name
      --,SheetId='{00000000-0001-0000-0000-000000000000}' --Using ID is good idea if Sheet ever renamed (Id doesnt change)	   		
	    ,AutoDetectByValue='true'
		,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.

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY], 'SELECT * FROM get_excel_worksheet_autodetect
WITH (
		 -- Drive (SharePoint Document Library)
		 DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX''

	    ,FileId=''root:/myfolder/dump.xlsx:'' --Path must end with colon
  	    --,FileId=''01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX''  --By Id (preferred)

	    ,SheetId=''Sheet1'' --Id or Name
      --,SheetId=''{00000000-0001-0000-0000-000000000000}'' --Using ID is good idea if Sheet ever renamed (Id doesnt change)	   		
	    ,AutoDetectByValue=''true''
		,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.')

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_SHAREPOINT_ONLINE_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_excel_worksheet_autodetect
WITH (
		 -- Drive (SharePoint Document Library)
		 DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXX''

	    ,FileId=''root:/myfolder/dump.xlsx:'' --Path must end with colon
  	    --,FileId=''01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX''  --By Id (preferred)

	    ,SheetId=''Sheet1'' --Id or Name
      --,SheetId=''{00000000-0001-0000-0000-000000000000}'' --Using ID is good idea if Sheet ever renamed (Id doesnt change)	   		
	    ,AutoDetectByValue=''true''
		,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.'
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY]