Cmdlets for Apache CouchDB

Build 24.0.9060

Getting Started

Connecting to Apache CouchDB

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

  • Select-ApacheCouchDB
  • Add-ApacheCouchDB
  • Update-ApacheCouchDB
  • Remove-ApacheCouchDB

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-ApacheCouchDB 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 CouchDB Version Support

The cmdlet supports CouchDB version 1.6 and above. See Query Mapping for SQL-to-ApacheCouchDB-query mappings and more information about accessing unstructured data in Apache CouchDB through SQL.

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