Pipe Excel Online Data to CSV in PowerShell

The CData Cmdlets Module for Excel Online is a standard PowerShell module offering straightforward integration with Excel Online. Below, you will find examples of using our ExcelOnline Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Excel Online Data

You can connect to a workbook by providing authentication to Excel Online and then setting the following properties:

• Workbook: Set this to the name or Id of the workbook.

  If you want to view a list of information about the available workbooks, execute a query to the Workbooks view after you authenticate.

• UseSandbox: Set this to true if you are connecting to a workbook in a sandbox account. Otherwise, leave this blank to connect to a production account.

You use the OAuth authentication standard to authenticate to Excel Online. See the Getting Started section in the help documentation for a guide. Getting Started also guides you through executing SQL to worksheets and ranges.

$conn = Connect-ExcelOnline 

Selecting Data

Follow the steps below to retrieve data from the Test_xlsx_Sheet1 table and pipe the result into to a CSV file:

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTest_xlsx_Sheet1Data.csv -NoTypeInformation

You will notice that we piped the results from Select-ExcelOnline 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.

Deleting Data

The following line deletes any records that match the criteria:

Select-ExcelOnline -Connection $conn -Table Test_xlsx_Sheet1 -Where "Column2 = Bob" | Remove-ExcelOnline

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 Excel Online, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyTest_xlsx_Sheet1Updates.csv | %{
  $record = Select-ExcelOnline -Connection $ExcelOnline -Table Test_xlsx_Sheet1 -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ExcelOnline -Connection $excelonline -Table Test_xlsx_Sheet1 -Columns ("Id","Column1") -Values ($_.Id, $_.Column1) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ExcelOnline -Connection $excelonline -Table Test_xlsx_Sheet1 -Columns ("Id","Column1") -Values ($_.Id, $_.Column1)
  }
}

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!