List Excel worksheets

Gets a list of worksheets in an Excel file.

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 list_excel_worksheets
WITH (
	-- Drive (SharePoint Document Library)
	DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXXX'
	
	,FileId='root:/myfolder/dump.xlsx:' --Path must end with colon
    --,FileId='01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX'  --By Id (preferred)
		
	)
--DriveId can be retrieved by selecting from 'Drives' table.
--FileId can be retrieved by selecting from 'list_files' endpoint.

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY], 'SELECT * FROM list_excel_worksheets
WITH (
	-- Drive (SharePoint Document Library)
	DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXXX''
	
	,FileId=''root:/myfolder/dump.xlsx:'' --Path must end with colon
    --,FileId=''01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX''  --By Id (preferred)
		
	)
--DriveId can be retrieved by selecting from ''Drives'' table.
--FileId can be retrieved by selecting from ''list_files'' 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 list_excel_worksheets
WITH (
	-- Drive (SharePoint Document Library)
	DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-XXXXXXXXXXXXXX''
	
	,FileId=''root:/myfolder/dump.xlsx:'' --Path must end with colon
    --,FileId=''01SUOJPKECYDDVFXXXXXXXXXXXXXXXXXX''  --By Id (preferred)
		
	)
--DriveId can be retrieved by selecting from ''Drives'' table.
--FileId can be retrieved by selecting from ''list_files'' endpoint.'
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY]