Cmdlets for Apache Phoenix

Build 24.0.9060

Getting Started

Connecting to Apache Phoenix

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

  • Select-ApachePhoenix
  • Add-ApachePhoenix
  • Update-ApachePhoenix
  • Remove-ApachePhoenix

Executing SQL from PowerShell

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

Apache Phoenix Version Support

The cmdlet leverages version 1.23.0 of the Apache Calcite Avatica protocol buffers to enable connectivity to Apache Phoenix via the Phoenix Query Server.

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