Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to pipe SharePoint Data to CSV in PowerShell
Use standard PowerShell cmdlets to access SharePoint tables.
The CData Cmdlets Module for SharePoint is a standard PowerShell module offering straightforward integration with SharePoint. Below, you will find examples of using our SharePoint Cmdlets with native PowerShell cmdlets.
About SharePoint Data Integration
Accessing and integrating live data from SharePoint has never been easier with CData. Customers rely on CData connectivity to:
- Access data from a wide range of SharePoint versions, including Windows SharePoint Services 3.0, Microsoft Office SharePoint Server 2007 and above, and SharePoint Online.
- Access all of SharePoint thanks to support for Hidden and Lookup columns.
- Recursively scan folders to create a relational model of all SharePoint data.
- Use SQL stored procedures to upload and download documents and attachments.
Most customers rely on CData solutions to integrate SharePoint data into their database or data warehouse, while others integrate their SharePoint data with preferred data tools, like Power BI, Tableau, or Excel.
For more information on how customers are solving problems with CData's SharePoint solutions, refer to our blog: Drivers in Focus: Collaboration Tools.
Getting Started
Creating a Connection to Your SharePoint Data
Set the URL property to the base SharePoint site or to a sub-site. This allows you to query any lists and other SharePoint entities defined for the site or sub-site.
The User and Password properties, under the Authentication section, must be set to valid SharePoint user credentials when using SharePoint On-Premise.
If you are connecting to SharePoint Online, set the SharePointEdition to SHAREPOINTONLINE along with the User and Password connection string properties. For more details on connecting to SharePoint Online, see the "Getting Started" chapter of the help documentation
$conn = Connect-SharePoint -User "$User" -Password "$Password" -Auth Scheme "$Auth Scheme" -URL "$URL" -SharePointEdition "$SharePointEdition"
Selecting Data
Follow the steps below to retrieve data from the MyCustomList table and pipe the result into to a CSV file:
Select-SharePoint -Connection $conn -Table MyCustomList | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myMyCustomListData.csv -NoTypeInformation
You will notice that we piped the results from Select-SharePoint into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.
The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.Deleting Data
The following line deletes any records that match the criteria:
Select-SharePoint -Connection $conn -Table MyCustomList -Where "Location = Chapel Hill" | Remove-SharePoint
Inserting and Updating Data
The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into SharePoint, checking first whether a record already exists and needs to be updated instead of inserted.
Import-Csv -Path C:\MyMyCustomListUpdates.csv | %{ $record = Select-SharePoint -Connection $SharePoint -Table MyCustomList -Where ("Id = `'"+$_.Id+"`'") if($record){ Update-SharePoint -Connection $sharepoint -Table MyCustomList -Columns ("Name","Revenue") -Values ($_.Name, $_.Revenue) -Where ("Id = `'"+$_.Id+"`'") }else{ Add-SharePoint -Connection $sharepoint -Table MyCustomList -Columns ("Name","Revenue") -Values ($_.Name, $_.Revenue) } }
As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!