Cmdlets for AlloyDB

Build 24.0.9060

Getting Started

Connecting to AlloyDB

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

  • Select-AlloyDB
  • Add-AlloyDB
  • Update-AlloyDB
  • Remove-AlloyDB

Executing SQL from PowerShell

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

AlloyDB Version Support

AlloyDB is built from PostgreSQL, starting from PostgreSQL version 14 compatibility (Google will maintain AlloyDB parallel to new versions of PostgreSQL). The cmdlet enables access to AlloyDB via PostgreSQL connectivity standards.

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