Endpoint

Create / Update CSV File (Generic)

Name

create_csv_file

Description

No description available

Related Tables

CSV File Read/Write

Parameters

Parameter

Label

Required

Options

Description

DriveId

Drive Id

YES

Specify a drive

FileId

File Id or Path (e.g. root:/somefolder/myfile.xyz: ) - Max 1000 Listed

YES

Specify a File Id or Path. Syntax: [{file-id}] -OR- [root:/{file-path}:] (Example: root:/folder/subfolder/myfile.xyz: )

SiteId

Site Id (Re-Select Drive Id after you change this)

Specify a site

SearchType

Search Type - For UI Only (i.e. Recursive -OR- Non-Recursive) - Default=Recursive)

Option	Value
Recursive All Files (Keep Blank) - not supported for Application Credentials with Sites.Selected Scope
Non-Recursive / Children All Files (Only for Non-Shared Items)	children
Recursive All - For User Creds Only	search(q='')
Recursive *.xlsx Files - For User Creds Only	search(q='.xls')
Recursive *.csv Files - For User Creds Only	search(q='.csv')
Recursive *.json Files - For User Creds Only	search(q='.json')
Recursive Custom Extension Files - For User Creds Only	search(q='.myext')

NOTE: Not Supported with Application Credentials which uses Sites.Selected Scope. If you do not wish to see files from child folders then use Non-Recursive option. Recursive option has certain limitations (e.g. Only indexed files will appear so it takes time to show up in the list). If you do not see some files listed in the output then use Non-Recursive option (must specify Parent Folder Path in SearchPath property).

SearchPath

Search Folder (For UI Only - Helps to narrow down File Selection DropDown) - Max 200 Listed

This parameter is only for UI. Select this to narrow down File List Dropdown. Select Search Folder first and then select File List dropdown to see new File list (found under this selected folder).

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
id	`DT_WSTR`	`nvarchar(500)`	500	`False`
name	`DT_WSTR`	`nvarchar(150)`	150	`False`
size	`DT_I8`	`bigint`		`False`
createdDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
webUrl	`DT_WSTR`	`nvarchar(1500)`	1500	`False`
webUrlPath	`DT_WSTR`	`nvarchar(1500)`	1500	`False`
createdBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
createdBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
createdBy_user_displayName	`DT_WSTR`	`nvarchar(100)`	100	`False`
createdBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
createdBy_application_displayName	`DT_WSTR`	`nvarchar(100)`	100	`False`
lastModifiedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
lastModifiedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
lastModifiedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
lastModifiedBy_application_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
lastModifiedBy_application_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	`False`
parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	`False`
parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	`False`	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	`False`	This is only returned when calling lookup or /children call (e.g. /items/root:/[folder-name] OR /items/[item-id] )
fileSystemInfo_createdDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
fileSystemInfo_lastModifiedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
folder_childCount	`DT_I8`	`bigint`		`False`
file_mimeType	`DT_WSTR`	`nvarchar(300)`	300	`False`
file_quickXorHash	`DT_WSTR`	`nvarchar(200)`	200	`False`
file_sha1Hash	`DT_WSTR`	`nvarchar(200)`	200	`False`
file_sha256Hash	`DT_WSTR`	`nvarchar(200)`	200	`False`
shared_scope	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_parentReference_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_driveId	`DT_WSTR`	`nvarchar(400)`	400	`False`
remoteItem_parentReference_driveType	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_parentReference_name	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_parentReference_path	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
remoteItem_shared_scope	`DT_WSTR`	`nvarchar(100)`	100	`False`
remoteItem_shared_sharedDateTime	`DT_DBTIMESTAMP`	`datetime`		`False`
remoteItem_sharedBy_user_id	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharedBy_user_email	`DT_WSTR`	`nvarchar(150)`	150	`False`
remoteItem_sharedBy_user_displayName	`DT_WSTR`	`nvarchar(150)`	150	`False`
remoteItem_sharepointIds_listId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_listItemId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_listItemUniqueId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_siteId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_siteUrl	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_tenantId	`DT_WSTR`	`nvarchar(200)`	200	`False`
remoteItem_sharepointIds_webId	`DT_WSTR`	`nvarchar(200)`	200	`False`
id_path	`DT_WSTR`	`nvarchar(200)`	200	`False`

If the column you are looking for is missing, consider customizing SharePoint Online Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use SharePoint Online Connector in API Source component to read data or in API Destination component to read/write data:

Read from CSV File Read/Write table using API Destination

This Endpoint belongs to CSV File Read/Write table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

SharePoint Online

CSV File Read/Write

Insert, Update

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Create / Update a CSV File from External Data Source (e.g. MSSQL / ODBC)

This example shows how to create / update a CSV file directly inside SharePoint Document Library using streaming approach. This example reads records from Microsoft SQL Server database and writes data to CSV file on SharePoint Document Library. If file does not exists then it creates a new one.

INSERT INTO FileReaderWriterCsv
SOURCE( 'MSSQL'--OR 'ODBC'
, 'Data Source=localhost;Initial Catalog=Northwind;Integrated Security=true'
, 'select OrderId,CustomerId,OrderDate FROM Northwind.dbo.Orders'
)
WITH(
	    DriveId='b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0'
	  , FileId='root:/test_out.csv:'
	--, FileId='root:/subfolder/test_out.csv:'
	--, FileId='01N3NxxxxxxxWZYSDJ'  --exising File ID
	--, ColumnDelimiter=',' --{LF}, {TAB}, | , \x0009 ...
	--, RowDelimiter='{NEWLINE}' --{LF}, {TAB}, | , \x0009 ...
	--, HasColumnHeaderRow=0 --set for header less file
  --, WriterDateTimeFormat='yyyy-MM-ddTHH:mm:ss.fff'  
  --See Query Builder for more options
)

create_csv_file endpoint belongs to FileReaderWriterCsv table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Create / Update a CSV File from External Data Source (e.g. MSSQL / ODBC)

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO FileReaderWriterCsv
SOURCE( ''MSSQL''--OR ''ODBC''
, ''Data Source=localhost;Initial Catalog=Northwind;Integrated Security=true''
, ''select OrderId,CustomerId,OrderDate FROM Northwind.dbo.Orders''
)
WITH(
	    DriveId=''b!0zqXLXXJh0uUMzl-JXAd9Ztngc-5utVDqRyD2lKpD2535-11HLQTR5z4hOzmA7Q0''
	  , FileId=''root:/test_out.csv:''
	--, FileId=''root:/subfolder/test_out.csv:''
	--, FileId=''01N3NxxxxxxxWZYSDJ''  --exising File ID
	--, ColumnDelimiter='','' --{LF}, {TAB}, | , \x0009 ...
	--, RowDelimiter=''{NEWLINE}'' --{LF}, {TAB}, | , \x0009 ...
	--, HasColumnHeaderRow=0 --set for header less file
  --, WriterDateTimeFormat=''yyyy-MM-ddTHH:mm:ss.fff''  
  --See Query Builder for more options
)';

EXEC (@MyQuery) AT [LS_TO_SHAREPOINT_ONLINE_IN_GATEWAY];

create_csv_file endpoint belongs to FileReaderWriterCsv table(s), and can therefore be used via those table(s).