Cmdlets for Microsoft Excel

Build 24.0.9060

Getting Started

Connecting to Microsoft Excel

Establishing a Connection shows how to authenticate to Microsoft Excel and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for Microsoft Excel provides a familiar way to interact with Microsoft Excel from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Microsoft Excel using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-Excel cmdlet. You can then pass the ExcelConnection object returned to other cmdlets for accessing data:

  • Select-Excel
  • Add-Excel
  • Update-Excel
  • Remove-Excel

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-Excel cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

Microsoft Excel Version Support

The CData Cmdlets PowerShell Module for Microsoft Excel supports the Office Open XML spreadsheets used by Microsoft Excel 2007 and later.

Microsoft Excel File Extension Support

The CData Cmdlets PowerShell Module for Microsoft Excel currently supports .xlsx and .xlsm files. However, only read operations are supported for .xlsm files. Modifying data operations may cause loss of or damage to macros.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060