Cmdlets for Highrise

Build 24.0.9060

Getting Started

Connecting to Highrise

Establishing a Connection shows how to authenticate to Highrise 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 Highrise provides a familiar way to interact with Highrise from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Highrise 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-Highrise cmdlet. You can then pass the HighriseConnection object returned to other cmdlets for accessing data:

  • Select-Highrise
  • Add-Highrise
  • Update-Highrise
  • Remove-Highrise

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-Highrise 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.

Highrise Version Support

The cmdlet uses the Highrise REST API.

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