Export report

Exports a report to a file (PDF, Excel, or CSV). You must specify the ReportId, TargetFilePath, and Format.

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 export_report WITH(
  ReportId=2972339541069700, 
 ,TargetFilePath='c:\temp\exported_report_as_excel_file.xlsx' --or .pdf, .csv   
 ,Format='application/vnd.ms-excel'  --or-- application/pdf  --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize='LETTER' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_SMARTSHEET_IN_GATEWAY], 'SELECT * FROM export_report WITH(
  ReportId=2972339541069700, 
 ,TargetFilePath=''c:\temp\exported_report_as_excel_file.xlsx'' --or .pdf, .csv   
 ,Format=''application/vnd.ms-excel''  --or-- application/pdf  --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize=''LETTER'' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)')

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

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM export_report WITH(
  ReportId=2972339541069700, 
 ,TargetFilePath=''c:\temp\exported_report_as_excel_file.xlsx'' --or .pdf, .csv   
 ,Format=''application/vnd.ms-excel''  --or-- application/pdf  --or-- text/csv
--below Paper Size only valid for PDF
--,PaperSize=''LETTER'' --or LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
)'
EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY]