Cmdlets for CockroachDB

Build 24.0.9060

Getting Started

Connecting to CockroachDB

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

  • Select-CockroachDB
  • Add-CockroachDB
  • Update-CockroachDB
  • Remove-CockroachDB

Executing SQL from PowerShell

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

CockroachDB Version Support

The cmdlet enables standards-based access to Cockroach DB version 2.0 and later.

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