Download a file

Downloads a file. Identify the file by ID or path and specify the local target path in the WITH clause. To convert to PDF or HTML, use the download_file endpoint with ConvertTo and TargetFilePath.

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
WITH (
      DriveId='me'
   --OR-- Use Shared Drive Id or other User's Drive Id
   --,DriveId='b!GtLN726LE0eXXXXXXXXXXXX'

   --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:\My files\Employees\List.xlsx'
   )
   --DriveId can be retrieved by selecting from 'list_drives' endpoint.
   --FileId can be retrieved by selecting from 'list_files' endpoint.

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_ONEDRIVE_IN_GATEWAY], 'SELECT * FROM download_file
WITH (
      DriveId=''me''
   --OR-- Use Shared Drive Id or other User''s Drive Id
   --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''

   --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:\My files\Employees\List.xlsx''
   )
   --DriveId can be retrieved by selecting from ''list_drives'' endpoint.
   --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_ONEDRIVE_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM download_file
WITH (
      DriveId=''me''
   --OR-- Use Shared Drive Id or other User''s Drive Id
   --,DriveId=''b!GtLN726LE0eXXXXXXXXXXXX''

   --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:\My files\Employees\List.xlsx''
   )
   --DriveId can be retrieved by selecting from ''list_drives'' endpoint.
   --FileId can be retrieved by selecting from ''list_files'' endpoint.'
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY]