Pipe Box Data to CSV in PowerShell

Ready to get started?

Download a free trial of the Box Cmdlets to get started:

 Download Now

Learn more:

Box Icon Box Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Box data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

Use standard PowerShell cmdlets to access Box tables.

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

Creating a Connection to Your Box Data

Box uses the OAuth standard to authenticate. To authenticate to Box, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

$conn = Connect-Box  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Selecting Data

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

Select-Box -Connection $conn -Table Files | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myFilesData.csv -NoTypeInformation

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

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

Import-Csv -Path C:\MyFilesUpdates.csv | %{
  $record = Select-Box -Connection $Box -Table Files -Where ("Id = `'"+$_.Id+"`'")
    Update-Box -Connection $box -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size) -Where ("Id = `'"+$_.Id+"`'")
    Add-Box -Connection $box -Table Files -Columns ("Name","Size") -Values ($_.Name, $_.Size)

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!