How to pipe OneNote Data to CSV in PowerShell

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

Creating a Connection to Your OneNote Data

OneNote uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation for more information.

$conn = Connect-OneNote -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL" -InitiateOAuth "$InitiateOAuth"

Selecting Data

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

Select-OneNote -Connection $conn -Table Notebooks | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myNotebooksData.csv -NoTypeInformation

You will notice that we piped the results from Select-OneNote 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-OneNote -Connection $conn -Table Notebooks -Where "Id = Jq74mCczmFXk1tC10GB" | Remove-OneNote

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

Import-Csv -Path C:\MyNotebooksUpdates.csv | %{
 $record = Select-OneNote -Connection $OneNote -Table Notebooks -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-OneNote -Connection $onenote -Table Notebooks -Columns ("Id","notebook_displayName") -Values ($_.Id, $_.notebook_displayName) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-OneNote -Connection $onenote -Table Notebooks -Columns ("Id","notebook_displayName") -Values ($_.Id, $_.notebook_displayName)
 }
}

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!