Download a file

Downloads a file from a SharePoint document library to a local disk.

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 download_file_to_disk
    WITH(
   -- Drive (SharePoint Document Library)	
      DriveId='b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx'
   --Enter file path (on root or under subfolder)
   --,FileId='root:/dump.pdf:' --Path must end with colon
   --,FileId='root:/myfolder/dump.pdf:'
   --OR-- 
   --,FileId='01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX'
   
     , TargetFilePath='C:\temp\List.xlsx'
   --, FileOverwriteMode='FailIfExists' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--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 download_file_to_disk
    WITH(
   -- Drive (SharePoint Document Library)	
      DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx''
   --Enter file path (on root or under subfolder)
   --,FileId=''root:/dump.pdf:'' --Path must end with colon
   --,FileId=''root:/myfolder/dump.pdf:''
   --OR-- 
   --,FileId=''01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX''
   
     , TargetFilePath=''C:\temp\List.xlsx''
   --, FileOverwriteMode=''FailIfExists'' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--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 download_file_to_disk
    WITH(
   -- Drive (SharePoint Document Library)	
      DriveId=''b!GtLN726LE0eY5F2BBNi14wMKmwdpCDFMxxxxxxxxxxxxx''
   --Enter file path (on root or under subfolder)
   --,FileId=''root:/dump.pdf:'' --Path must end with colon
   --,FileId=''root:/myfolder/dump.pdf:''
   --OR-- 
   --,FileId=''01SUOJPKHXMPKD2UXXXXXXXXXXXXXXXXXX''
   
     , TargetFilePath=''C:\temp\List.xlsx''
   --, FileOverwriteMode=''FailIfExists'' //change default overwrite mode from AlwaysOverwrite to FailIfExists
    )
--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]