Cmdlets for Couchbase

Build 24.0.9060

ConnectionMode Parameter (Connect-Couchbase Cmdlet)

Determines how to connect to the Couchbase server. Must be either Direct or Cloud.

Syntax

Connect-Couchbase -ConnectionMode string

Possible Values

Direct, Cloud

Data Type

cstr

Default Value

"Direct"

Remarks

By default the cmdlet connects to Couchbase directly using the address given in the Server option. The Server must be running the appropriate CouchbaseService to accept the connection. This will work in most on-premise or basic cloud deployments.

This should be set to Cloud when connecting to Couchbase Capella or a custom deployment that uses service records. These records will allow the cmdlet to determine the exact Couchbase servers that provide the appropriate CouchbaseService. You must also set the DNSServer property so that the cmdlet is able to fetch these service records.

Note that enabling Cloud mode will override these connection properties with the values discovered by contacting the cluster:

  • Server
  • N1QLPort
  • AnalyticsPort

This is a required parameter.

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