List files in a folder path (recursive)

Lists files recursively (including child folders) using the list_files endpoint. Note that some new or non-indexed files may not appear immediately.

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_files
WITH(
     Filter='$.value[*]' --list both files and folders
   --Filter='$.value[?(@.file.mimeType != null)]' --list only files
   --Filter='$.value[?(@.folder.childCount != null)]' --list only folders
   
   -- Drive (SharePoint Document Library)   
	  ,DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E'
	  
    --Folder which you like to list (If not supplied then Default=root)
  --,SearchPath='/root'	--default
  --,SearchPath='/root:/myfolder:'	--folder path
	,SearchPath='/root:/myfolder/subfolder:' --folder path nested
    ,OrderBy='lastModifiedDateTime desc'
)		
--You can get DriveId by selecting from 'Drives' table.

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY], 'SELECT * FROM list_files
WITH(
     Filter=''$.value[*]'' --list both files and folders
   --Filter=''$.value[?(@.file.mimeType != null)]'' --list only files
   --Filter=''$.value[?(@.folder.childCount != null)]'' --list only folders
   
   -- Drive (SharePoint Document Library)   
	  ,DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E''
	  
    --Folder which you like to list (If not supplied then Default=root)
  --,SearchPath=''/root''	--default
  --,SearchPath=''/root:/myfolder:''	--folder path
	,SearchPath=''/root:/myfolder/subfolder:'' --folder path nested
    ,OrderBy=''lastModifiedDateTime desc''
)		
--You can get DriveId by selecting from ''Drives'' table.')

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_files
WITH(
     Filter=''$.value[*]'' --list both files and folders
   --Filter=''$.value[?(@.file.mimeType != null)]'' --list only files
   --Filter=''$.value[?(@.folder.childCount != null)]'' --list only folders
   
   -- Drive (SharePoint Document Library)   
	  ,DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMn1d71ra11GuQ4DORpHy-Sa5UzSpkaY9E''
	  
    --Folder which you like to list (If not supplied then Default=root)
  --,SearchPath=''/root''	--default
  --,SearchPath=''/root:/myfolder:''	--folder path
	,SearchPath=''/root:/myfolder/subfolder:'' --folder path nested
    ,OrderBy=''lastModifiedDateTime desc''
)		
--You can get DriveId by selecting from ''Drives'' table.'
EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY]